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

#initializeAccessApprovalService

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

#keyString

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_userString

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:


182
183
184
185
186
187
188
189
190
191
192
# File 'generated/google/apis/accessapproval_v1/service.rb', line 182

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:


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

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:


698
699
700
701
702
703
704
705
706
707
708
# File 'generated/google/apis/accessapproval_v1/service.rb', line 698

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:


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

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:


332
333
334
335
336
337
338
339
340
# File 'generated/google/apis/accessapproval_v1/service.rb', line 332

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:


590
591
592
593
594
595
596
597
598
# File 'generated/google/apis/accessapproval_v1/service.rb', line 590

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:


219
220
221
222
223
224
225
226
227
228
229
# File 'generated/google/apis/accessapproval_v1/service.rb', line 219

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:


477
478
479
480
481
482
483
484
485
486
487
# File 'generated/google/apis/accessapproval_v1/service.rb', line 477

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:


735
736
737
738
739
740
741
742
743
744
745
# File 'generated/google/apis/accessapproval_v1/service.rb', line 735

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:


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

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:


251
252
253
254
255
256
257
258
259
# File 'generated/google/apis/accessapproval_v1/service.rb', line 251

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:


362
363
364
365
366
367
368
369
370
# File 'generated/google/apis/accessapproval_v1/service.rb', line 362

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:


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

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:


620
621
622
623
624
625
626
627
628
# File 'generated/google/apis/accessapproval_v1/service.rb', line 620

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:


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

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. 6. HISTORY: Active and 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:


295
296
297
298
299
300
301
302
303
304
305
306
# File 'generated/google/apis/accessapproval_v1/service.rb', line 295

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. 6. HISTORY: Active and 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:


553
554
555
556
557
558
559
560
561
562
563
564
# File 'generated/google/apis/accessapproval_v1/service.rb', line 553

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. 6. HISTORY: Active and 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:


811
812
813
814
815
816
817
818
819
820
821
822
# File 'generated/google/apis/accessapproval_v1/service.rb', line 811

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:


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

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:


404
405
406
407
408
409
410
411
412
413
414
415
# File 'generated/google/apis/accessapproval_v1/service.rb', line 404

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:


662
663
664
665
666
667
668
669
670
671
672
673
# File 'generated/google/apis/accessapproval_v1/service.rb', line 662

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