mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-31 06:12:47 +01:00
47 lines
20 KiB
HTML
47 lines
20 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_accesscontextmanager1_beta`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_accesscontextmanager1_beta::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_accesscontextmanager1_beta/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_accesscontextmanager1_beta</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_accesscontextmanager1_beta</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_accesscontextmanager1_beta/api.rs.html#1-5441" 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.AccessContextManager.html" title="google_accesscontextmanager1_beta::api::AccessContextManager struct">AccessContextManager</a></td><td class="docblock-short"><p>Central instance to access all AccessContextManager related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessLevel.html" title="google_accesscontextmanager1_beta::api::AccessLevel struct">AccessLevel</a></td><td class="docblock-short"><p>An <code>AccessLevel</code> is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicy.html" title="google_accesscontextmanager1_beta::api::AccessPolicy struct">AccessPolicy</a></td><td class="docblock-short"><p><code>AccessPolicy</code> is a container for <code>AccessLevels</code> (which define the necessary attributes to use Google Cloud services) and <code>ServicePerimeters</code> (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyAccessLevelCreateCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyAccessLevelCreateCall struct">AccessPolicyAccessLevelCreateCall</a></td><td class="docblock-short"><p>Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyAccessLevelDeleteCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyAccessLevelDeleteCall struct">AccessPolicyAccessLevelDeleteCall</a></td><td class="docblock-short"><p>Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyAccessLevelGetCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyAccessLevelGetCall struct">AccessPolicyAccessLevelGetCall</a></td><td class="docblock-short"><p>Get an Access Level by resource name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyAccessLevelListCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyAccessLevelListCall struct">AccessPolicyAccessLevelListCall</a></td><td class="docblock-short"><p>List all Access Levels for an access policy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyAccessLevelPatchCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyAccessLevelPatchCall struct">AccessPolicyAccessLevelPatchCall</a></td><td class="docblock-short"><p>Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyCreateCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyCreateCall struct">AccessPolicyCreateCall</a></td><td class="docblock-short"><p>Create an <code>AccessPolicy</code>. Fails if this organization already has a <code>AccessPolicy</code>. The longrunning Operation will have a successful status once the <code>AccessPolicy</code> has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in <code>metadata</code> as a BadRequest proto.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyDeleteCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyDeleteCall struct">AccessPolicyDeleteCall</a></td><td class="docblock-short"><p>Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyGetCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyGetCall struct">AccessPolicyGetCall</a></td><td class="docblock-short"><p>Get an AccessPolicy by name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyListCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyListCall struct">AccessPolicyListCall</a></td><td class="docblock-short"><p>List all AccessPolicies under a container.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyMethods.html" title="google_accesscontextmanager1_beta::api::AccessPolicyMethods struct">AccessPolicyMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>accessPolicy</em> resources.
|
||
It is not used directly, but through the <code>AccessContextManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyPatchCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyPatchCall struct">AccessPolicyPatchCall</a></td><td class="docblock-short"><p>Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in <code>metadata</code> as a BadRequest proto.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyServicePerimeterCreateCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyServicePerimeterCreateCall struct">AccessPolicyServicePerimeterCreateCall</a></td><td class="docblock-short"><p>Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyServicePerimeterDeleteCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyServicePerimeterDeleteCall struct">AccessPolicyServicePerimeterDeleteCall</a></td><td class="docblock-short"><p>Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyServicePerimeterGetCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyServicePerimeterGetCall struct">AccessPolicyServicePerimeterGetCall</a></td><td class="docblock-short"><p>Get a Service Perimeter by resource name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyServicePerimeterListCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyServicePerimeterListCall struct">AccessPolicyServicePerimeterListCall</a></td><td class="docblock-short"><p>List all Service Perimeters for an access policy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AccessPolicyServicePerimeterPatchCall.html" title="google_accesscontextmanager1_beta::api::AccessPolicyServicePerimeterPatchCall struct">AccessPolicyServicePerimeterPatchCall</a></td><td class="docblock-short"><p>Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BasicLevel.html" title="google_accesscontextmanager1_beta::api::BasicLevel struct">BasicLevel</a></td><td class="docblock-short"><p><code>BasicLevel</code> is an <code>AccessLevel</code> using a set of recommended features.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Condition.html" title="google_accesscontextmanager1_beta::api::Condition struct">Condition</a></td><td class="docblock-short"><p>A condition necessary for an <code>AccessLevel</code> to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CustomLevel.html" title="google_accesscontextmanager1_beta::api::CustomLevel struct">CustomLevel</a></td><td class="docblock-short"><p><code>CustomLevel</code> is an <code>AccessLevel</code> using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DevicePolicy.html" title="google_accesscontextmanager1_beta::api::DevicePolicy struct">DevicePolicy</a></td><td class="docblock-short"><p><code>DevicePolicy</code> specifies device specific restrictions necessary to acquire a given access level. A <code>DevicePolicy</code> specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. <code>DevicePolicy</code> acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_accesscontextmanager1_beta::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.ListAccessLevelsResponse.html" title="google_accesscontextmanager1_beta::api::ListAccessLevelsResponse struct">ListAccessLevelsResponse</a></td><td class="docblock-short"><p>A response to <code>ListAccessLevelsRequest</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListAccessPoliciesResponse.html" title="google_accesscontextmanager1_beta::api::ListAccessPoliciesResponse struct">ListAccessPoliciesResponse</a></td><td class="docblock-short"><p>A response to <code>ListAccessPoliciesRequest</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListServicePerimetersResponse.html" title="google_accesscontextmanager1_beta::api::ListServicePerimetersResponse struct">ListServicePerimetersResponse</a></td><td class="docblock-short"><p>A response to <code>ListServicePerimetersRequest</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_accesscontextmanager1_beta::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_accesscontextmanager1_beta::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_accesscontextmanager1_beta::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>AccessContextManager</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OsConstraint.html" title="google_accesscontextmanager1_beta::api::OsConstraint struct">OsConstraint</a></td><td class="docblock-short"><p>A restriction on the OS type and version of devices making requests.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServicePerimeter.html" title="google_accesscontextmanager1_beta::api::ServicePerimeter struct">ServicePerimeter</a></td><td class="docblock-short"><p><code>ServicePerimeter</code> describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the <code>ServicePerimeter</code>. If a request with a source within this <code>ServicePerimeter</code> has a target outside of the <code>ServicePerimeter</code>, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ServicePerimeterConfig.html" title="google_accesscontextmanager1_beta::api::ServicePerimeterConfig struct">ServicePerimeterConfig</a></td><td class="docblock-short"><p><code>ServicePerimeterConfig</code> specifies a set of Google Cloud resources that describe specific Service Perimeter configuration.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_accesscontextmanager1_beta::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.VpcAccessibleServices.html" title="google_accesscontextmanager1_beta::api::VpcAccessibleServices struct">VpcAccessibleServices</a></td><td class="docblock-short"><p>Specifies how APIs are allowed to communicate within the Service Perimeter.</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_accesscontextmanager1_beta::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_accesscontextmanager1_beta"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |