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

Inherits:
Core::BaseService 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

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeVaultService


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

#keyString


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

def key
  @key
end

#quota_userString


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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


547
548
549
550
551
552
553
554
555
556
557
558
# File 'generated/google/apis/vault_v1/service.rb', line 547

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

#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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

#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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


805
806
807
808
809
810
811
812
813
814
815
816
# File 'generated/google/apis/vault_v1/service.rb', line 805

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


913
914
915
916
917
918
919
920
921
922
923
# File 'generated/google/apis/vault_v1/service.rb', line 913

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


168
169
170
171
172
173
174
175
176
# File 'generated/google/apis/vault_v1/service.rb', line 168

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


843
844
845
846
847
848
849
850
851
852
853
# File 'generated/google/apis/vault_v1/service.rb', line 843

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


948
949
950
951
952
953
954
955
956
957
# File 'generated/google/apis/vault_v1/service.rb', line 948

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

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

Gets the specified matter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


650
651
652
653
654
655
656
657
658
659
660
# File 'generated/google/apis/vault_v1/service.rb', line 650

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


982
983
984
985
986
987
988
989
990
991
# File 'generated/google/apis/vault_v1/service.rb', line 982

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

#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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


510
511
512
513
514
515
516
517
518
519
520
# File 'generated/google/apis/vault_v1/service.rb', line 510

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


880
881
882
883
884
885
886
887
888
889
# File 'generated/google/apis/vault_v1/service.rb', line 880

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
# File 'generated/google/apis/vault_v1/service.rb', line 1020

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


239
240
241
242
243
244
245
246
247
248
249
250
# File 'generated/google/apis/vault_v1/service.rb', line 239

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

#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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


729
730
731
732
733
734
735
736
737
738
739
740
# File 'generated/google/apis/vault_v1/service.rb', line 729

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


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

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


375
376
377
378
379
380
381
382
383
384
385
# File 'generated/google/apis/vault_v1/service.rb', line 375

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


767
768
769
770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/vault_v1/service.rb', line 767

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