CINXE.COM

<!DOCTYPE html>  <html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <title>Namespace Google.Apis.CloudResourceManager.v1 | Google.Apis.CloudResourceManager.v1 </title> <meta name="viewport" content="width=device-width"> <meta name="title" content="Namespace Google.Apis.CloudResourceManager.v1 | Google.Apis.CloudResourceManager.v1 "> <link rel="shortcut icon" href="../favicon.ico"> <link rel="stylesheet" href="../styles/docfx.vendor.min.css"> <link rel="stylesheet" href="../styles/docfx.css"> <link rel="stylesheet" href="../styles/main.css"> <meta property="docfx:navrel" content=""> <meta property="docfx:tocrel" content="toc.html"> </head> <body data-spy="scroll" data-target="#affix" data-offset="120"> <div id="wrapper"> <header> <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="../index.html"> <img id="logo" class="svg" src="../logo.svg" alt=""> </a> </div> <div class="collapse navbar-collapse" id="navbar"> <form class="navbar-form navbar-right" role="search" id="search"> <div class="form-group"> <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> </div> </form> </div> </div> </nav> <div class="subnav navbar navbar-default"> <div class="container hide-when-search" id="breadcrumb"> <ul class="breadcrumb"> <li></li> </ul> </div> </div> </header> <div role="main" class="container body-content hide-when-search"> <div class="sidenav hide-when-search"> <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> <div class="sidetoggle collapse" id="sidetoggle"> <div id="sidetoc"></div> </div> </div> <div class="article row grid-right"> <div class="col-md-10"> <article class="content wrap" id="_content" data-uid="Google.Apis.CloudResourceManager.v1"> <h1 id="Google_Apis_CloudResourceManager_v1" data-uid="Google.Apis.CloudResourceManager.v1" class="text-break">Namespace Google.Apis.CloudResourceManager.v1 </h1> <div class="markdown level0 summary"></div> <div class="markdown level0 conceptual"></div> <div class="markdown level0 remarks"></div> <h3 id="classes"> Classes </h3> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerBaseServiceRequest-1.html">CloudResourceManagerBaseServiceRequest<TResponse></a></h4> <section><p>A base abstract class for CloudResourceManager requests.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerService.html">CloudResourceManagerService</a></h4> <section><p>The CloudResourceManager Service.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerService.Scope.html">CloudResourceManagerService.Scope</a></h4> <section><p>Available OAuth 2.0 scopes for use with the Cloud Resource Manager API.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerService.ScopeConstants.html">CloudResourceManagerService.ScopeConstants</a></h4> <section><p>Available OAuth 2.0 scope constants for use with the Cloud Resource Manager API.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.html">FoldersResource</a></h4> <section><p>The "folders" collection of methods.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.ClearOrgPolicyRequest.html">FoldersResource.ClearOrgPolicyRequest</a></h4> <section><p>Clears a <code>Policy</code> from a resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.GetEffectiveOrgPolicyRequest.html">FoldersResource.GetEffectiveOrgPolicyRequest</a></h4> <section><p>Gets the effective <code>Policy</code> on a resource. This is the result of merging <code>Policies</code> in the resource hierarchy. The returned <code>Policy</code> will not have an <code>etag</code>set because it is a computed <code>Policy</code> across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.GetOrgPolicyRequest.html">FoldersResource.GetOrgPolicyRequest</a></h4> <section><p>Gets a <code>Policy</code> on a resource. If no <code>Policy</code> is set on the resource, a <code>Policy</code> is returned with default values including <code>POLICY_TYPE_NOT_SET</code> for the <code>policy_type oneof</code>. The <code>etag</code> value can be used with <code>SetOrgPolicy()</code> to create or update a <code>Policy</code> during read-modify-write.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.ListAvailableOrgPolicyConstraintsRequest.html">FoldersResource.ListAvailableOrgPolicyConstraintsRequest</a></h4> <section><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.ListOrgPoliciesRequest.html">FoldersResource.ListOrgPoliciesRequest</a></h4> <section><p>Lists all the <code>Policies</code> set for a particular resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.FoldersResource.SetOrgPolicyRequest.html">FoldersResource.SetOrgPolicyRequest</a></h4> <section><p>Updates the specified <code>Policy</code> on the resource. Creates a new <code>Policy</code> for that <code>Constraint</code> on the resource if one does not exist. Not supplying an <code>etag</code> on the request <code>Policy</code> results in an unconditional write of the <code>Policy</code>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.LiensResource.html">LiensResource</a></h4> <section><p>The "liens" collection of methods.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.LiensResource.CreateRequest.html">LiensResource.CreateRequest</a></h4> <section><p>Create a Lien which applies to the resource denoted by the <code>parent</code> field. Callers of this method will require permission on the <code>parent</code> resource. For example, applying to <code>projects/1234</code> requires permission <code>resourcemanager.projects.updateLiens</code>. NOTE: Some resources may limit the number of Liens which may be applied.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.LiensResource.DeleteRequest.html">LiensResource.DeleteRequest</a></h4> <section><p>Delete a Lien by <code>name</code>. Callers of this method will require permission on the <code>parent</code> resource. For example, a Lien with a <code>parent</code> of <code>projects/1234</code> requires permission <code>resourcemanager.projects.updateLiens</code>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.LiensResource.GetRequest.html">LiensResource.GetRequest</a></h4> <section><p>Retrieve a Lien by <code>name</code>. Callers of this method will require permission on the <code>parent</code> resource. For example, a Lien with a <code>parent</code> of <code>projects/1234</code> requires permission <code>resourcemanager.projects.get</code></p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.LiensResource.ListRequest.html">LiensResource.ListRequest</a></h4> <section><p>List all Liens applied to the <code>parent</code> resource. Callers of this method will require permission on the <code>parent</code> resource. For example, a Lien with a <code>parent</code> of <code>projects/1234</code> requires permission <code>resourcemanager.projects.get</code>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OperationsResource.html">OperationsResource</a></h4> <section><p>The "operations" collection of methods.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OperationsResource.GetRequest.html">OperationsResource.GetRequest</a></h4> <section><p>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.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.html">OrganizationsResource</a></h4> <section><p>The "organizations" collection of methods.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.ClearOrgPolicyRequest.html">OrganizationsResource.ClearOrgPolicyRequest</a></h4> <section><p>Clears a <code>Policy</code> from a resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.GetEffectiveOrgPolicyRequest.html">OrganizationsResource.GetEffectiveOrgPolicyRequest</a></h4> <section><p>Gets the effective <code>Policy</code> on a resource. This is the result of merging <code>Policies</code> in the resource hierarchy. The returned <code>Policy</code> will not have an <code>etag</code>set because it is a computed <code>Policy</code> across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.GetIamPolicyRequest.html">OrganizationsResource.GetIamPolicyRequest</a></h4> <section><p>Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The <code>resource</code> field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission <code>resourcemanager.organizations.getIamPolicy</code> on the specified organization</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.GetOrgPolicyRequest.html">OrganizationsResource.GetOrgPolicyRequest</a></h4> <section><p>Gets a <code>Policy</code> on a resource. If no <code>Policy</code> is set on the resource, a <code>Policy</code> is returned with default values including <code>POLICY_TYPE_NOT_SET</code> for the <code>policy_type oneof</code>. The <code>etag</code> value can be used with <code>SetOrgPolicy()</code> to create or update a <code>Policy</code> during read-modify-write.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.GetRequest.html">OrganizationsResource.GetRequest</a></h4> <section><p>Fetches an Organization resource identified by the specified resource name.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.ListAvailableOrgPolicyConstraintsRequest.html">OrganizationsResource.ListAvailableOrgPolicyConstraintsRequest</a></h4> <section><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.ListOrgPoliciesRequest.html">OrganizationsResource.ListOrgPoliciesRequest</a></h4> <section><p>Lists all the <code>Policies</code> set for a particular resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.SearchRequest.html">OrganizationsResource.SearchRequest</a></h4> <section><p>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 <code>resourcemanager.organizations.get</code> or has super admin privileges.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.SetIamPolicyRequest.html">OrganizationsResource.SetIamPolicyRequest</a></h4> <section><p>Sets the access control policy on an Organization resource. Replaces any existing policy. The <code>resource</code> field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission <code>resourcemanager.organizations.setIamPolicy</code> on the specified organization</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.SetOrgPolicyRequest.html">OrganizationsResource.SetOrgPolicyRequest</a></h4> <section><p>Updates the specified <code>Policy</code> on the resource. Creates a new <code>Policy</code> for that <code>Constraint</code> on the resource if one does not exist. Not supplying an <code>etag</code> on the request <code>Policy</code> results in an unconditional write of the <code>Policy</code>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.OrganizationsResource.TestIamPermissionsRequest.html">OrganizationsResource.TestIamPermissionsRequest</a></h4> <section><p>Returns permissions that a caller has on the specified Organization. The <code>resource</code> field should be the organization's resource name, e.g. "organizations/123". There are no permissions required for making this API call.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.html">ProjectsResource</a></h4> <section><p>The "projects" collection of methods.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.ClearOrgPolicyRequest.html">ProjectsResource.ClearOrgPolicyRequest</a></h4> <section><p>Clears a <code>Policy</code> from a resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.CreateRequest.html">ProjectsResource.CreateRequest</a></h4> <section><p>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 <code>resourcemanager.projects.create</code> 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 [<code>projects.updateBillingInfo</code>] (/billing/reference/rest/v1/projects/updateBillingInfo) method.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.DeleteRequest.html">ProjectsResource.DeleteRequest</a></h4> <section><p>Marks the Project identified by the specified <code>project_id</code> (for example, <code>my-project-123</code>) 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.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.GetAncestryRequest.html">ProjectsResource.GetAncestryRequest</a></h4> <section><p>Gets a list of ancestors in the resource hierarchy for the Project identified by the specified <code>project_id</code> (for example, <code>my-project-123</code>). The caller must have read permissions for this Project.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.GetEffectiveOrgPolicyRequest.html">ProjectsResource.GetEffectiveOrgPolicyRequest</a></h4> <section><p>Gets the effective <code>Policy</code> on a resource. This is the result of merging <code>Policies</code> in the resource hierarchy. The returned <code>Policy</code> will not have an <code>etag</code>set because it is a computed <code>Policy</code> across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.GetIamPolicyRequest.html">ProjectsResource.GetIamPolicyRequest</a></h4> <section><p>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 <code>resourcemanager.projects.getIamPolicy</code> on the project. For additional information about <code>resource</code> (e.g. my-project-id) structure and identification, see <a href="https://cloud.google.com/apis/design/resource_names">Resource Names</a>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.GetOrgPolicyRequest.html">ProjectsResource.GetOrgPolicyRequest</a></h4> <section><p>Gets a <code>Policy</code> on a resource. If no <code>Policy</code> is set on the resource, a <code>Policy</code> is returned with default values including <code>POLICY_TYPE_NOT_SET</code> for the <code>policy_type oneof</code>. The <code>etag</code> value can be used with <code>SetOrgPolicy()</code> to create or update a <code>Policy</code> during read-modify-write.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.GetRequest.html">ProjectsResource.GetRequest</a></h4> <section><p>Retrieves the Project identified by the specified <code>project_id</code> (for example, <code>my-project-123</code>). The caller must have read permissions for this Project.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.ListAvailableOrgPolicyConstraintsRequest.html">ProjectsResource.ListAvailableOrgPolicyConstraintsRequest</a></h4> <section><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.ListOrgPoliciesRequest.html">ProjectsResource.ListOrgPoliciesRequest</a></h4> <section><p>Lists all the <code>Policies</code> set for a particular resource.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.ListRequest.html">ProjectsResource.ListRequest</a></h4> <section><p>Lists Projects that the caller has the <code>resourcemanager.projects.get</code> 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 <code>parent.type</code> and <code>parent.id</code> and the caller has the <code>resourcemanager.projects.list</code> 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.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.SetIamPolicyRequest.html">ProjectsResource.SetIamPolicyRequest</a></h4> <section><p>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 <code>resource</code> (e.g. my-project-id) structure and identification, see <a href="https://cloud.google.com/apis/design/resource_names">Resource Names</a>. The following constraints apply when using <code>setIamPolicy()</code>: + Project does not support <code>allUsers</code> and <code>allAuthenticatedUsers</code> as <code>members</code> in a <code>Binding</code> of a <code>Policy</code>. + The owner role can be granted to a <code>user</code>, <code>serviceAccount</code>, 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 <code>setIamPolicy()</code>. 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 Google Cloud 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 <code>setIamPolicy()</code> 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 <code>resourcemanager.projects.setIamPolicy</code> on the project</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.SetOrgPolicyRequest.html">ProjectsResource.SetOrgPolicyRequest</a></h4> <section><p>Updates the specified <code>Policy</code> on the resource. Creates a new <code>Policy</code> for that <code>Constraint</code> on the resource if one does not exist. Not supplying an <code>etag</code> on the request <code>Policy</code> results in an unconditional write of the <code>Policy</code>.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.TestIamPermissionsRequest.html">ProjectsResource.TestIamPermissionsRequest</a></h4> <section><p>Returns permissions that a caller has on the specified Project. For additional information about <code>resource</code> (e.g. my-project-id) structure and identification, see <a href="https://cloud.google.com/apis/design/resource_names">Resource Names</a>. There are no permissions required for making this API call.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.UndeleteRequest.html">ProjectsResource.UndeleteRequest</a></h4> <section><p>Restores the Project identified by the specified <code>project_id</code> (for example, <code>my-project-123</code>). 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.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.ProjectsResource.UpdateRequest.html">ProjectsResource.UpdateRequest</a></h4> <section><p>Updates the attributes of the Project identified by the specified <code>project_id</code> (for example, <code>my-project-123</code>). The caller must have modify permissions for this Project.</p> </section> <h3 id="enums"> Enums </h3> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerBaseServiceRequest-1.AltEnum.html">CloudResourceManagerBaseServiceRequest<TResponse>.AltEnum</a></h4> <section><p>Data format for response.</p> </section> <h4><a class="xref" href="Google.Apis.CloudResourceManager.v1.CloudResourceManagerBaseServiceRequest-1.XgafvEnum.html">CloudResourceManagerBaseServiceRequest<TResponse>.XgafvEnum</a></h4> <section><p>V1 error format.</p> </section> </article> </div> <div class="hidden-sm col-md-2" role="complementary"> <div class="sideaffix"> <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> <h5>In this article</h5> <div></div> </nav> </div> </div> </div> </div> <footer> <div class="grad-bottom"></div> <div class="footer"> <div class="container"> <span class="pull-right"> <a href="#top">Back to top</a> </span> <span>Generated by <strong>DocFX</strong></span> </div> </div> </footer> </div> <script type="text/javascript" src="../styles/docfx.vendor.min.js"></script> <script type="text/javascript" src="../styles/docfx.js"></script> <script type="text/javascript" src="../styles/main.js"></script> <script src="/yoshi.js"></script> </body> </html>