Class: Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService
- Defined in:
- generated/google/apis/cloudresourcemanager_v1/service.rb
Overview
Cloud Resource Manager API
Creates, reads, and updates metadata for Google Cloud Platform resource containers.
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_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. -
#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. -
#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. -
#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. -
#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.
-
#delete_lien(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Empty
Delete a Lien by
name
. -
#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. -
#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. -
#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. -
#get_lien(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Lien
Retrieve a Lien by
name
. -
#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.
-
#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.
-
#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. -
#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.
-
#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. -
#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
). -
#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
). -
#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. -
#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.
-
#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. -
#initialize ⇒ CloudResourceManagerService
constructor
A new instance of CloudResourceManagerService.
-
#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. -
#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. -
#list_liens(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListLiensResponse
List all Liens applied to the
parent
resource. -
#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. -
#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. -
#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. -
#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. -
#list_projects(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListProjectsResponse
Lists Projects that the caller has the
resourcemanager.projects.get
permission on and satisfy the specified filter. -
#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.
-
#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. -
#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.
-
#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. -
#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.
-
#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. -
#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.
-
#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.
-
#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
). -
#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
).
Methods inherited from Google::Apis::Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Google::Apis::Core::Logging
Constructor Details
#initialize ⇒ CloudResourceManagerService
Returns a new instance of CloudResourceManagerService.
46 47 48 49 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 46 def initialize super('https://cloudresourcemanager.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
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.
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.
72 73 74 75 76 77 78 79 80 81 82 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 72 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', ) 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.
454 455 456 457 458 459 460 461 462 463 464 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 454 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', ) 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.
843 844 845 846 847 848 849 850 851 852 853 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 843 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', ) 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.
283 284 285 286 287 288 289 290 291 292 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 283 def create_lien(lien_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/liens', ) 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. This process usually takes a few
seconds, but can sometimes take much longer. The tracking Operation is
automatically deleted after a few hours, so there is no need to call
DeleteOperation.
Authorization requires the Google IAM permission
resourcemanager.projects.create
on the specified parent for the new
project. The parent is identified by a specified ResourceId,
which must include both an ID and a type, such as organization.
This method does not associate the new project with a billing account.
You can set or update the billing account associated with a project using
the projects.updateBillingInfo
method.
886 887 888 889 890 891 892 893 894 895 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 886 def create_project(project_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects', ) 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
.
317 318 319 320 321 322 323 324 325 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 317 def delete_lien(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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 it 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.
934 935 936 937 938 939 940 941 942 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 934 def delete_project(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/projects/{projectId}', ) 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 etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
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(resource, get_effective_org_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:getEffectiveOrgPolicy', ) 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.
146 147 148 149 150 151 152 153 154 155 156 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 146 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', ) 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_lien(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::Lien
Retrieve 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
requires permission resourcemanager.projects.get
or
resourcemanager.projects.updateLiens
.
351 352 353 354 355 356 357 358 359 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 351 def get_lien(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::CloudresourcemanagerV1::Lien::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::Lien 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_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.
423 424 425 426 427 428 429 430 431 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 423 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
488 489 490 491 492 493 494 495 496 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 488 def get_organization(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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 etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
523 524 525 526 527 528 529 530 531 532 533 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 523 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', ) 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".
Authorization requires the Google IAM permission
resourcemanager.organizations.getIamPolicy
on the specified organization
561 562 563 564 565 566 567 568 569 570 571 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 561 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', ) 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.
598 599 600 601 602 603 604 605 606 607 608 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 598 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', ) 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.
967 968 969 970 971 972 973 974 975 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 967 def get_project(project_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects/{projectId}', ) 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.
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1001 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', ) 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 etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1038 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', ) 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.
Authorization requires the Google IAM permission
resourcemanager.projects.getIamPolicy
on the project.
For additional information about resource structure and identification,
see Resource Names.
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1077 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', ) 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.
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1114 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', ) 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.
179 180 181 182 183 184 185 186 187 188 189 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 179 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', ) 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.
212 213 214 215 216 217 218 219 220 221 222 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 212 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', ) 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(page_size: nil, page_token: nil, parent: 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
.
389 390 391 392 393 394 395 396 397 398 399 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 389 def list_liens(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/liens', ) command.response_representation = Google::Apis::CloudresourcemanagerV1::ListLiensResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListLiensResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parent'] = parent unless parent.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.
631 632 633 634 635 636 637 638 639 640 641 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 631 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', ) 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.
664 665 666 667 668 669 670 671 672 673 674 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 664 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', ) 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.
1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1227 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', ) 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.
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1260 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', ) 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(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudresourcemanagerV1::ListProjectsResponse
Lists Projects that the caller has the resourcemanager.projects.get
permission on and satisfy the specified filter.
This method returns Projects in an unspecified order.
This method is eventually consistent with project mutations; this means
that a newly created project may not appear in the results or recent
updates to an existing project may not be reflected in the results. To
retrieve the latest state of a project, use the
GetProject method.
NOTE: If the request filter contains a parent.type
and parent.id
and
the caller has the resourcemanager.projects.list
permission on the
parent, the results will be drawn from an alternate index which provides
more consistent results. In future versions of this API, this List method
will be split into List and Search to properly capture the behavorial
difference.
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1194 def list_projects(filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/projects', ) command.response_representation = Google::Apis::CloudresourcemanagerV1::ListProjectsResponse::Representation command.response_class = Google::Apis::CloudresourcemanagerV1::ListProjectsResponse command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#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.
Search will only return organizations on which the user has the permission
resourcemanager.organizations.get
700 701 702 703 704 705 706 707 708 709 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 700 def search_organizations(search_organizations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/organizations:search', ) 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
.
248 249 250 251 252 253 254 255 256 257 258 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 248 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', ) 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".
Authorization requires the Google IAM permission
resourcemanager.organizations.setIamPolicy
on the specified organization
737 738 739 740 741 742 743 744 745 746 747 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 737 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', ) 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
.
773 774 775 776 777 778 779 780 781 782 783 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 773 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', ) 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. Overwrites
any existing policy.
The following constraints apply when using setIamPolicy()
:
- Project does not support
allUsers
andallAuthenticatedUsers
asmembers
in aBinding
of aPolicy
. - The owner role can be granted to a
user
,serviceAccount
, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. - 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. - You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization.
- Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected.
- If the project is not part of an organization, 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. - This method will replace the existing policy, and cannot be used to
append additional IAM settings.
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.
Authorization requires the Google IAM permission
resourcemanager.projects.setIamPolicy
on the project
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1331 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', ) 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
.
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1367 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', ) 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".
There are no permissions required for making this API call.
810 811 812 813 814 815 816 817 818 819 820 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 810 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', ) command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation command.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. There are no permissions required for making this API call.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1402 def (resource, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/projects/{resource}:testIamPermissions', ) command.request_representation = Google::Apis::CloudresourcemanagerV1::TestIamPermissionsRequest::Representation command.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.
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1441 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', ) 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.
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 |
# File 'generated/google/apis/cloudresourcemanager_v1/service.rb', line 1477 def update_project(project_id, project_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1/projects/{projectId}', ) 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 |