Class: Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudresourcemanager_v1/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_v1'

Cloudresourcemanager = Google::Apis::CloudresourcemanagerV1 # 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

Constructor Details

#initialize ⇒ CloudResourceManagerService

Returns a new instance of CloudResourceManagerService



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

def initialize
  super('https://cloudresourcemanager.googleapis.com/', '')
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_v1/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_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#clear_folder_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



142
143
144
145
146
147
148
149
150
151
152
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 142

def clear_folder_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#clear_folder_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



211
212
213
214
215
216
217
218
219
220
221
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 211

def clear_folder_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#clear_organization_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1352

def clear_organization_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#clear_organization_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1671

def clear_organization_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#clear_project_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1091

def clear_project_org_policy(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#clear_project_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty

Clears a Policy from a resource.

Parameters:

  • resource (String) —

    Name of the resource for the Policy to clear.

  • clear_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest) (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:



802
803
804
805
806
807
808
809
810
811
812
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 802

def clear_project_org_policy_v1(resource, clear_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:clearOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ClearOrgPolicyRequest::Representation
  command.request_object = clear_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Empty
  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

#create_lien(lien_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Lien

Create a Lien which applies to the resource denoted by the parent field. Callers of this method will require permission on the parent resource. For example, applying to projects/1234 requires permission resourcemanager.projects.updateLiens. NOTE: Some resources may limit the number of Liens which may be applied.

Parameters:

  • lien_object (Google::Apis::CloudresourcemanagerV1::Lien) (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:



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1706

def create_lien(lien_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/liens', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::Lien::Representation
  command.request_object = lien_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Lien::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Lien
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Request that a new Project be created. The result is an Operation which can be used to track the creation process. It is automatically deleted after a few hours, so there is no need to call DeleteOperation. Our SLO permits Project creation to take up to 30 seconds at the 90th percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th percentile latency is around 11 seconds. We recommend polling at the 5th second with an exponential backoff.

Parameters:

  • project_object (Google::Apis::CloudresourcemanagerV1::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:



839
840
841
842
843
844
845
846
847
848
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 839

def create_project(project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
  command.request_object = project_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Operation::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::Operation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Delete a Lien by name. Callers of this method will require permission on the parent resource. For example, a Lien with a parent of projects/1234 requires permission resourcemanager.projects.updateLiens.

Parameters:

  • name (String) —

    The name/identifier of the Lien to delete.

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



1740
1741
1742
1743
1744
1745
1746
1747
1748
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1740

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



1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1060

def delete_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/projects/{projectId}', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_folder_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



349
350
351
352
353
354
355
356
357
358
359
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 349

def get_folder_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_folder_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



109
110
111
112
113
114
115
116
117
118
119
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 109

def get_folder_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_folder_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



314
315
316
317
318
319
320
321
322
323
324
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 314

def get_folder_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_folder_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



386
387
388
389
390
391
392
393
394
395
396
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 386

def get_folder_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

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



1812
1813
1814
1815
1816
1817
1818
1819
1820
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1812

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

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



1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1250

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

#get_organization_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1529

def get_organization_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_organization_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1283

def get_organization_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_organization_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1457

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, 'v1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_organization_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1494

def get_organization_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_organization_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1566

def get_organization_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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::CloudresourcemanagerV1::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:



906
907
908
909
910
911
912
913
914
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 906

def get_project(project_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects/{projectId}', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



940
941
942
943
944
945
946
947
948
949
950
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 940

def get_project_ancestry(project_id, get_ancestry_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:getAncestry', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetAncestryRequest::Representation
  command.request_object = get_ancestry_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::GetAncestryResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



526
527
528
529
530
531
532
533
534
535
536
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 526

def get_project_effective_org_policy(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources.

Parameters:

  • resource (String) —

    The name of the resource to start computing the effective Policy.

  • get_effective_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest) (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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1009

def get_project_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetEffectiveOrgPolicyRequest::Representation
  command.request_object = get_effective_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



454
455
456
457
458
459
460
461
462
463
464
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 454

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, 'v1/projects/{resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



491
492
493
494
495
496
497
498
499
500
501
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 491

def get_project_org_policy(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Parameters:

  • resource (String) —

    Name of the resource the Policy is set on.

  • get_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest) (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:



563
564
565
566
567
568
569
570
571
572
573
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 563

def get_project_org_policy_v1(resource, get_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:getOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::GetOrgPolicyRequest::Representation
  command.request_object = get_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_folder_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse

Lists Constraints that could be applied on the specified resource.

Parameters:

  • resource (String) —

    Name of the resource to list Constraints for.

  • list_available_org_policy_constraints_request_object (Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest) (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:



277
278
279
280
281
282
283
284
285
286
287
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 277

def list_folder_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation
  command.request_object = list_available_org_policy_constraints_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse
  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_folder_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse

Lists all the Policies set for a particular resource.

Parameters:

  • resource (String) —

    Name of the resource to list Policies for.

  • list_org_policies_request_object (Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest) (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:



244
245
246
247
248
249
250
251
252
253
254
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 244

def list_folder_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation
  command.request_object = list_org_policies_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse
  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_liens(parent: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListLiensResponse

List all Liens applied to the parent resource. Callers of this method will require permission on the parent resource. For example, a Lien with a parent of projects/1234 requires permission resourcemanager.projects.get.

Parameters:

  • parent (String) —

    The name of the resource to list all attached Liens. For example, projects/1234.

  • page_token (String) —

    The next_page_token value returned from a previous List request, if any.

  • page_size (Fixnum) —

    The maximum number of items to return. This is a suggestion for the server.

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



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1778

def list_liens(parent: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/liens', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListLiensResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListLiensResponse
  command.query['parent'] = parent unless parent.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.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_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse

Lists Constraints that could be applied on the specified resource.

Parameters:

  • resource (String) —

    Name of the resource to list Constraints for.

  • list_available_org_policy_constraints_request_object (Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest) (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:



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1421

def list_organization_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation
  command.request_object = list_available_org_policy_constraints_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse
  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_organization_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse

Lists all the Policies set for a particular resource.

Parameters:

  • resource (String) —

    Name of the resource to list Policies for.

  • list_org_policies_request_object (Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest) (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:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1185

def list_organization_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation
  command.request_object = list_org_policies_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse
  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_project_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse

Lists Constraints that could be applied on the specified resource.

Parameters:

  • resource (String) —

    Name of the resource to list Constraints for.

  • list_available_org_policy_constraints_request_object (Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest) (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:



419
420
421
422
423
424
425
426
427
428
429
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 419

def list_project_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listAvailableOrgPolicyConstraints', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsRequest::Representation
  command.request_object = list_available_org_policy_constraints_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListAvailableOrgPolicyConstraintsResponse
  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_project_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse

Lists all the Policies set for a particular resource.

Parameters:

  • resource (String) —

    Name of the resource to list Policies for.

  • list_org_policies_request_object (Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest) (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:



871
872
873
874
875
876
877
878
879
880
881
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 871

def list_project_org_policies(resource, list_org_policies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:listOrgPolicies', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesRequest::Representation
  command.request_object = list_org_policies_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::ListOrgPoliciesResponse
  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_projects(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::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:



733
734
735
736
737
738
739
740
741
742
743
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 733

def list_projects(page_token: nil, page_size: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/projects', options)
  command.response_representation = Google::Apis::CloudresourcemanagerV1::ListProjectsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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

#search_organizations(search_organizations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse

Searches 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 results.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1219

def search_organizations(search_organizations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/organizations:search', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsRequest::Representation
  command.request_object = search_organizations_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::SearchOrganizationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_folder_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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:



178
179
180
181
182
183
184
185
186
187
188
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 178

def set_folder_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_folder_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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_v1/service.rb', line 74

def set_folder_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_organization_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1388

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, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_organization_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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:



1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1638

def set_organization_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_organization_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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:



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1602

def set_organization_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1152

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, 'v1/projects/{resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Policy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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:



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

def set_project_org_policy(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicy', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::OrgPolicy

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Parameters:

  • resource (String) —

    Resource name of the resource to attach the Policy.

  • set_org_policy_request_object (Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest) (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:



674
675
676
677
678
679
680
681
682
683
684
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 674

def set_project_org_policy_v1(resource, set_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+resource}:setOrgPolicyV1', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::SetOrgPolicyRequest::Representation
  command.request_object = set_org_policy_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::OrgPolicy::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::OrgPolicy
  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::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1319

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, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



974
975
976
977
978
979
980
981
982
983
984
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 974

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, 'v1/projects/{resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



602
603
604
605
606
607
608
609
610
611
612
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 602

def undelete_project(project_id, undelete_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/projects/{projectId}:undelete', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::UndeleteProjectRequest::Representation
  command.request_object = undelete_project_request_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Empty::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::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::CloudresourcemanagerV1::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:



638
639
640
641
642
643
644
645
646
647
648
 
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 638

def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1/projects/{projectId}', options)
  command.request_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
  command.request_object = project_object
  command.response_representation = Google::Apis::CloudresourcemanagerV1::Project::Representation
  command.response_class = Google::Apis::CloudresourcemanagerV1::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