mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 05:43:43 +01:00
100 lines
49 KiB
HTML
100 lines
49 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_cloudresourcemanager1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudresourcemanager1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_cloudresourcemanager1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_cloudresourcemanager1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_cloudresourcemanager1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_cloudresourcemanager1/api.rs.html#1-12879" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.Ancestor.html" title="google_cloudresourcemanager1::api::Ancestor struct">Ancestor</a></td><td class="docblock-short"><p>Identifying information for a single ancestor of a project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditConfig.html" title="google_cloudresourcemanager1::api::AuditConfig struct">AuditConfig</a></td><td class="docblock-short"><p>Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both <code>allServices</code> and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditLogConfig.html" title="google_cloudresourcemanager1::api::AuditLogConfig struct">AuditLogConfig</a></td><td class="docblock-short"><p>Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_cloudresourcemanager1::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BooleanConstraint.html" title="google_cloudresourcemanager1::api::BooleanConstraint struct">BooleanConstraint</a></td><td class="docblock-short"><p>A <code>Constraint</code> that is either enforced or not. For example a constraint <code>constraints/compute.disableSerialPortAccess</code>. If it is enforced on a VM instance, serial port connections will not be opened to that instance.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BooleanPolicy.html" title="google_cloudresourcemanager1::api::BooleanPolicy struct">BooleanPolicy</a></td><td class="docblock-short"><p>Used in <code>policy_type</code> to specify how <code>boolean_policy</code> will behave at this resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ClearOrgPolicyRequest.html" title="google_cloudresourcemanager1::api::ClearOrgPolicyRequest struct">ClearOrgPolicyRequest</a></td><td class="docblock-short"><p>The request sent to the ClearOrgPolicy method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudResourceManager.html" title="google_cloudresourcemanager1::api::CloudResourceManager struct">CloudResourceManager</a></td><td class="docblock-short"><p>Central instance to access all CloudResourceManager related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Constraint.html" title="google_cloudresourcemanager1::api::Constraint struct">Constraint</a></td><td class="docblock-short"><p>A <code>Constraint</code> describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. <code>Constraints</code> can be configured by the organization's policy administrator to fit the needs of the organzation by setting Policies for <code>Constraints</code> at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about <a href="/resource-manager/reference/rest/v1/Policy">Policies</a>. <code>Constraints</code> have a default behavior determined by the <code>constraint_default</code> field, which is the enforcement behavior that is used in the absence of a <code>Policy</code> being defined or inherited for the resource in question.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_cloudresourcemanager1::api::Empty struct">Empty</a></td><td class="docblock-short"><p>A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for <code>Empty</code> is empty JSON object <code>{}</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_cloudresourcemanager1::api::Expr struct">Expr</a></td><td class="docblock-short"><p>Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderClearOrgPolicyCall.html" title="google_cloudresourcemanager1::api::FolderClearOrgPolicyCall struct">FolderClearOrgPolicyCall</a></td><td class="docblock-short"><p>Clears a <code>Policy</code> from a resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderGetEffectiveOrgPolicyCall.html" title="google_cloudresourcemanager1::api::FolderGetEffectiveOrgPolicyCall struct">FolderGetEffectiveOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderGetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::FolderGetOrgPolicyCall struct">FolderGetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderListAvailableOrgPolicyConstraintCall.html" title="google_cloudresourcemanager1::api::FolderListAvailableOrgPolicyConstraintCall struct">FolderListAvailableOrgPolicyConstraintCall</a></td><td class="docblock-short"><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderListOrgPolicyCall.html" title="google_cloudresourcemanager1::api::FolderListOrgPolicyCall struct">FolderListOrgPolicyCall</a></td><td class="docblock-short"><p>Lists all the <code>Policies</code> set for a particular resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderMethods.html" title="google_cloudresourcemanager1::api::FolderMethods struct">FolderMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>folder</em> resources.
|
||
It is not used directly, but through the <code>CloudResourceManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderSetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::FolderSetOrgPolicyCall struct">FolderSetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetAncestryRequest.html" title="google_cloudresourcemanager1::api::GetAncestryRequest struct">GetAncestryRequest</a></td><td class="docblock-short"><p>The request sent to the GetAncestry method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetAncestryResponse.html" title="google_cloudresourcemanager1::api::GetAncestryResponse struct">GetAncestryResponse</a></td><td class="docblock-short"><p>Response from the projects.getAncestry method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetEffectiveOrgPolicyRequest.html" title="google_cloudresourcemanager1::api::GetEffectiveOrgPolicyRequest struct">GetEffectiveOrgPolicyRequest</a></td><td class="docblock-short"><p>The request sent to the GetEffectiveOrgPolicy method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetIamPolicyRequest.html" title="google_cloudresourcemanager1::api::GetIamPolicyRequest struct">GetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>GetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetOrgPolicyRequest.html" title="google_cloudresourcemanager1::api::GetOrgPolicyRequest struct">GetOrgPolicyRequest</a></td><td class="docblock-short"><p>The request sent to the GetOrgPolicy method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetPolicyOptions.html" title="google_cloudresourcemanager1::api::GetPolicyOptions struct">GetPolicyOptions</a></td><td class="docblock-short"><p>Encapsulates settings provided to GetIamPolicy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Lien.html" title="google_cloudresourcemanager1::api::Lien struct">Lien</a></td><td class="docblock-short"><p>A Lien represents an encumbrance on the actions that can be performed on a resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LienCreateCall.html" title="google_cloudresourcemanager1::api::LienCreateCall struct">LienCreateCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LienDeleteCall.html" title="google_cloudresourcemanager1::api::LienDeleteCall struct">LienDeleteCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LienGetCall.html" title="google_cloudresourcemanager1::api::LienGetCall struct">LienGetCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LienListCall.html" title="google_cloudresourcemanager1::api::LienListCall struct">LienListCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LienMethods.html" title="google_cloudresourcemanager1::api::LienMethods struct">LienMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>lien</em> resources.
|
||
It is not used directly, but through the <code>CloudResourceManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListAvailableOrgPolicyConstraintsRequest.html" title="google_cloudresourcemanager1::api::ListAvailableOrgPolicyConstraintsRequest struct">ListAvailableOrgPolicyConstraintsRequest</a></td><td class="docblock-short"><p>The request sent to the <code>ListAvailableOrgPolicyConstraints</code> method on the project, folder, or organization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListAvailableOrgPolicyConstraintsResponse.html" title="google_cloudresourcemanager1::api::ListAvailableOrgPolicyConstraintsResponse struct">ListAvailableOrgPolicyConstraintsResponse</a></td><td class="docblock-short"><p>The response returned from the <code>ListAvailableOrgPolicyConstraints</code> method. Returns all <code>Constraints</code> that could be set at this level of the hierarchy (contrast with the response from <code>ListPolicies</code>, which returns all policies which are set).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListConstraint.html" title="google_cloudresourcemanager1::api::ListConstraint struct">ListConstraint</a></td><td class="docblock-short"><p>A <code>Constraint</code> that allows or disallows a list of string values, which are configured by an Organization's policy administrator with a <code>Policy</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLiensResponse.html" title="google_cloudresourcemanager1::api::ListLiensResponse struct">ListLiensResponse</a></td><td class="docblock-short"><p>The response message for Liens.ListLiens.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListOrgPoliciesRequest.html" title="google_cloudresourcemanager1::api::ListOrgPoliciesRequest struct">ListOrgPoliciesRequest</a></td><td class="docblock-short"><p>The request sent to the ListOrgPolicies method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListOrgPoliciesResponse.html" title="google_cloudresourcemanager1::api::ListOrgPoliciesResponse struct">ListOrgPoliciesResponse</a></td><td class="docblock-short"><p>The response returned from the <code>ListOrgPolicies</code> method. It will be empty if no <code>Policies</code> are set on the resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListPolicy.html" title="google_cloudresourcemanager1::api::ListPolicy struct">ListPolicy</a></td><td class="docblock-short"><p>Used in <code>policy_type</code> to specify how <code>list_policy</code> behaves at this resource. <code>ListPolicy</code> can define specific values and subtrees of Cloud Resource Manager resource hierarchy (<code>Organizations</code>, <code>Folders</code>, <code>Projects</code>) that are allowed or denied by setting the <code>allowed_values</code> and <code>denied_values</code> fields. This is achieved by using the <code>under:</code> and optional <code>is:</code> prefixes. The <code>under:</code> prefix is used to denote resource subtree values. The <code>is:</code> prefix is used to denote specific values, and is required only if the value contains a ":". Values prefixed with "is:" are treated the same as values with no prefix. Ancestry subtrees must be in one of the following formats: - "projects/", e.g. "projects/tokyo-rain-123" - "folders/", e.g. "folders/1234" - "organizations/", e.g. "organizations/1234" The <code>supports_under</code> field of the associated <code>Constraint</code> defines whether ancestry prefixes can be used. You can set <code>allowed_values</code> and <code>denied_values</code> in the same <code>Policy</code> if <code>all_values</code> is <code>ALL_VALUES_UNSPECIFIED</code>. <code>ALLOW</code> or <code>DENY</code> are used to allow or deny all values. If <code>all_values</code> is set to either <code>ALLOW</code> or <code>DENY</code>, <code>allowed_values</code> and <code>denied_values</code> must be unset.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListProjectsResponse.html" title="google_cloudresourcemanager1::api::ListProjectsResponse struct">ListProjectsResponse</a></td><td class="docblock-short"><p>A page of the response received from the ListProjects method. A paginated response where more pages are available has <code>next_page_token</code> set. This token can be used in a subsequent request to retrieve the next request page.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_cloudresourcemanager1::api::Operation struct">Operation</a></td><td class="docblock-short"><p>This resource represents a long-running operation that is the result of a network API call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationGetCall.html" title="google_cloudresourcemanager1::api::OperationGetCall struct">OperationGetCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationMethods.html" title="google_cloudresourcemanager1::api::OperationMethods struct">OperationMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>operation</em> resources.
|
||
It is not used directly, but through the <code>CloudResourceManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrgPolicy.html" title="google_cloudresourcemanager1::api::OrgPolicy struct">OrgPolicy</a></td><td class="docblock-short"><p>Defines a Cloud Organization <code>Policy</code> which is used to specify <code>Constraints</code> for configurations of Cloud Platform resources.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Organization.html" title="google_cloudresourcemanager1::api::Organization struct">Organization</a></td><td class="docblock-short"><p>The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationClearOrgPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationClearOrgPolicyCall struct">OrganizationClearOrgPolicyCall</a></td><td class="docblock-short"><p>Clears a <code>Policy</code> from a resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationGetCall.html" title="google_cloudresourcemanager1::api::OrganizationGetCall struct">OrganizationGetCall</a></td><td class="docblock-short"><p>Fetches an Organization resource identified by the specified resource name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationGetEffectiveOrgPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationGetEffectiveOrgPolicyCall struct">OrganizationGetEffectiveOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationGetIamPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationGetIamPolicyCall struct">OrganizationGetIamPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationGetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationGetOrgPolicyCall struct">OrganizationGetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationListAvailableOrgPolicyConstraintCall.html" title="google_cloudresourcemanager1::api::OrganizationListAvailableOrgPolicyConstraintCall struct">OrganizationListAvailableOrgPolicyConstraintCall</a></td><td class="docblock-short"><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationListOrgPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationListOrgPolicyCall struct">OrganizationListOrgPolicyCall</a></td><td class="docblock-short"><p>Lists all the <code>Policies</code> set for a particular resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationMethods.html" title="google_cloudresourcemanager1::api::OrganizationMethods struct">OrganizationMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>organization</em> resources.
|
||
It is not used directly, but through the <code>CloudResourceManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationOwner.html" title="google_cloudresourcemanager1::api::OrganizationOwner struct">OrganizationOwner</a></td><td class="docblock-short"><p>The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the <code>OrganizationOwner</code>. If the <code>OrganizationOwner</code> is deleted, the Organization and all its descendants will be deleted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationSearchCall.html" title="google_cloudresourcemanager1::api::OrganizationSearchCall struct">OrganizationSearchCall</a></td><td class="docblock-short"><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></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationSetIamPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationSetIamPolicyCall struct">OrganizationSetIamPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationSetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::OrganizationSetOrgPolicyCall struct">OrganizationSetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationTestIamPermissionCall.html" title="google_cloudresourcemanager1::api::OrganizationTestIamPermissionCall struct">OrganizationTestIamPermissionCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_cloudresourcemanager1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } <strong>YAML example:</strong> bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Project.html" title="google_cloudresourcemanager1::api::Project struct">Project</a></td><td class="docblock-short"><p>A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectClearOrgPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectClearOrgPolicyCall struct">ProjectClearOrgPolicyCall</a></td><td class="docblock-short"><p>Clears a <code>Policy</code> from a resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectCreateCall.html" title="google_cloudresourcemanager1::api::ProjectCreateCall struct">ProjectCreateCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDeleteCall.html" title="google_cloudresourcemanager1::api::ProjectDeleteCall struct">ProjectDeleteCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetAncestryCall.html" title="google_cloudresourcemanager1::api::ProjectGetAncestryCall struct">ProjectGetAncestryCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetCall.html" title="google_cloudresourcemanager1::api::ProjectGetCall struct">ProjectGetCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetEffectiveOrgPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectGetEffectiveOrgPolicyCall struct">ProjectGetEffectiveOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetIamPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectGetIamPolicyCall struct">ProjectGetIamPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectGetOrgPolicyCall struct">ProjectGetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectListAvailableOrgPolicyConstraintCall.html" title="google_cloudresourcemanager1::api::ProjectListAvailableOrgPolicyConstraintCall struct">ProjectListAvailableOrgPolicyConstraintCall</a></td><td class="docblock-short"><p>Lists <code>Constraints</code> that could be applied on the specified resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectListCall.html" title="google_cloudresourcemanager1::api::ProjectListCall struct">ProjectListCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectListOrgPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectListOrgPolicyCall struct">ProjectListOrgPolicyCall</a></td><td class="docblock-short"><p>Lists all the <code>Policies</code> set for a particular resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_cloudresourcemanager1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>CloudResourceManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSetIamPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectSetIamPolicyCall struct">ProjectSetIamPolicyCall</a></td><td class="docblock-short"><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 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 <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. Authorization requires the Google IAM permission <code>resourcemanager.projects.setIamPolicy</code> on the project</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSetOrgPolicyCall.html" title="google_cloudresourcemanager1::api::ProjectSetOrgPolicyCall struct">ProjectSetOrgPolicyCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTestIamPermissionCall.html" title="google_cloudresourcemanager1::api::ProjectTestIamPermissionCall struct">ProjectTestIamPermissionCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectUndeleteCall.html" title="google_cloudresourcemanager1::api::ProjectUndeleteCall struct">ProjectUndeleteCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectUpdateCall.html" title="google_cloudresourcemanager1::api::ProjectUpdateCall struct">ProjectUpdateCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResourceId.html" title="google_cloudresourcemanager1::api::ResourceId struct">ResourceId</a></td><td class="docblock-short"><p>A container to reference an id for any resource type. A <code>resource</code> in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RestoreDefault.html" title="google_cloudresourcemanager1::api::RestoreDefault struct">RestoreDefault</a></td><td class="docblock-short"><p>Ignores policies set above this resource and restores the <code>constraint_default</code> enforcement behavior of the specific <code>Constraint</code> at this resource. Suppose that <code>constraint_default</code> is set to <code>ALLOW</code> for the <code>Constraint</code> <code>constraints/serviceuser.services</code>. Suppose that organization foo.com sets a <code>Policy</code> at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a <code>Policy</code> with the <code>policy_type</code> <code>restore_default</code> on several experimental projects, restoring the <code>constraint_default</code> enforcement of the <code>Constraint</code> for only those projects, allowing those projects to have all services activated.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchOrganizationsRequest.html" title="google_cloudresourcemanager1::api::SearchOrganizationsRequest struct">SearchOrganizationsRequest</a></td><td class="docblock-short"><p>The request sent to the <code>SearchOrganizations</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchOrganizationsResponse.html" title="google_cloudresourcemanager1::api::SearchOrganizationsResponse struct">SearchOrganizationsResponse</a></td><td class="docblock-short"><p>The response returned from the <code>SearchOrganizations</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_cloudresourcemanager1::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetOrgPolicyRequest.html" title="google_cloudresourcemanager1::api::SetOrgPolicyRequest struct">SetOrgPolicyRequest</a></td><td class="docblock-short"><p>The request sent to the SetOrgPolicyRequest method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_cloudresourcemanager1::api::Status struct">Status</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_cloudresourcemanager1::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_cloudresourcemanager1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UndeleteProjectRequest.html" title="google_cloudresourcemanager1::api::UndeleteProjectRequest struct">UndeleteProjectRequest</a></td><td class="docblock-short"><p>The request sent to the UndeleteProject method.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_cloudresourcemanager1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_cloudresourcemanager1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |