mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 05:12:45 +01:00
111 lines
51 KiB
HTML
111 lines
51 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_cloudresourcemanager3`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudresourcemanager3::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_cloudresourcemanager3/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_cloudresourcemanager3</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_cloudresourcemanager3</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_cloudresourcemanager3/api.rs.html#1-16727" 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.AuditConfig.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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.CloudResourceManager.html" title="google_cloudresourcemanager3::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.Empty.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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.Folder.html" title="google_cloudresourcemanager3::api::Folder struct">Folder</a></td><td class="docblock-short"><p>A folder in an organization's resource hierarchy, used to organize that organization's resources.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderCreateCall.html" title="google_cloudresourcemanager3::api::FolderCreateCall struct">FolderCreateCall</a></td><td class="docblock-short"><p>Creates a folder in the resource hierarchy. Returns an <code>Operation</code> which can be used to track the progress of the folder creation workflow. Upon success, the <code>Operation.response</code> field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder's <code>display_name</code> must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the <code>CreateFolder</code> request, with status code <code>FAILED_PRECONDITION</code> and an error description. Other folder constraint violations will be communicated in the <code>Operation</code>, with the specific <code>PreconditionFailure</code> returned in the details list in the <code>Operation.error</code> field. The caller must have <code>resourcemanager.folders.create</code> permission on the identified parent.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderDeleteCall.html" title="google_cloudresourcemanager3::api::FolderDeleteCall struct">FolderDeleteCall</a></td><td class="docblock-short"><p>Requests deletion of a folder. The folder is moved into the DELETE_REQUESTED state immediately, and is deleted approximately 30 days later. This method may only be called on an empty folder, where a folder is empty if it doesn't contain any folders or projects in the ACTIVE state. If called on a folder in DELETE_REQUESTED state the operation will result in a no-op success. The caller must have <code>resourcemanager.folders.delete</code> permission on the identified folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderGetCall.html" title="google_cloudresourcemanager3::api::FolderGetCall struct">FolderGetCall</a></td><td class="docblock-short"><p>Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format <code>folders/{folder_id}</code> (for example, <code>folders/1234</code>). The caller must have <code>resourcemanager.folders.get</code> permission on the identified folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderGetIamPolicyCall.html" title="google_cloudresourcemanager3::api::FolderGetIamPolicyCall struct">FolderGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a folder. The returned policy may be empty if no such policy or resource exists. The <code>resource</code> field should be the folder's resource name, for example: "folders/1234". The caller must have <code>resourcemanager.folders.getIamPolicy</code> permission on the identified folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderListCall.html" title="google_cloudresourcemanager3::api::FolderListCall struct">FolderListCall</a></td><td class="docblock-short"><p>Lists the folders that are direct descendants of supplied parent resource. <code>list()</code> provides a strongly consistent view of the folders underneath the specified parent resource. <code>list()</code> returns folders sorted based upon the (ascending) lexical ordering of their display_name. The caller must have <code>resourcemanager.folders.list</code> permission on the identified parent.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderMethods.html" title="google_cloudresourcemanager3::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.FolderMoveCall.html" title="google_cloudresourcemanager3::api::FolderMoveCall struct">FolderMoveCall</a></td><td class="docblock-short"><p>Moves a folder under a new resource parent. Returns an <code>Operation</code> which can be used to track the progress of the folder move workflow. Upon success, the <code>Operation.response</code> field will be populated with the moved folder. Upon failure, a <code>FolderOperationError</code> categorizing the failure cause will be returned - if the failure occurs synchronously then the <code>FolderOperationError</code> will be returned in the <code>Status.details</code> field. If it occurs asynchronously, then the FolderOperation will be returned in the <code>Operation.error</code> field. In addition, the <code>Operation.metadata</code> field will be populated with a <code>FolderOperation</code> message as an aid to stateless clients. Folder moves will be rejected if they violate either the naming, height, or fanout constraints described in the CreateFolder documentation. The caller must have <code>resourcemanager.folders.move</code> permission on the folder's current and proposed new parent.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderPatchCall.html" title="google_cloudresourcemanager3::api::FolderPatchCall struct">FolderPatchCall</a></td><td class="docblock-short"><p>Updates a folder, changing its <code>display_name</code>. Changes to the folder <code>display_name</code> will be rejected if they violate either the <code>display_name</code> formatting rules or the naming constraints described in the CreateFolder documentation. The folder's <code>display_name</code> must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: <code>\p{L}\p{N}{1,28}[\p{L}\p{N}]</code>. The caller must have <code>resourcemanager.folders.update</code> permission on the identified folder. If the update fails due to the unique name constraint then a <code>PreconditionFailure</code> explaining this violation will be returned in the Status.details field.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderSearchCall.html" title="google_cloudresourcemanager3::api::FolderSearchCall struct">FolderSearchCall</a></td><td class="docblock-short"><p>Search for folders that match specific filter criteria. <code>search()</code> provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission <code>resourcemanager.folders.get</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderSetIamPolicyCall.html" title="google_cloudresourcemanager3::api::FolderSetIamPolicyCall struct">FolderSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on a folder, replacing any existing policy. The <code>resource</code> field should be the folder's resource name, for example: "folders/1234". The caller must have <code>resourcemanager.folders.setIamPolicy</code> permission on the identified folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderTestIamPermissionCall.html" title="google_cloudresourcemanager3::api::FolderTestIamPermissionCall struct">FolderTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified folder. The <code>resource</code> field should be the folder's resource name, for example: "folders/1234". There are no permissions required for making this API call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FolderUndeleteCall.html" title="google_cloudresourcemanager3::api::FolderUndeleteCall struct">FolderUndeleteCall</a></td><td class="docblock-short"><p>Cancels the deletion request for a folder. This method may be called on a folder in any state. If the folder is in the ACTIVE state the result will be a no-op success. In order to succeed, the folder's parent must be in the ACTIVE state. In addition, reintroducing the folder into the tree must not violate folder naming, height, and fanout constraints described in the CreateFolder documentation. The caller must have <code>resourcemanager.folders.undelete</code> permission on the identified folder.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetIamPolicyRequest.html" title="google_cloudresourcemanager3::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.GetPolicyOptions.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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.ListFoldersResponse.html" title="google_cloudresourcemanager3::api::ListFoldersResponse struct">ListFoldersResponse</a></td><td class="docblock-short"><p>The ListFolders response message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLiensResponse.html" title="google_cloudresourcemanager3::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.ListProjectsResponse.html" title="google_cloudresourcemanager3::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. NOTE: A response may contain fewer elements than the request <code>page_size</code> and still have a <code>next_page_token</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTagBindingsResponse.html" title="google_cloudresourcemanager3::api::ListTagBindingsResponse struct">ListTagBindingsResponse</a></td><td class="docblock-short"><p>The ListTagBindings response.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTagKeysResponse.html" title="google_cloudresourcemanager3::api::ListTagKeysResponse struct">ListTagKeysResponse</a></td><td class="docblock-short"><p>The ListTagKeys response message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTagValuesResponse.html" title="google_cloudresourcemanager3::api::ListTagValuesResponse struct">ListTagValuesResponse</a></td><td class="docblock-short"><p>The ListTagValues response.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MoveFolderRequest.html" title="google_cloudresourcemanager3::api::MoveFolderRequest struct">MoveFolderRequest</a></td><td class="docblock-short"><p>The MoveFolder request message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MoveProjectRequest.html" title="google_cloudresourcemanager3::api::MoveProjectRequest struct">MoveProjectRequest</a></td><td class="docblock-short"><p>The request sent to MoveProject method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3::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.Organization.html" title="google_cloudresourcemanager3::api::Organization struct">Organization</a></td><td class="docblock-short"><p>The root node in the resource hierarchy to which a particular entity's (a company, for example) resources belong.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationGetCall.html" title="google_cloudresourcemanager3::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.OrganizationGetIamPolicyCall.html" title="google_cloudresourcemanager3::api::OrganizationGetIamPolicyCall struct">OrganizationGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for an organization resource. The policy may be empty if no such policy or resource exists. The <code>resource</code> field should be the organization's resource name, for example: "organizations/123". Authorization requires the IAM permission <code>resourcemanager.organizations.getIamPolicy</code> on the specified organization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationMethods.html" title="google_cloudresourcemanager3::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.OrganizationSearchCall.html" title="google_cloudresourcemanager3::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, and may take a small amount of time to appear. 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_cloudresourcemanager3::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, for example: "organizations/123". Authorization requires the IAM permission <code>resourcemanager.organizations.setIamPolicy</code> on the specified organization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OrganizationTestIamPermissionCall.html" title="google_cloudresourcemanager3::api::OrganizationTestIamPermissionCall struct">OrganizationTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns the permissions that a caller has on the specified organization. The <code>resource</code> field should be the organization's resource name, for example: "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_cloudresourcemanager3::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_cloudresourcemanager3::api::Project struct">Project</a></td><td class="docblock-short"><p>A project is a high-level Google Cloud 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.ProjectCreateCall.html" title="google_cloudresourcemanager3::api::ProjectCreateCall struct">ProjectCreateCall</a></td><td class="docblock-short"><p>Request that a new project be created. The result is an <code>Operation</code> which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking <code>Operation</code> is automatically deleted after a few hours, so there is no need to call <code>DeleteOperation</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDeleteCall.html" title="google_cloudresourcemanager3::api::ProjectDeleteCall struct">ProjectDeleteCall</a></td><td class="docblock-short"><p>Marks the project identified by the specified <code>name</code> (for example, <code>projects/415104041262</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, ListProjects, and SearchProjects methods. This method behaves idempotently, such that deleting a <code>DELETE_REQUESTED</code> project will not cause an error, but also won't do anything. The caller must have <code>resourcemanager.projects.delete</code> permissions for this project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetCall.html" title="google_cloudresourcemanager3::api::ProjectGetCall struct">ProjectGetCall</a></td><td class="docblock-short"><p>Retrieves the project identified by the specified <code>name</code> (for example, <code>projects/415104041262</code>). The caller must have <code>resourcemanager.projects.get</code> permission for this project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectGetIamPolicyCall.html" title="google_cloudresourcemanager3::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 do not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectListCall.html" title="google_cloudresourcemanager3::api::ProjectListCall struct">ProjectListCall</a></td><td class="docblock-short"><p>Lists projects that are direct children of the specified folder or organization resource. <code>list()</code> provides a strongly consistent view of the projects underneath the specified parent resource. <code>list()</code> returns projects sorted based upon the (ascending) lexical ordering of their <code>display_name</code>. The caller must have <code>resourcemanager.projects.list</code> permission on the identified parent.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_cloudresourcemanager3::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.ProjectMoveCall.html" title="google_cloudresourcemanager3::api::ProjectMoveCall struct">ProjectMoveCall</a></td><td class="docblock-short"><p>Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the <code>Operation.response</code> field will be populated with the moved project. The caller must have <code>resourcemanager.projects.update</code> permission on the project and have <code>resourcemanager.projects.move</code> permission on the project's current and proposed new parent. </p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectPatchCall.html" title="google_cloudresourcemanager3::api::ProjectPatchCall struct">ProjectPatchCall</a></td><td class="docblock-short"><p>Updates the <code>display_name</code> and labels of the project identified by the specified <code>name</code> (for example, <code>projects/415104041262</code>). Deleting all labels requires an update mask for labels field. The caller must have <code>resourcemanager.projects.update</code> permission for this project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSearchCall.html" title="google_cloudresourcemanager3::api::ProjectSearchCall struct">ProjectSearchCall</a></td><td class="docblock-short"><p>Search for projects that the caller has both <code>resourcemanager.projects.get</code> permission on, and also satisfy the specified query. 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectSetIamPolicyCall.html" title="google_cloudresourcemanager3::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. 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 using the 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. + Invitations to grant the owner role cannot be sent using <code>setIamPolicy()</code>; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + 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. + Calling this method requires enabling the App Engine Admin API.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectTestIamPermissionCall.html" title="google_cloudresourcemanager3::api::ProjectTestIamPermissionCall struct">ProjectTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectUndeleteCall.html" title="google_cloudresourcemanager3::api::ProjectUndeleteCall struct">ProjectUndeleteCall</a></td><td class="docblock-short"><p>Restores the project identified by the specified <code>name</code> (for example, <code>projects/415104041262</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 <code>resourcemanager.projects.undelete</code> permission for this project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchFoldersResponse.html" title="google_cloudresourcemanager3::api::SearchFoldersResponse struct">SearchFoldersResponse</a></td><td class="docblock-short"><p>The response message for searching folders.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchOrganizationsResponse.html" title="google_cloudresourcemanager3::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.SearchProjectsResponse.html" title="google_cloudresourcemanager3::api::SearchProjectsResponse struct">SearchProjectsResponse</a></td><td class="docblock-short"><p>A page of the response received from the SearchProjects 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.SetIamPolicyRequest.html" title="google_cloudresourcemanager3::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.Status.html" title="google_cloudresourcemanager3::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.TagBinding.html" title="google_cloudresourcemanager3::api::TagBinding struct">TagBinding</a></td><td class="docblock-short"><p>A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagBindingCreateCall.html" title="google_cloudresourcemanager3::api::TagBindingCreateCall struct">TagBindingCreateCall</a></td><td class="docblock-short"><p>Creates a TagBinding between a TagValue and a cloud resource (currently project, folder, or organization).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagBindingDeleteCall.html" title="google_cloudresourcemanager3::api::TagBindingDeleteCall struct">TagBindingDeleteCall</a></td><td class="docblock-short"><p>Deletes a TagBinding.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagBindingListCall.html" title="google_cloudresourcemanager3::api::TagBindingListCall struct">TagBindingListCall</a></td><td class="docblock-short"><p>Lists the TagBindings for the given cloud resource, as specified with <code>parent</code>. NOTE: The <code>parent</code> field is expected to be a full resource name: https://cloud.google.com/apis/design/resource_names#full_resource_name</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagBindingMethods.html" title="google_cloudresourcemanager3::api::TagBindingMethods struct">TagBindingMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>tagBinding</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.TagKey.html" title="google_cloudresourcemanager3::api::TagKey struct">TagKey</a></td><td class="docblock-short"><p>A TagKey, used to group a set of TagValues.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyCreateCall.html" title="google_cloudresourcemanager3::api::TagKeyCreateCall struct">TagKeyCreateCall</a></td><td class="docblock-short"><p>Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 300 TagKeys can exist under a parent at any given time.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyDeleteCall.html" title="google_cloudresourcemanager3::api::TagKeyDeleteCall struct">TagKeyDeleteCall</a></td><td class="docblock-short"><p>Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyGetCall.html" title="google_cloudresourcemanager3::api::TagKeyGetCall struct">TagKeyGetCall</a></td><td class="docblock-short"><p>Retrieves a TagKey. This method will return <code>PERMISSION_DENIED</code> if the key does not exist or the user does not have permission to view it.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyGetIamPolicyCall.html" title="google_cloudresourcemanager3::api::TagKeyGetIamPolicyCall struct">TagKeyGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The <code>resource</code> field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have <code>cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy</code> permission on the specified TagKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyListCall.html" title="google_cloudresourcemanager3::api::TagKeyListCall struct">TagKeyListCall</a></td><td class="docblock-short"><p>Lists all TagKeys for a parent resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyMethods.html" title="google_cloudresourcemanager3::api::TagKeyMethods struct">TagKeyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>tagKey</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.TagKeyPatchCall.html" title="google_cloudresourcemanager3::api::TagKeyPatchCall struct">TagKeyPatchCall</a></td><td class="docblock-short"><p>Updates the attributes of the TagKey resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeySetIamPolicyCall.html" title="google_cloudresourcemanager3::api::TagKeySetIamPolicyCall struct">TagKeySetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on a TagKey, replacing any existing policy. The <code>resource</code> field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have <code>resourcemanager.tagKeys.setIamPolicy</code> permission on the identified tagValue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagKeyTestIamPermissionCall.html" title="google_cloudresourcemanager3::api::TagKeyTestIamPermissionCall struct">TagKeyTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified TagKey. The <code>resource</code> field should be the TagKey's resource name. For example, "tagKeys/1234". There are no permissions required for making this API call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValue.html" title="google_cloudresourcemanager3::api::TagValue struct">TagValue</a></td><td class="docblock-short"><p>A TagValue is a child of a particular TagKey. This is used to group cloud resources for the purpose of controlling them using policies.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueCreateCall.html" title="google_cloudresourcemanager3::api::TagValueCreateCall struct">TagValueCreateCall</a></td><td class="docblock-short"><p>Creates a TagValue as a child of the specified TagKey. If a another request with the same parameters is sent while the original request is in process the second request will receive an error. A maximum of 300 TagValues can exist under a TagKey at any given time.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueDeleteCall.html" title="google_cloudresourcemanager3::api::TagValueDeleteCall struct">TagValueDeleteCall</a></td><td class="docblock-short"><p>Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueGetCall.html" title="google_cloudresourcemanager3::api::TagValueGetCall struct">TagValueGetCall</a></td><td class="docblock-short"><p>Retrieves TagValue. If the TagValue or namespaced name does not exist, or if the user does not have permission to view it, this method will return <code>PERMISSION_DENIED</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueGetIamPolicyCall.html" title="google_cloudresourcemanager3::api::TagValueGetIamPolicyCall struct">TagValueGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The <code>resource</code> field should be the TagValue's resource name. For example: <code>tagValues/1234</code>. The caller must have the <code>cloudresourcemanager.googleapis.com/tagValues.getIamPolicy</code> permission on the identified TagValue to get the access control policy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueListCall.html" title="google_cloudresourcemanager3::api::TagValueListCall struct">TagValueListCall</a></td><td class="docblock-short"><p>Lists all TagValues for a specific TagKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueMethods.html" title="google_cloudresourcemanager3::api::TagValueMethods struct">TagValueMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>tagValue</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.TagValuePatchCall.html" title="google_cloudresourcemanager3::api::TagValuePatchCall struct">TagValuePatchCall</a></td><td class="docblock-short"><p>Updates the attributes of the TagValue resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueSetIamPolicyCall.html" title="google_cloudresourcemanager3::api::TagValueSetIamPolicyCall struct">TagValueSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on a TagValue, replacing any existing policy. The <code>resource</code> field should be the TagValue's resource name. For example: <code>tagValues/1234</code>. The caller must have <code>resourcemanager.tagValues.setIamPolicy</code> permission on the identified tagValue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TagValueTestIamPermissionCall.html" title="google_cloudresourcemanager3::api::TagValueTestIamPermissionCall struct">TagValueTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified TagValue. The <code>resource</code> field should be the TagValue's resource name. For example: <code>tagValues/1234</code>. There are no permissions required for making this API call.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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.UndeleteFolderRequest.html" title="google_cloudresourcemanager3::api::UndeleteFolderRequest struct">UndeleteFolderRequest</a></td><td class="docblock-short"><p>The UndeleteFolder request message.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UndeleteProjectRequest.html" title="google_cloudresourcemanager3::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_cloudresourcemanager3::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_cloudresourcemanager3"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |