mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 12:51:55 +01:00
45 lines
23 KiB
HTML
45 lines
23 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_cloudresourcemanager2`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudresourcemanager2::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_cloudresourcemanager2/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_cloudresourcemanager2</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_cloudresourcemanager2</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_cloudresourcemanager2/api.rs.html#1-4256" 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_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::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.Expr.html" title="google_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::api::FolderCreateCall struct">FolderCreateCall</a></td><td class="docblock-short"><p>Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response 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 display_name 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 CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error 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_cloudresourcemanager2::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 in the ACTIVE state, where a Folder is empty if it doesn't contain any Folders or Projects in the ACTIVE state. 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_cloudresourcemanager2::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_cloudresourcemanager2::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, e.g. "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_cloudresourcemanager2::api::FolderListCall struct">FolderListCall</a></td><td class="docblock-short"><p>Lists the Folders that are direct descendants of supplied parent resource. List provides a strongly consistent view of the Folders underneath the specified parent resource. List 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_cloudresourcemanager2::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_cloudresourcemanager2::api::FolderMoveCall struct">FolderMoveCall</a></td><td class="docblock-short"><p>Moves a Folder under a new resource parent. Returns an Operation which can be used to track the progress of the folder move workflow. Upon success the Operation.response field will be populated with the moved Folder. Upon failure, a FolderOperationError categorizing the failure cause will be returned - if the failure occurs synchronously then the FolderOperationError will be returned via the Status.details field and if it occurs asynchronously then the FolderOperation will be returned via the Operation.error field. In addition, the Operation.metadata field will be populated with a FolderOperation 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_cloudresourcemanager2::api::FolderPatchCall struct">FolderPatchCall</a></td><td class="docblock-short"><p>Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name 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 PreconditionFailure 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_cloudresourcemanager2::api::FolderSearchCall struct">FolderSearchCall</a></td><td class="docblock-short"><p>Search for folders that match specific filter criteria. Search 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_cloudresourcemanager2::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, e.g. "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_cloudresourcemanager2::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, e.g. "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_cloudresourcemanager2::api::FolderUndeleteCall struct">FolderUndeleteCall</a></td><td class="docblock-short"><p>Cancels the deletion request for a Folder. This method may only be called on a Folder in the DELETE_REQUESTED state. 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_cloudresourcemanager2::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_cloudresourcemanager2::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.ListFoldersResponse.html" title="google_cloudresourcemanager2::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.MoveFolderRequest.html" title="google_cloudresourcemanager2::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.Operation.html" title="google_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::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.Policy.html" title="google_cloudresourcemanager2::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.SearchFoldersRequest.html" title="google_cloudresourcemanager2::api::SearchFoldersRequest struct">SearchFoldersRequest</a></td><td class="docblock-short"><p>The request message for searching folders.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SearchFoldersResponse.html" title="google_cloudresourcemanager2::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.SetIamPolicyRequest.html" title="google_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::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_cloudresourcemanager2::api::UndeleteFolderRequest struct">UndeleteFolderRequest</a></td><td class="docblock-short"><p>The UndeleteFolder request message.</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_cloudresourcemanager2::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_cloudresourcemanager2"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |