Class: Google::Apis::AccessapprovalV1beta1::AccessApprovalService

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

Overview

Access Approval API

An API for controlling access to data by Google personnel.

Examples:

require 'google/apis/accessapproval_v1beta1'

Accessapproval = Google::Apis::AccessapprovalV1beta1 # 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_v1beta1/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_v1beta1/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_v1beta1/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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


184
185
186
187
188
189
190
191
192
193
194
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 184

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, 'v1beta1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


449
450
451
452
453
454
455
456
457
458
459
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 449

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, 'v1beta1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


714
715
716
717
718
719
720
721
722
723
724
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 714

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, 'v1beta1/{+name}:approve', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::ApproveApprovalRequestMessage::Representation
  command.request_object = approve_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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_v1beta1/service.rb', line 75

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


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

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


605
606
607
608
609
610
611
612
613
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 605

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


223
224
225
226
227
228
229
230
231
232
233
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 223

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, 'v1beta1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


488
489
490
491
492
493
494
495
496
497
498
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 488

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, 'v1beta1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


753
754
755
756
757
758
759
760
761
762
763
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 753

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, 'v1beta1/{+name}:dismiss', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::DismissApprovalRequestMessage::Representation
  command.request_object = dismiss_approval_request_message_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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_v1beta1/service.rb', line 105

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


255
256
257
258
259
260
261
262
263
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 255

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


370
371
372
373
374
375
376
377
378
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 370

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


520
521
522
523
524
525
526
527
528
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 520

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


635
636
637
638
639
640
641
642
643
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 635

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


785
786
787
788
789
790
791
792
793
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 785

def get_project_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ApprovalRequest::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


302
303
304
305
306
307
308
309
310
311
312
313
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 302

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, 'v1beta1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


567
568
569
570
571
572
573
574
575
576
577
578
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 567

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, 'v1beta1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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:


832
833
834
835
836
837
838
839
840
841
842
843
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 832

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, 'v1beta1/{+parent}/approvalRequests', options)
  command.response_representation = Google::Apis::AccessapprovalV1beta1::ListApprovalRequestsResponse::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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:


148
149
150
151
152
153
154
155
156
157
158
159
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 148

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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:


413
414
415
416
417
418
419
420
421
422
423
424
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 413

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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::AccessapprovalV1beta1::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::AccessapprovalV1beta1::AccessApprovalSettings) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    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:


678
679
680
681
682
683
684
685
686
687
688
689
# File 'generated/google/apis/accessapproval_v1beta1/service.rb', line 678

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, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.request_object = access_approval_settings_object
  command.response_representation = Google::Apis::AccessapprovalV1beta1::AccessApprovalSettings::Representation
  command.response_class = Google::Apis::AccessapprovalV1beta1::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