Class: Google::Apis::AccessapprovalV1::AccessApprovalService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/accessapproval_v1/service.rb

Overview

Access Approval API

An API for controlling access to data by Google personnel.

Examples:

require 'google/apis/accessapproval_v1'

Accessapproval = Google::Apis::AccessapprovalV1 # Alias the module
service = Accessapproval::AccessApprovalService.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

#initialize ⇒ AccessApprovalService

Returns a new instance of AccessApprovalService.



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

def initialize
  super('https://accessapproval.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/accessapproval_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/accessapproval_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#approve_folder_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the approval request to approve.

  • approve_approval_request_message_object (Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage) (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:



189
190
191
192
193
194
195
196
197
198
199
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 189

def approve_folder_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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

#approve_organization_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the approval request to approve.

  • approve_approval_request_message_object (Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage) (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:



459
460
461
462
463
464
465
466
467
468
469
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 459

def approve_organization_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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

#approve_project_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the approval request to approve.

  • approve_approval_request_message_object (Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage) (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:



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

def approve_project_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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

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

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to delete.

  • 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:



75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 75

def delete_folder_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
  command.response_class = Google::Apis::AccessapprovalV1::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

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

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to delete.

  • 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:



345
346
347
348
349
350
351
352
353
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 345

def delete_organization_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
  command.response_class = Google::Apis::AccessapprovalV1::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

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

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to delete.

  • 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:



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

def delete_project_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
  command.response_class = Google::Apis::AccessapprovalV1::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

#dismiss_folder_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the ApprovalRequest to dismiss.

  • dismiss_approval_request_message_object (Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage) (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:



228
229
230
231
232
233
234
235
236
237
238
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 228

def dismiss_folder_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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

#dismiss_organization_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the ApprovalRequest to dismiss.

  • dismiss_approval_request_message_object (Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage) (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:



498
499
500
501
502
503
504
505
506
507
508
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 498

def dismiss_organization_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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

#dismiss_project_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

Parameters:

  • name (String) —

    Name of the ApprovalRequest to dismiss.

  • dismiss_approval_request_message_object (Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage) (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:



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

def dismiss_project_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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_folder_access_approval_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Gets the settings associated with a project, folder, or organization.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to retrieve.

  • 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:



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

def get_folder_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  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_folder_approval_request(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters:

  • name (String) —

    Name of the approval request to retrieve.

  • 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:



260
261
262
263
264
265
266
267
268
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 260

def get_folder_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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_organization_access_approval_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Gets the settings associated with a project, folder, or organization.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to retrieve.

  • 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:



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

def get_organization_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  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_organization_approval_request(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters:

  • name (String) —

    Name of the approval request to retrieve.

  • 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:



530
531
532
533
534
535
536
537
538
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 530

def get_organization_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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_project_access_approval_settings(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Gets the settings associated with a project, folder, or organization.

Parameters:

  • name (String) —

    Name of the AccessApprovalSettings to retrieve.

  • 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:



645
646
647
648
649
650
651
652
653
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 645

def get_project_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  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_project_approval_request(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ApprovalRequest

Gets an approval request. Returns NOT_FOUND if the request does not exist.

Parameters:

  • name (String) —

    Name of the approval request to retrieve.

  • 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:



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

def get_project_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
  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_folder_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters:

  • parent (String) —

    The parent resource. This may be "projects/project_id", "folders/folder_id", or "organizations/organization_id".

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

    A filter on the type of approval requests to retrieve. Must be one of the following values:

    1. [not set]: Requests that are pending or have active approvals.
    2. ALL: All requests.
    3. PENDING: Only pending requests.
    4. ACTIVE: Only active (i.e. currently approved) requests.
    5. DISMISSED: Only dismissed (including expired) requests.
  • page_size (Fixnum) (defaults to: nil) —

    Requested page size.

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

    A token identifying the page of results 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:



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

def list_folder_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
  command.params['parent'] = parent unless parent.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

#list_organization_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters:

  • parent (String) —

    The parent resource. This may be "projects/project_id", "folders/folder_id", or "organizations/organization_id".

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

    A filter on the type of approval requests to retrieve. Must be one of the following values:

    1. [not set]: Requests that are pending or have active approvals.
    2. ALL: All requests.
    3. PENDING: Only pending requests.
    4. ACTIVE: Only active (i.e. currently approved) requests.
    5. DISMISSED: Only dismissed (including expired) requests.
  • page_size (Fixnum) (defaults to: nil) —

    Requested page size.

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

    A token identifying the page of results 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:



577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 577

def list_organization_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
  command.params['parent'] = parent unless parent.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

#list_project_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

Parameters:

  • parent (String) —

    The parent resource. This may be "projects/project_id", "folders/folder_id", or "organizations/organization_id".

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

    A filter on the type of approval requests to retrieve. Must be one of the following values:

    1. [not set]: Requests that are pending or have active approvals.
    2. ALL: All requests.
    3. PENDING: Only pending requests.
    4. ACTIVE: Only active (i.e. currently approved) requests.
    5. DISMISSED: Only dismissed (including expired) requests.
  • page_size (Fixnum) (defaults to: nil) —

    Requested page size.

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

    A token identifying the page of results 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:



847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 847

def list_project_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
  command.params['parent'] = parent unless parent.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

#update_folder_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters:

  • name (String) —

    The resource name of the settings. Format is one of:

    1. "projects/project_id/accessApprovalSettings"
    2. "folders/folder_id/accessApprovalSettings"
    3. "organizations/organization_id/accessApprovalSettings"

  • access_approval_settings_object (Google::Apis::AccessapprovalV1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask If this field is left unset, only the notification_emails field will be updated.

  • 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:



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 153

def update_folder_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_organization_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters:

  • name (String) —

    The resource name of the settings. Format is one of:

    1. "projects/project_id/accessApprovalSettings"
    2. "folders/folder_id/accessApprovalSettings"
    3. "organizations/organization_id/accessApprovalSettings"

  • access_approval_settings_object (Google::Apis::AccessapprovalV1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask If this field is left unset, only the notification_emails field will be updated.

  • 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:



423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 423

def update_organization_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_project_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccessapprovalV1::AccessApprovalSettings

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

Parameters:

  • name (String) —

    The resource name of the settings. Format is one of:

    1. "projects/project_id/accessApprovalSettings"
    2. "folders/folder_id/accessApprovalSettings"
    3. "organizations/organization_id/accessApprovalSettings"

  • access_approval_settings_object (Google::Apis::AccessapprovalV1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask If this field is left unset, only the notification_emails field will be updated.

  • 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:



693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'generated/google/apis/accessapproval_v1/service.rb', line 693

def update_project_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end