Namespace Google.Apis.CloudResourceManager.v1
Classes
CloudResourceManagerBaseServiceRequest<TResponse>
A base abstract class for CloudResourceManager requests.
CloudResourceManagerService
The CloudResourceManager Service.
CloudResourceManagerService.Scope
Available OAuth 2.0 scopes for use with the Cloud Resource Manager API.
CloudResourceManagerService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Cloud Resource Manager API.
FoldersResource
The "folders" collection of methods.
FoldersResource.ClearOrgPolicyRequest
Clears a Policy
from a resource.
FoldersResource.GetEffectiveOrgPolicyRequest
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.
FoldersResource.GetOrgPolicyRequest
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.
FoldersResource.ListAvailableOrgPolicyConstraintsRequest
Lists Constraints
that could be applied on the specified resource.
FoldersResource.ListOrgPoliciesRequest
Lists all the Policies
set for a particular resource.
FoldersResource.SetOrgPolicyRequest
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
.
LiensResource
The "liens" collection of methods.
LiensResource.CreateRequest
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.
LiensResource.DeleteRequest
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
.
LiensResource.GetRequest
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 resourcemanager.projects.get
LiensResource.ListRequest
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
.
OperationsResource
The "operations" collection of methods.
OperationsResource.GetRequest
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.
OrganizationsResource
The "organizations" collection of methods.
OrganizationsResource.ClearOrgPolicyRequest
Clears a Policy
from a resource.
OrganizationsResource.GetEffectiveOrgPolicyRequest
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.
OrganizationsResource.GetIamPolicyRequest
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
OrganizationsResource.GetOrgPolicyRequest
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.
OrganizationsResource.GetRequest
Fetches an Organization resource identified by the specified resource name.
OrganizationsResource.ListAvailableOrgPolicyConstraintsRequest
Lists Constraints
that could be applied on the specified resource.
OrganizationsResource.ListOrgPoliciesRequest
Lists all the Policies
set for a particular resource.
OrganizationsResource.SearchRequest
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
OrganizationsResource.SetIamPolicyRequest
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
OrganizationsResource.SetOrgPolicyRequest
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
.
OrganizationsResource.TestIamPermissionsRequest
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.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.ClearOrgPolicyRequest
Clears a Policy
from a resource.
ProjectsResource.CreateRequest
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
]
(/billing/reference/rest/v1/projects/updateBillingInfo) method.
ProjectsResource.DeleteRequest
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 delete permissions for this Project.
ProjectsResource.GetAncestryRequest
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.
ProjectsResource.GetEffectiveOrgPolicyRequest
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.
ProjectsResource.GetIamPolicyRequest
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
(e.g.
my-project-id) structure and identification, see Resource
Names.
ProjectsResource.GetOrgPolicyRequest
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.
ProjectsResource.GetRequest
Retrieves the Project identified by the specified project_id
(for example, my-project-123
). The caller
must have read permissions for this Project.
ProjectsResource.ListAvailableOrgPolicyConstraintsRequest
Lists Constraints
that could be applied on the specified resource.
ProjectsResource.ListOrgPoliciesRequest
Lists all the Policies
set for a particular resource.
ProjectsResource.ListRequest
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 behavioral difference.
ProjectsResource.SetIamPolicyRequest
Sets the IAM access control policy for the specified Project. CAUTION: 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. For additional information about
resource
(e.g. my-project-id) structure and identification, see Resource
Names. The following constraints apply when using
setIamPolicy()
: + Project does not support allUsers
and allAuthenticatedUsers
as members
in a
Binding
of a Policy
. + The owner role can be granted 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. + 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. If the project is part of an
organization, you can remove all owners, potentially making the organization inaccessible. Authorization
requires the Google IAM permission resourcemanager.projects.setIamPolicy
on the project
ProjectsResource.SetOrgPolicyRequest
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
.
ProjectsResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified Project. For additional information about resource
(e.g. my-project-id) structure and identification, see Resource
Names. There are no permissions required for making
this API call.
ProjectsResource.UndeleteRequest
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 undelete permissions for this Project.
ProjectsResource.UpdateRequest
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.
Enums
CloudResourceManagerBaseServiceRequest<TResponse>.AltEnum
Data format for response.
CloudResourceManagerBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.