addPermissions(matterId, body=None, x__xgafv=None)

Adds an account as a matter collaborator.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
  "ccMe": True or False, # Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.
  "matterPermission": { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The account and its role to add.
    "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
    "role": "A String", # The user's role for the matter.
  },
  "sendEmails": True or False, # To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
  "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  "role": "A String", # The user's role for the matter.
}

close(matterId, body=None, x__xgafv=None)

Closes the specified matter. Returns the matter with updated state.

Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:

{ # Close a matter by ID.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to a CloseMatterRequest.
"matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state **CLOSED**.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
}

count(matterId, body=None, x__xgafv=None)

Counts the accounts processed by the specified query.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Count artifacts request.
  "query": { # The query definition used for search and export. # The search query.
    "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
      "emails": [ # A set of accounts to search.
        "A String",
      ],
    },
    "calendarOptions": { # Additional options for Calendar search # Set Calendar search-specific options.
      "locationQuery": [ # Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in "and". Word splitting example: ["New Zealand"] vs ["New","Zealand"] "New Zealand": matched by both "New and better Zealand": only matched by the later
        "A String",
      ],
      "minusWords": [ # Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in "or".
        "A String",
      ],
      "peopleQuery": [ # Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in "and".
        "A String",
      ],
      "responseStatuses": [ # Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.
        "A String",
      ],
      "versionDate": "A String", # Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
    },
    "corpus": "A String", # The Google Workspace service to search.
    "dataScope": "A String", # The data source to search.
    "driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
      "clientSideEncryptedOption": "A String", # Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.
      "includeSharedDrives": True or False, # Set to **true** to include shared drives.
      "includeTeamDrives": True or False, # Set to true to include Team Drive.
      "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
    },
    "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
      "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/chat). There is a limit of exporting from 500 Chat spaces per request.
        "A String",
      ],
    },
    "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
      "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
    },
    "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
      "clientSideEncryptedOption": "A String", # Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.
      "excludeDrafts": True or False, # Set to **true** to exclude drafts.
    },
    "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
    "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
      "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
    },
    "searchMethod": "A String", # The search method to use.
    "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
      "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
        "A String",
      ],
    },
    "sitesUrlInfo": { # The published site URLs of new Google Sites to search # Required when **SearchMethod** is **SITES_URL**.
      "urls": [ # A list of published site URLs.
        "A String",
      ],
    },
    "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
      "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
        "A String",
      ],
    },
    "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
    "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
    "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
      "coveredData": [ # Datatypes to search
        "A String",
      ],
    },
  },
  "view": "A String", # Sets the granularity of the count results.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

create(body=None, x__xgafv=None)

Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.

Args:
body: object, The request body.
The object takes the form of:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

delete(matterId, x__xgafv=None)

Deletes the specified matter. Returns the matter with updated state.

Args:
matterId: string, The matter ID (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

get(matterId, view=None, x__xgafv=None)

Gets the specified matter.

Args:
matterId: string, The matter ID. (required)
view: string, Specifies how much information about the matter to return in the response.
Allowed values
VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
BASIC - Returns the matter ID, name, description, and state. Default choice.
FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)

Lists matters the requestor has access to.

Args:
pageSize: integer, The number of matters to return in the response. Default and maximum are 100.
pageToken: string, The pagination token as returned in the response.
state: string, If set, lists only matters with the specified state. The default lists matters of all states.
Allowed values
STATE_UNSPECIFIED - The matter has no specified state.
OPEN - The matter is open.
CLOSED - The matter is closed.
DELETED - The matter is deleted.
view: string, Specifies how much information about the matter to return in response.
Allowed values
VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
BASIC - Returns the matter ID, name, description, and state. Default choice.
FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Provides the list of matters.
"matters": [ # List of matters.
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
],
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

removePermissions(matterId, body=None, x__xgafv=None)

Removes an account as a matter collaborator.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Remove an account as a matter collaborator.
  "accountId": "A String", # The account ID.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

reopen(matterId, body=None, x__xgafv=None)

Reopens the specified matter. Returns the matter with updated state.

Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:

{ # Reopen a matter by ID.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to a ReopenMatterRequest.
"matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state **OPEN**.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
},
}

undelete(matterId, body=None, x__xgafv=None)

Undeletes the specified matter. Returns the matter with updated state.

Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:

{ # Undelete a matter by ID.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

update(matterId, body=None, x__xgafv=None)

Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.

Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
"description": "A String", # An optional description for the matter.
"matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
"matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
{ # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
"accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
"role": "A String", # The user's role for the matter.
},
],
"matterRegion": "A String", # Optional. The requested data region for the matter.
"name": "A String", # The name of the matter.
"state": "A String", # The state of the matter.
}

Google Vault API . matters

Instance Methods

Method Details