Class: Google::Apis::CloudresourcemanagerV1beta1::CloudResourceManagerService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudresourcemanager_v1beta1/service.rb

Overview

Google Cloud Resource Manager API

The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.

Examples:

require 'google/apis/cloudresourcemanager_v1beta1'

Cloudresourcemanager = Google::Apis::CloudresourcemanagerV1beta1 # Alias the module
service = Cloudresourcemanager::CloudResourceManagerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initialize ⇒ CloudResourceManagerService

Returns a new instance of CloudResourceManagerService



46
47
48
49
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 46

def initialize
  super('https://cloudresourcemanager.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.



39
40
41
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#create_project(project_object = nil, use_legacy_stack: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project

Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.

Parameters:

  • project_object (Google::Apis::CloudresourcemanagerV1beta1::Project) (defaults to: nil)
  • use_legacy_stack (Boolean) —

    A safety hatch to opt out of the new reliable project creation process.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



398
399
400
401
402
403
404
405
406
407
408
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 398

def create_project(project_object = nil, use_legacy_stack: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
  command.request_object = project_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
  command.query['useLegacyStack'] = use_legacy_stack unless use_legacy_stack.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(project_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty

Marks the Project identified by the specified project_id (for example, my-project-123) for deletion. This method will only affect the Project if the following criteria are met:

  • The Project does not have a billing account associated with it.
  • The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

Parameters:

  • project_id (String) —

    The Project ID (for example, foo-bar-123). Required.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def delete_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/projects/{projectId}', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization(name, organization_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization

Fetches an Organization resource identified by the specified resource name.

Parameters:

  • name (String) —

    The resource name of the Organization to fetch, e.g. "organizations/1234".

  • organization_id (String) —

    The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_organization(name, organization_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
  command.params['name'] = name unless name.nil?
  command.query['organizationId'] = organization_id unless organization_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy

Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The resource field should be the organization's resource name, e.g. "organizations/123".

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
  command.params['resource'] = resource unless resource.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(project_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project

Retrieves the Project identified by the specified project_id (for example, my-project-123). The caller must have read permissions for this Project.

Parameters:

  • project_id (String) —

    The Project ID (for example, my-project-123). Required.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects/{projectId}', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse

Gets a list of ancestors in the resource hierarchy for the Project identified by the specified project_id (for example, my-project-123). The caller must have read permissions for this Project.

Parameters:

  • project_id (String) —

    The Project ID (for example, my-project-123). Required.

  • get_ancestry_request_object (Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    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/cloudresourcemanager_v1beta1/service.rb', line 182

def get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}:getAncestry', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest::Representation
  command.request_object = get_ancestry_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy

Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • get_iam_policy_request_object (Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def get_project_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
  command.params['resource'] = resource unless resource.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_organizations(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse

Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.

Parameters:

  • page_token (String) —

    A pagination token returned from a previous call to ListOrganizations that indicates from where listing should continue. This field is optional.

  • page_size (Fixnum) —

    The maximum number of Organizations to return in the response. This field is optional.

  • filter (String) —

    An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by owner.directoryCustomerId or by domain, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with owner. directory_customer_id equal to 123456789.| |domain:google.com|Organizations corresponding to the domain google.com.| This field is optional.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_organizations(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/organizations', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.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_projects(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse

Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

Parameters:

  • page_token (String) —

    A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.

  • page_size (Fixnum) —

    The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.

  • filter (String) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • name
    • id
    • labels.key where key is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:|The project has a name.| |name:Howl|The project's name is Howl or howl.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:|The project has the label color.| |labels.color:red|The project's label color has the value red.| |labels.color:red labels.size:big|The project's label color has the value red and its label size has the value big. Optional.
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def list_projects(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/projects', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_organization_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy

Sets the access control policy on an Organization resource. Replaces any existing policy. The resource field should be the organization's resource name, e.g. "organizations/123".

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



544
545
546
547
548
549
550
551
552
553
554
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 544

def set_organization_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy

Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using setIamPolicy():

  • Project does not support allUsers and allAuthenticatedUsers as members in a Binding of a Policy.
  • The owner role can be granted only to user and serviceAccount.
  • Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation.
  • A user cannot be granted the owner role using setIamPolicy(). The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation.
  • Invitations to grant the owner role cannot be sent using setIamPolicy(); they must be sent only using the Cloud Platform Console.
  • Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected.
  • There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling setIamPolicy() to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified.
  • Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • set_iam_policy_request_object (Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def set_project_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified Organization. The resource field should be the organization's resource name, e.g. "organizations/123".

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



685
686
687
688
689
690
691
692
693
694
695
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 685

def test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified Project.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • test_iam_permissions_request_object (Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



252
253
254
255
256
257
258
259
260
261
262
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 252

def test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty

Restores the Project identified by the specified project_id (for example, my-project-123). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have modify permissions for this Project.

Parameters:

  • project_id (String) —

    The project ID (for example, foo-bar-123). Required.

  • undelete_project_request_object (Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



113
114
115
116
117
118
119
120
121
122
123
 
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 113

def undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/projects/{projectId}:undelete', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest::Representation
  command.request_object = undelete_project_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization(name, organization_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization

Updates an Organization resource identified by the specified resource name.

Parameters:

  • name (String) —

    Output Only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234".

  • organization_object (Google::Apis::CloudresourcemanagerV1beta1::Organization) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def update_organization(name, organization_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
  command.request_object = organization_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization
  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

#update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project

Updates the attributes of the Project identified by the specified project_id (for example, my-project-123). The caller must have modify permissions for this Project.

Parameters:

  • project_id (String) —

    The project ID (for example, my-project-123). Required.

  • project_object (Google::Apis::CloudresourcemanagerV1beta1::Project) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/projects/{projectId}', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
  command.request_object = project_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project
  command.params['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end