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

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

Overview

G Suite Vault API

Archiving and eDiscovery for G Suite.

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.



45
46
47
48
 
# File 'generated/google/apis/vault_v1/service.rb', line 45

def initialize
  super('https://vault.googleapis.com/', '')
  @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.



38
39
40
 
# File 'generated/google/apis/vault_v1/service.rb', line 38

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.



43
44
45
 
# File 'generated/google/apis/vault_v1/service.rb', line 43

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



579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'generated/google/apis/vault_v1/service.rb', line 579

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



71
72
73
74
75
76
77
78
79
80
81
 
# File 'generated/google/apis/vault_v1/service.rb', line 71

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



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'generated/google/apis/vault_v1/service.rb', line 1088

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



104
105
106
107
108
109
110
111
112
113
114
 
# File 'generated/google/apis/vault_v1/service.rb', line 104

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



138
139
140
141
142
143
144
145
146
147
148
 
# File 'generated/google/apis/vault_v1/service.rb', line 138

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



171
172
173
174
175
176
177
178
179
180
 
# File 'generated/google/apis/vault_v1/service.rb', line 171

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



440
441
442
443
444
445
446
447
448
449
450
 
# File 'generated/google/apis/vault_v1/service.rb', line 440

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



613
614
615
616
617
618
619
620
621
622
623
 
# File 'generated/google/apis/vault_v1/service.rb', line 613

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



837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'generated/google/apis/vault_v1/service.rb', line 837

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



942
943
944
945
946
947
948
949
950
951
952
 
# File 'generated/google/apis/vault_v1/service.rb', line 942

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



202
203
204
205
206
207
208
209
210
 
# File 'generated/google/apis/vault_v1/service.rb', line 202

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



474
475
476
477
478
479
480
481
482
483
 
# File 'generated/google/apis/vault_v1/service.rb', line 474

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



647
648
649
650
651
652
653
654
655
656
 
# File 'generated/google/apis/vault_v1/service.rb', line 647

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



875
876
877
878
879
880
881
882
883
884
885
 
# File 'generated/google/apis/vault_v1/service.rb', line 875

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



976
977
978
979
980
981
982
983
984
985
 
# File 'generated/google/apis/vault_v1/service.rb', line 976

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



1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'generated/google/apis/vault_v1/service.rb', line 1123

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



234
235
236
237
238
239
240
241
242
243
 
# File 'generated/google/apis/vault_v1/service.rb', line 234

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



507
508
509
510
511
512
513
514
515
516
 
# File 'generated/google/apis/vault_v1/service.rb', line 507

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



682
683
684
685
686
687
688
689
690
691
692
 
# File 'generated/google/apis/vault_v1/service.rb', line 682

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



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'generated/google/apis/vault_v1/service.rb', line 1010

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



1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'generated/google/apis/vault_v1/service.rb', line 1154

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



542
543
544
545
546
547
548
549
550
551
552
 
# File 'generated/google/apis/vault_v1/service.rb', line 542

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



910
911
912
913
914
915
916
917
918
919
 
# File 'generated/google/apis/vault_v1/service.rb', line 910

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



723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'generated/google/apis/vault_v1/service.rb', line 723

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



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'generated/google/apis/vault_v1/service.rb', line 1048

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



272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'generated/google/apis/vault_v1/service.rb', line 272

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



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'generated/google/apis/vault_v1/service.rb', line 1197

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



761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'generated/google/apis/vault_v1/service.rb', line 761

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



306
307
308
309
310
311
312
313
314
315
316
 
# File 'generated/google/apis/vault_v1/service.rb', line 306

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



339
340
341
342
343
344
345
346
347
348
349
 
# File 'generated/google/apis/vault_v1/service.rb', line 339

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



372
373
374
375
376
377
378
379
380
381
382
 
# File 'generated/google/apis/vault_v1/service.rb', line 372

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



407
408
409
410
411
412
413
414
415
416
417
 
# File 'generated/google/apis/vault_v1/service.rb', line 407

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



799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'generated/google/apis/vault_v1/service.rb', line 799

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