Class: Google::Apis::VaultV1::VaultService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/vault_v1/service.rb

Overview

G Suite Vault API

Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the required Vault privileges 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. For example, to download an export, an account needs the Manage Exports privilege and the matter shared with them.

Examples:

require 'google/apis/vault_v1'

Vault = Google::Apis::VaultV1 # Alias the module
service = Vault::VaultService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ VaultService

Returns a new instance of VaultService.



51
52
53
54
55
56
 
# File 'lib/google/apis/vault_v1/service.rb', line 51

def initialize
  super('https://vault.googleapis.com/', '',
        client_name: 'google-apis-vault_v1',
        client_version: Google::Apis::VaultV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



44
45
46
 
# File 'lib/google/apis/vault_v1/service.rb', line 44

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



49
50
51
 
# File 'lib/google/apis/vault_v1/service.rb', line 49

def quota_user
  @quota_user
end

Instance Method Details

#add_hold_held_accounts(matter_id, hold_id, add_held_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::AddHeldAccountsResponse

Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • add_held_accounts_request_object (Google::Apis::VaultV1::AddHeldAccountsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/google/apis/vault_v1/service.rb', line 587

def add_hold_held_accounts(matter_id, hold_id, add_held_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/holds/{holdId}:addHeldAccounts', options)
  command.request_representation = Google::Apis::VaultV1::AddHeldAccountsRequest::Representation
  command.request_object = add_held_accounts_request_object
  command.response_representation = Google::Apis::VaultV1::AddHeldAccountsResponse::Representation
  command.response_class = Google::Apis::VaultV1::AddHeldAccountsResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_matter_permissions(matter_id, add_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::MatterPermission

Adds an account as a matter collaborator.

Parameters:

  • matter_id (String) —

    The matter ID.

  • add_matter_permissions_request_object (Google::Apis::VaultV1::AddMatterPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/apis/vault_v1/service.rb', line 79

def add_matter_permissions(matter_id, add_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:addPermissions', options)
  command.request_representation = Google::Apis::VaultV1::AddMatterPermissionsRequest::Representation
  command.request_object = add_matter_permissions_request_object
  command.response_representation = Google::Apis::VaultV1::MatterPermission::Representation
  command.response_class = Google::Apis::VaultV1::MatterPermission
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::VaultV1::CancelOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/google/apis/vault_v1/service.rb', line 1096

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::VaultV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#close_matter(matter_id, close_matter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::CloseMatterResponse

Closes the specified matter. Returns matter with updated state.

Parameters:

  • matter_id (String) —

    The matter ID.

  • close_matter_request_object (Google::Apis::VaultV1::CloseMatterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/google/apis/vault_v1/service.rb', line 112

def close_matter(matter_id, close_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:close', options)
  command.request_representation = Google::Apis::VaultV1::CloseMatterRequest::Representation
  command.request_object = close_matter_request_object
  command.response_representation = Google::Apis::VaultV1::CloseMatterResponse::Representation
  command.response_class = Google::Apis::VaultV1::CloseMatterResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#count_matter_artifacts(matter_id, count_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Operation

Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.

Parameters:

  • matter_id (String) —

    The matter ID.

  • count_artifacts_request_object (Google::Apis::VaultV1::CountArtifactsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/apis/vault_v1/service.rb', line 146

def count_matter_artifacts(matter_id, count_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:count', options)
  command.request_representation = Google::Apis::VaultV1::CountArtifactsRequest::Representation
  command.request_object = count_artifacts_request_object
  command.response_representation = Google::Apis::VaultV1::Operation::Representation
  command.response_class = Google::Apis::VaultV1::Operation
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_matter(matter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Matter

Creates a new 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.

Parameters:

  • matter_object (Google::Apis::VaultV1::Matter) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/google/apis/vault_v1/service.rb', line 179

def create_matter(matter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters', options)
  command.request_representation = Google::Apis::VaultV1::Matter::Representation
  command.request_object = matter_object
  command.response_representation = Google::Apis::VaultV1::Matter::Representation
  command.response_class = Google::Apis::VaultV1::Matter
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_matter_export(matter_id, export_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Export

Creates an Export.

Parameters:

  • matter_id (String) —

    The matter ID.

  • export_object (Google::Apis::VaultV1::Export) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/google/apis/vault_v1/service.rb', line 448

def create_matter_export(matter_id, export_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/exports', options)
  command.request_representation = Google::Apis::VaultV1::Export::Representation
  command.request_object = export_object
  command.response_representation = Google::Apis::VaultV1::Export::Representation
  command.response_class = Google::Apis::VaultV1::Export
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_matter_hold(matter_id, hold_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Hold

Creates a hold in the given matter.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_object (Google::Apis::VaultV1::Hold) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/google/apis/vault_v1/service.rb', line 621

def create_matter_hold(matter_id, hold_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/holds', options)
  command.request_representation = Google::Apis::VaultV1::Hold::Representation
  command.request_object = hold_object
  command.response_representation = Google::Apis::VaultV1::Hold::Representation
  command.response_class = Google::Apis::VaultV1::Hold
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_matter_hold_account(matter_id, hold_id, held_account_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::HeldAccount

Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • held_account_object (Google::Apis::VaultV1::HeldAccount) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/google/apis/vault_v1/service.rb', line 845

def (matter_id, hold_id,  = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/holds/{holdId}/accounts', options)
  command.request_representation = Google::Apis::VaultV1::HeldAccount::Representation
  command.request_object = 
  command.response_representation = Google::Apis::VaultV1::HeldAccount::Representation
  command.response_class = Google::Apis::VaultV1::HeldAccount
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_matter_saved_query(matter_id, saved_query_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::SavedQuery

Creates a saved query.

Parameters:

  • matter_id (String) —

    The matter ID of the parent matter for which the saved query is to be created.

  • saved_query_object (Google::Apis::VaultV1::SavedQuery) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/google/apis/vault_v1/service.rb', line 950

def create_matter_saved_query(matter_id, saved_query_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/savedQueries', options)
  command.request_representation = Google::Apis::VaultV1::SavedQuery::Representation
  command.request_object = saved_query_object
  command.response_representation = Google::Apis::VaultV1::SavedQuery::Representation
  command.response_class = Google::Apis::VaultV1::SavedQuery
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_matter(matter_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Matter

Deletes the specified matter. Returns matter with updated state.

Parameters:

  • matter_id (String) —

    The matter ID

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



210
211
212
213
214
215
216
217
218
 
# File 'lib/google/apis/vault_v1/service.rb', line 210

def delete_matter(matter_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/matters/{matterId}', options)
  command.response_representation = Google::Apis::VaultV1::Matter::Representation
  command.response_class = Google::Apis::VaultV1::Matter
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_matter_export(matter_id, export_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Deletes an Export.

Parameters:

  • matter_id (String) —

    The matter ID.

  • export_id (String) —

    The export ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



482
483
484
485
486
487
488
489
490
491
 
# File 'lib/google/apis/vault_v1/service.rb', line 482

def delete_matter_export(matter_id, export_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/matters/{matterId}/exports/{exportId}', options)
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['exportId'] = export_id unless export_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_matter_hold(matter_id, hold_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Removes a hold by ID. This will release any HeldAccounts on this Hold.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



655
656
657
658
659
660
661
662
663
664
 
# File 'lib/google/apis/vault_v1/service.rb', line 655

def delete_matter_hold(matter_id, hold_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/matters/{matterId}/holds/{holdId}', options)
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_matter_hold_account(matter_id, hold_id, account_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • account_id (String) —

    The ID of the account to remove from the hold.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/google/apis/vault_v1/service.rb', line 883

def (matter_id, hold_id, , fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}', options)
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.params['accountId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_matter_saved_query(matter_id, saved_query_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Deletes a saved query by Id.

Parameters:

  • matter_id (String) —

    The matter ID of the parent matter for which the saved query is to be deleted.

  • saved_query_id (String) —

    ID of the saved query to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



984
985
986
987
988
989
990
991
992
993
 
# File 'lib/google/apis/vault_v1/service.rb', line 984

def delete_matter_saved_query(matter_id, saved_query_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/matters/{matterId}/savedQueries/{savedQueryId}', options)
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['savedQueryId'] = saved_query_id unless saved_query_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1131
1132
1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/google/apis/vault_v1/service.rb', line 1131

def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_matter(matter_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Matter

Gets the specified matter.

Parameters:

  • matter_id (String) —

    The matter ID.

  • view (String) (defaults to: nil) —

    Specifies which parts of the Matter to return in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/vault_v1/service.rb', line 242

def get_matter(matter_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}', options)
  command.response_representation = Google::Apis::VaultV1::Matter::Representation
  command.response_class = Google::Apis::VaultV1::Matter
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_matter_export(matter_id, export_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Export

Gets an Export.

Parameters:

  • matter_id (String) —

    The matter ID.

  • export_id (String) —

    The export ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



515
516
517
518
519
520
521
522
523
524
 
# File 'lib/google/apis/vault_v1/service.rb', line 515

def get_matter_export(matter_id, export_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/exports/{exportId}', options)
  command.response_representation = Google::Apis::VaultV1::Export::Representation
  command.response_class = Google::Apis::VaultV1::Export
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['exportId'] = export_id unless export_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_matter_hold(matter_id, hold_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Hold

Gets a hold by ID.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • view (String) (defaults to: nil) —

    Specifies which parts of the Hold to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/google/apis/vault_v1/service.rb', line 690

def get_matter_hold(matter_id, hold_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/holds/{holdId}', options)
  command.response_representation = Google::Apis::VaultV1::Hold::Representation
  command.response_class = Google::Apis::VaultV1::Hold
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_matter_saved_query(matter_id, saved_query_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::SavedQuery

Retrieves a saved query by Id.

Parameters:

  • matter_id (String) —

    The matter ID of the parent matter for which the saved query is to be retrieved.

  • saved_query_id (String) —

    ID of the saved query to be retrieved.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/google/apis/vault_v1/service.rb', line 1018

def get_matter_saved_query(matter_id, saved_query_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/savedQueries/{savedQueryId}', options)
  command.response_representation = Google::Apis::VaultV1::SavedQuery::Representation
  command.response_class = Google::Apis::VaultV1::SavedQuery
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['savedQueryId'] = saved_query_id unless saved_query_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/google/apis/vault_v1/service.rb', line 1162

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::VaultV1::Operation::Representation
  command.response_class = Google::Apis::VaultV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_matter_exports(matter_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListExportsResponse

Lists Exports.

Parameters:

  • matter_id (String) —

    The matter ID.

  • page_size (Fixnum) (defaults to: nil) —

    The number of exports to return in the response.

  • page_token (String) (defaults to: nil) —

    The pagination token as returned in the response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/google/apis/vault_v1/service.rb', line 550

def list_matter_exports(matter_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/exports', options)
  command.response_representation = Google::Apis::VaultV1::ListExportsResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListExportsResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_matter_hold_accounts(matter_id, hold_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListHeldAccountsResponse

Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



918
919
920
921
922
923
924
925
926
927
 
# File 'lib/google/apis/vault_v1/service.rb', line 918

def list_matter_hold_accounts(matter_id, hold_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/holds/{holdId}/accounts', options)
  command.response_representation = Google::Apis::VaultV1::ListHeldAccountsResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListHeldAccountsResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_matter_holds(matter_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListHoldsResponse

Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

Parameters:

  • matter_id (String) —

    The matter ID.

  • page_size (Fixnum) (defaults to: nil) —

    The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.

  • page_token (String) (defaults to: nil) —

    The pagination token as returned in the response. An empty token means start from the beginning.

  • view (String) (defaults to: nil) —

    Specifies which parts of the Hold to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/google/apis/vault_v1/service.rb', line 731

def list_matter_holds(matter_id, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/holds', options)
  command.response_representation = Google::Apis::VaultV1::ListHoldsResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListHoldsResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_matter_saved_queries(matter_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListSavedQueriesResponse

Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.

Parameters:

  • matter_id (String) —

    The matter ID of the parent matter for which the saved queries are to be retrieved.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of saved queries to return.

  • page_token (String) (defaults to: nil) —

    The pagination token as returned in the previous response. An empty token means start from the beginning.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/google/apis/vault_v1/service.rb', line 1056

def list_matter_saved_queries(matter_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters/{matterId}/savedQueries', options)
  command.response_representation = Google::Apis::VaultV1::ListSavedQueriesResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListSavedQueriesResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_matters(page_size: nil, page_token: nil, state: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListMattersResponse

Lists matters the user has access to.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    The number of matters to return in the response. Default and maximum are 100.

  • page_token (String) (defaults to: nil) —

    The pagination token as returned in the response.

  • state (String) (defaults to: nil) —

    If set, list only matters with that specific state. The default is listing matters of all states.

  • view (String) (defaults to: nil) —

    Specifies which parts of the matter to return in response.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/apis/vault_v1/service.rb', line 280

def list_matters(page_size: nil, page_token: nil, state: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/matters', options)
  command.response_representation = Google::Apis::VaultV1::ListMattersResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListMattersResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['state'] = state unless state.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/google/apis/vault_v1/service.rb', line 1205

def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::VaultV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::VaultV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_hold_held_accounts(matter_id, hold_id, remove_held_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::RemoveHeldAccountsResponse

Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The hold ID.

  • remove_held_accounts_request_object (Google::Apis::VaultV1::RemoveHeldAccountsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/google/apis/vault_v1/service.rb', line 769

def remove_hold_held_accounts(matter_id, hold_id, remove_held_accounts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts', options)
  command.request_representation = Google::Apis::VaultV1::RemoveHeldAccountsRequest::Representation
  command.request_object = remove_held_accounts_request_object
  command.response_representation = Google::Apis::VaultV1::RemoveHeldAccountsResponse::Representation
  command.response_class = Google::Apis::VaultV1::RemoveHeldAccountsResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_matter_permissions(matter_id, remove_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Empty

Removes an account as a matter collaborator.

Parameters:

  • matter_id (String) —

    The matter ID.

  • remove_matter_permissions_request_object (Google::Apis::VaultV1::RemoveMatterPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google/apis/vault_v1/service.rb', line 314

def remove_matter_permissions(matter_id, remove_matter_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:removePermissions', options)
  command.request_representation = Google::Apis::VaultV1::RemoveMatterPermissionsRequest::Representation
  command.request_object = remove_matter_permissions_request_object
  command.response_representation = Google::Apis::VaultV1::Empty::Representation
  command.response_class = Google::Apis::VaultV1::Empty
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reopen_matter(matter_id, reopen_matter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::ReopenMatterResponse

Reopens the specified matter. Returns matter with updated state.

Parameters:

  • matter_id (String) —

    The matter ID.

  • reopen_matter_request_object (Google::Apis::VaultV1::ReopenMatterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/apis/vault_v1/service.rb', line 347

def reopen_matter(matter_id, reopen_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:reopen', options)
  command.request_representation = Google::Apis::VaultV1::ReopenMatterRequest::Representation
  command.request_object = reopen_matter_request_object
  command.response_representation = Google::Apis::VaultV1::ReopenMatterResponse::Representation
  command.response_class = Google::Apis::VaultV1::ReopenMatterResponse
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undelete_matter(matter_id, undelete_matter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Matter

Undeletes the specified matter. Returns matter with updated state.

Parameters:

  • matter_id (String) —

    The matter ID.

  • undelete_matter_request_object (Google::Apis::VaultV1::UndeleteMatterRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/google/apis/vault_v1/service.rb', line 380

def undelete_matter(matter_id, undelete_matter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/matters/{matterId}:undelete', options)
  command.request_representation = Google::Apis::VaultV1::UndeleteMatterRequest::Representation
  command.request_object = undelete_matter_request_object
  command.response_representation = Google::Apis::VaultV1::Matter::Representation
  command.response_class = Google::Apis::VaultV1::Matter
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_matter(matter_id, matter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Matter

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.

Parameters:

  • matter_id (String) —

    The matter ID.

  • matter_object (Google::Apis::VaultV1::Matter) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/google/apis/vault_v1/service.rb', line 415

def update_matter(matter_id, matter_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/matters/{matterId}', options)
  command.request_representation = Google::Apis::VaultV1::Matter::Representation
  command.request_object = matter_object
  command.response_representation = Google::Apis::VaultV1::Matter::Representation
  command.response_class = Google::Apis::VaultV1::Matter
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_matter_hold(matter_id, hold_id, hold_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VaultV1::Hold

Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.

Parameters:

  • matter_id (String) —

    The matter ID.

  • hold_id (String) —

    The ID of the hold.

  • hold_object (Google::Apis::VaultV1::Hold) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/google/apis/vault_v1/service.rb', line 807

def update_matter_hold(matter_id, hold_id, hold_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/matters/{matterId}/holds/{holdId}', options)
  command.request_representation = Google::Apis::VaultV1::Hold::Representation
  command.request_object = hold_object
  command.response_representation = Google::Apis::VaultV1::Hold::Representation
  command.response_class = Google::Apis::VaultV1::Hold
  command.params['matterId'] = matter_id unless matter_id.nil?
  command.params['holdId'] = hold_id unless hold_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end