Class: Google::Apis::CloudresourcemanagerV1beta1::CloudResourceManagerService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudresourcemanagerV1beta1::CloudResourceManagerService
- Defined in:
- generated/google/apis/cloudresourcemanager_v1beta1/service.rb
Overview
Google Cloud Resource Manager API
The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
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
-
#clear_organization_org_policy(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Clears a
Policyfrom a resource. -
#clear_organization_org_policy_v1(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Clears a
Policyfrom a resource. -
#create_project(project_object = nil, use_legacy_stack: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Creates a Project resource.
-
#delete_project(project_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Marks the Project identified by the specified
project_id(for example,my-project-123) for deletion. -
#get_organization(name, organization_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization
Fetches an Organization resource identified by the specified resource name.
-
#get_organization_effective_org_policy(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Gets the effective
Policyon a resource. -
#get_organization_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Gets the effective
Policyon a resource. -
#get_organization_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Gets the access control policy for an Organization resource.
-
#get_organization_org_policy(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Gets a
Policyon a resource. -
#get_organization_org_policy_v1(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Gets a
Policyon a resource. -
#get_project(project_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Retrieves the Project identified by the specified
project_id(for example,my-project-123). -
#get_project_ancestry(project_id, get_ancestry_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
Gets a list of ancestors in the resource hierarchy for the Project identified by the specified
project_id(for example,my-project-123). -
#get_project_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Returns the IAM access control policy for the specified Project.
-
#initialize ⇒ CloudResourceManagerService
constructor
A new instance of CloudResourceManagerService.
-
#list_organization_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListAvailableOrgPolicyConstraintsResponse
Lists
Constraintsthat could be applied on the specified resource. -
#list_organization_org_policies(resource, list_org_policies_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListOrgPoliciesResponse
Lists all the
Policiesset for a particular resource. -
#list_organizations(filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
Lists Organization resources that are visible to the user and satisfy the specified filter.
-
#list_projects(page_token: nil, page_size: nil, filter: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse
Lists Projects that are visible to the user and satisfy the specified filter.
-
#set_organization_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Sets the access control policy on an Organization resource.
-
#set_organization_org_policy(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Updates the specified
Policyon the resource. -
#set_organization_org_policy_v1(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy
Updates the specified
Policyon the resource. -
#set_project_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Sets the IAM access control policy for the specified Project.
-
#test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified Organization.
-
#test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project.
-
#undelete_project(project_id, undelete_project_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Restores the Project identified by the specified
project_id(for example,my-project-123). -
#update_organization(name, organization_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization
Updates an Organization resource identified by the specified resource name.
-
#update_project(project_id, project_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Updates the attributes of the Project identified by the specified
project_id(for example,my-project-123).
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_v1beta1/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.
39 40 41 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#clear_organization_org_policy(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Clears a Policy from a resource.
71 72 73 74 75 76 77 78 79 80 81 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 71 def clear_organization_org_policy(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:clearOrgPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::ClearOrgPolicyRequest::Representation command.request_object = clear_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#clear_organization_org_policy_v1(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Clears a Policy from a resource.
475 476 477 478 479 480 481 482 483 484 485 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 475 def clear_organization_org_policy_v1(resource, clear_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:clearOrgPolicyV1', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::ClearOrgPolicyRequest::Representation command.request_object = clear_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#create_project(project_object = nil, use_legacy_stack: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.
651 652 653 654 655 656 657 658 659 660 661 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 651 def create_project(project_object = nil, use_legacy_stack: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation command.request_object = project_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project command.query['useLegacyStack'] = use_legacy_stack unless use_legacy_stack.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#delete_project(project_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Marks the Project identified by the specified
project_id (for example, my-project-123) for deletion.
This method will only affect the Project if the following criteria are met:
- The Project does not have a billing account associated with it.
- The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.
975 976 977 978 979 980 981 982 983 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 975 def delete_project(project_id, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/projects/{projectId}', ) command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty command.params['projectId'] = project_id unless project_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization(name, organization_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization
Fetches an Organization resource identified by the specified resource name.
543 544 545 546 547 548 549 550 551 552 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 543 def get_organization(name, organization_id: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization command.params['name'] = name unless name.nil? command.query['organizationId'] = organization_id unless organization_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization_effective_org_policy(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
285 286 287 288 289 290 291 292 293 294 295 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 285 def get_organization_effective_org_policy(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:getEffectiveOrgPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetEffectiveOrgPolicyRequest::Representation command.request_object = get_effective_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
613 614 615 616 617 618 619 620 621 622 623 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 613 def get_organization_effective_org_policy_v1(resource, get_effective_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:getEffectiveOrgPolicyV1', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetEffectiveOrgPolicyRequest::Representation command.request_object = get_effective_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Gets the access control policy for an Organization resource. May be empty
if no such policy or resource exists. The resource field should be the
organization's resource name, e.g. "organizations/123".
176 177 178 179 180 181 182 183 184 185 186 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 176 def get_organization_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization_org_policy(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
213 214 215 216 217 218 219 220 221 222 223 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 213 def get_organization_org_policy(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:getOrgPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetOrgPolicyRequest::Representation command.request_object = get_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_organization_org_policy_v1(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
250 251 252 253 254 255 256 257 258 259 260 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 250 def get_organization_org_policy_v1(resource, get_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:getOrgPolicyV1', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetOrgPolicyRequest::Representation command.request_object = get_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_project(project_id, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Retrieves the Project identified by the specified
project_id (for example, my-project-123).
The caller must have read permissions for this Project.
820 821 822 823 824 825 826 827 828 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 820 def get_project(project_id, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects/{projectId}', ) command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project command.params['projectId'] = project_id unless project_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_project_ancestry(project_id, get_ancestry_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse
Gets a list of ancestors in the resource hierarchy for the Project
identified by the specified project_id (for example, my-project-123).
The caller must have read permissions for this Project.
854 855 856 857 858 859 860 861 862 863 864 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 854 def get_project_ancestry(project_id, get_ancestry_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}:getAncestry', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryRequest::Representation command.request_object = get_ancestry_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::GetAncestryResponse command.params['projectId'] = project_id unless project_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#get_project_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
746 747 748 749 750 751 752 753 754 755 756 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 746 def get_project_iam_policy(resource, get_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{resource}:getIamPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::GetIamPolicyRequest::Representation command.request_object = get_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_organization_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListAvailableOrgPolicyConstraintsResponse
Lists Constraints that could be applied on the specified resource.
140 141 142 143 144 145 146 147 148 149 150 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 140 def list_organization_available_org_policy_constraints(resource, list_available_org_policy_constraints_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:listAvailableOrgPolicyConstraints', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::ListAvailableOrgPolicyConstraintsRequest::Representation command.request_object = list_available_org_policy_constraints_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListAvailableOrgPolicyConstraintsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListAvailableOrgPolicyConstraintsResponse command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_organization_org_policies(resource, list_org_policies_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListOrgPoliciesResponse
Lists all the Policies set for a particular resource.
508 509 510 511 512 513 514 515 516 517 518 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 508 def list_organization_org_policies(resource, list_org_policies_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:listOrgPolicies', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrgPoliciesRequest::Representation command.request_object = list_org_policies_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrgPoliciesResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrgPoliciesResponse command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_organizations(filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse
Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.
406 407 408 409 410 411 412 413 414 415 416 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 406 def list_organizations(filter: nil, page_token: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/organizations', ) command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListOrganizationsResponse command.query['filter'] = filter unless filter.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#list_projects(page_token: nil, page_size: nil, filter: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse
Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 1032 def list_projects(page_token: nil, page_size: nil, filter: nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/projects', ) command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::ListProjectsResponse command.query['pageToken'] = page_token unless page_token.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['filter'] = filter unless filter.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#set_organization_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Sets the access control policy on an Organization resource. Replaces any
existing policy. The resource field should be the organization's resource
name, e.g. "organizations/123".
107 108 109 110 111 112 113 114 115 116 117 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 107 def set_organization_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#set_organization_org_policy(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
442 443 444 445 446 447 448 449 450 451 452 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 442 def set_organization_org_policy(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:setOrgPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetOrgPolicyRequest::Representation command.request_object = set_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#set_organization_org_policy_v1(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::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.
356 357 358 359 360 361 362 363 364 365 366 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 356 def set_organization_org_policy_v1(resource, set_org_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:setOrgPolicyV1', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetOrgPolicyRequest::Representation command.request_object = set_org_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::OrgPolicy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#set_project_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Policy
Sets the IAM access control policy for the specified Project. Replaces
any existing policy.
The following constraints apply when using setIamPolicy():
- Project does not support
allUsersandallAuthenticatedUsersasmembersin aBindingof aPolicy. - The owner role can be granted only to
userandserviceAccount. - 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.
711 712 713 714 715 716 717 718 719 720 721 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 711 def set_project_iam_policy(resource, set_iam_policy_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{resource}:setIamPolicy', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::SetIamPolicyRequest::Representation command.request_object = set_iam_policy_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Policy::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Policy command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#test_organization_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified Organization.
The resource field should be the organization's resource name,
e.g. "organizations/123".
578 579 580 581 582 583 584 585 586 587 588 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 578 def (resource, = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#test_project_iam_permissions(resource, test_iam_permissions_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified Project.
924 925 926 927 928 929 930 931 932 933 934 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 924 def (resource, = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{resource}:testIamPermissions', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsRequest::Representation command.request_object = command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::TestIamPermissionsResponse command.params['resource'] = resource unless resource.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#undelete_project(project_id, undelete_project_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Empty
Restores the Project identified by the specified
project_id (for example, my-project-123).
You can only use this method for a Project that has a lifecycle state of
DELETE_REQUESTED.
After deletion starts, the Project cannot be restored.
The caller must have modify permissions for this Project.
785 786 787 788 789 790 791 792 793 794 795 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 785 def undelete_project(project_id, undelete_project_request_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/projects/{projectId}:undelete', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::UndeleteProjectRequest::Representation command.request_object = undelete_project_request_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Empty::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Empty command.params['projectId'] = project_id unless project_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#update_organization(name, organization_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Organization
Updates an Organization resource identified by the specified resource name.
320 321 322 323 324 325 326 327 328 329 330 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 320 def update_organization(name, organization_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/{+name}', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation command.request_object = organization_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Organization::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Organization command.params['name'] = name unless name.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |
#update_project(project_id, project_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1beta1::Project
Updates the attributes of the Project identified by the specified
project_id (for example, my-project-123).
The caller must have modify permissions for this Project.
890 891 892 893 894 895 896 897 898 899 900 |
# File 'generated/google/apis/cloudresourcemanager_v1beta1/service.rb', line 890 def update_project(project_id, project_object = nil, quota_user: nil, fields: nil, options: nil, &block) command = make_simple_command(:put, 'v1beta1/projects/{projectId}', ) command.request_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation command.request_object = project_object command.response_representation = Google::Apis::CloudresourcemanagerV1beta1::Project::Representation command.response_class = Google::Apis::CloudresourcemanagerV1beta1::Project command.params['projectId'] = project_id unless project_id.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['fields'] = fields unless fields.nil? execute_or_queue_command(command, &block) end |