mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-01 14:54:02 +01:00
53 lines
25 KiB
HTML
53 lines
25 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_runtimeconfig1_beta1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_runtimeconfig1_beta1::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_runtimeconfig1_beta1/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_runtimeconfig1_beta1</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_runtimeconfig1_beta1</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_runtimeconfig1_beta1/api.rs.html#1-7366" 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.Binding.html" title="google_runtimeconfig1_beta1::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.Cardinality.html" title="google_runtimeconfig1_beta1::api::Cardinality struct">Cardinality</a></td><td class="docblock-short"><p>A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the <code>path</code> is set to <code>/foo</code> and the number of paths is set to <code>2</code>, the following variables would meet the condition in a RuntimeConfig resource: + <code>/foo/variable1 = "value1"</code> + <code>/foo/variable2 = "value2"</code> + <code>/bar/variable3 = "value3"</code> It would not satisfy the same condition with the <code>number</code> set to <code>3</code>, however, because there is only 2 paths that start with <code>/foo</code>. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudRuntimeConfig.html" title="google_runtimeconfig1_beta1::api::CloudRuntimeConfig struct">CloudRuntimeConfig</a></td><td class="docblock-short"><p>Central instance to access all CloudRuntimeConfig related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_runtimeconfig1_beta1::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.EndCondition.html" title="google_runtimeconfig1_beta1::api::EndCondition struct">EndCondition</a></td><td class="docblock-short"><p>The condition that a Waiter resource is waiting for.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_runtimeconfig1_beta1::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.ListConfigsResponse.html" title="google_runtimeconfig1_beta1::api::ListConfigsResponse struct">ListConfigsResponse</a></td><td class="docblock-short"><p><code>ListConfigs()</code> returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListVariablesResponse.html" title="google_runtimeconfig1_beta1::api::ListVariablesResponse struct">ListVariablesResponse</a></td><td class="docblock-short"><p>Response for the <code>ListVariables()</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListWaitersResponse.html" title="google_runtimeconfig1_beta1::api::ListWaitersResponse struct">ListWaitersResponse</a></td><td class="docblock-short"><p>Response for the <code>ListWaiters()</code> method. Order of returned waiter objects is arbitrary.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_runtimeconfig1_beta1::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.Policy.html" title="google_runtimeconfig1_beta1::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.ProjectConfigCreateCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigCreateCall struct">ProjectConfigCreateCall</a></td><td class="docblock-short"><p>Creates a new RuntimeConfig resource. The configuration name must be unique within project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigDeleteCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigDeleteCall struct">ProjectConfigDeleteCall</a></td><td class="docblock-short"><p>Deletes a RuntimeConfig resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigGetCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigGetCall struct">ProjectConfigGetCall</a></td><td class="docblock-short"><p>Gets information about a RuntimeConfig resource.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigGetIamPolicyCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigGetIamPolicyCall struct">ProjectConfigGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigListCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigListCall struct">ProjectConfigListCall</a></td><td class="docblock-short"><p>Lists all the RuntimeConfig resources within project.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigOperationGetCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigOperationGetCall struct">ProjectConfigOperationGetCall</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.ProjectConfigOperationTestIamPermissionCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigOperationTestIamPermissionCall struct">ProjectConfigOperationTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigSetIamPolicyCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigSetIamPolicyCall struct">ProjectConfigSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigTestIamPermissionCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigTestIamPermissionCall struct">ProjectConfigTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigUpdateCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigUpdateCall struct">ProjectConfigUpdateCall</a></td><td class="docblock-short"><p>Updates a RuntimeConfig resource. The configuration must exist beforehand.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableCreateCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableCreateCall struct">ProjectConfigVariableCreateCall</a></td><td class="docblock-short"><p>Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the <a href="/deployment-manager/runtime-configurator/set-and-get-variables">Setting and Getting Data</a> documentation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableDeleteCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableDeleteCall struct">ProjectConfigVariableDeleteCall</a></td><td class="docblock-short"><p>Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and <code>recursive</code> is true, then all variables with that prefix are deleted. You must set a <code>recursive</code> to true if you delete variables by prefix.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableGetCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableGetCall struct">ProjectConfigVariableGetCall</a></td><td class="docblock-short"><p>Gets information about a single variable.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableListCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableListCall struct">ProjectConfigVariableListCall</a></td><td class="docblock-short"><p>Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless <code>return_values</code> is true, in which case only variables that user has IAM permission to GetVariable will be returned.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableTestIamPermissionCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableTestIamPermissionCall struct">ProjectConfigVariableTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableUpdateCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableUpdateCall struct">ProjectConfigVariableUpdateCall</a></td><td class="docblock-short"><p>Updates an existing variable with a new value.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigVariableWatchCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigVariableWatchCall struct">ProjectConfigVariableWatchCall</a></td><td class="docblock-short"><p>Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the <code>variableState</code> state is set to <code>DELETED</code> and the method returns the last known variable <code>value</code>. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the <code>variableState</code> will be <code>VARIABLE_STATE_UNSPECIFIED</code>. To learn more about creating a watcher, read the <a href="/deployment-manager/runtime-configurator/watching-a-variable">Watching a Variable for Changes</a> documentation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigWaiterCreateCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigWaiterCreateCall struct">ProjectConfigWaiterCreateCall</a></td><td class="docblock-short"><p>Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigWaiterDeleteCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigWaiterDeleteCall struct">ProjectConfigWaiterDeleteCall</a></td><td class="docblock-short"><p>Deletes the waiter with the specified name.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigWaiterGetCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigWaiterGetCall struct">ProjectConfigWaiterGetCall</a></td><td class="docblock-short"><p>Gets information about a single waiter.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigWaiterListCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigWaiterListCall struct">ProjectConfigWaiterListCall</a></td><td class="docblock-short"><p>List waiters within the given configuration.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectConfigWaiterTestIamPermissionCall.html" title="google_runtimeconfig1_beta1::api::ProjectConfigWaiterTestIamPermissionCall struct">ProjectConfigWaiterTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_runtimeconfig1_beta1::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>CloudRuntimeConfig</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RuntimeConfig.html" title="google_runtimeconfig1_beta1::api::RuntimeConfig struct">RuntimeConfig</a></td><td class="docblock-short"><p>A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_runtimeconfig1_beta1::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_runtimeconfig1_beta1::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_runtimeconfig1_beta1::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_runtimeconfig1_beta1::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.Variable.html" title="google_runtimeconfig1_beta1::api::Variable struct">Variable</a></td><td class="docblock-short"><p>Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, <code>ports/serving_port</code> is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Waiter.html" title="google_runtimeconfig1_beta1::api::Waiter struct">Waiter</a></td><td class="docblock-short"><p>A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the <a href="/deployment-manager/runtime-configurator/creating-a-waiter">Creating a Waiter</a> documentation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WatchVariableRequest.html" title="google_runtimeconfig1_beta1::api::WatchVariableRequest struct">WatchVariableRequest</a></td><td class="docblock-short"><p>Request for the <code>WatchVariable()</code> 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_runtimeconfig1_beta1::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_runtimeconfig1_beta1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |