mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 13:22:37 +01:00
34 lines
13 KiB
HTML
34 lines
13 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_cloudshell1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudshell1::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_cloudshell1/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_cloudshell1</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_cloudshell1</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_cloudshell1/api.rs.html#1-3239" 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.AddPublicKeyRequest.html" title="google_cloudshell1::api::AddPublicKeyRequest struct">AddPublicKeyRequest</a></td><td class="docblock-short"><p>Request message for AddPublicKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuthorizeEnvironmentRequest.html" title="google_cloudshell1::api::AuthorizeEnvironmentRequest struct">AuthorizeEnvironmentRequest</a></td><td class="docblock-short"><p>Request message for AuthorizeEnvironment.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CancelOperationRequest.html" title="google_cloudshell1::api::CancelOperationRequest struct">CancelOperationRequest</a></td><td class="docblock-short"><p>The request message for Operations.CancelOperation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudShell.html" title="google_cloudshell1::api::CloudShell struct">CloudShell</a></td><td class="docblock-short"><p>Central instance to access all CloudShell related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_cloudshell1::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.Environment.html" title="google_cloudshell1::api::Environment struct">Environment</a></td><td class="docblock-short"><p>A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user's data that will remain across sessions. Each user has at least an environment with the ID "default".</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListOperationsResponse.html" title="google_cloudshell1::api::ListOperationsResponse struct">ListOperationsResponse</a></td><td class="docblock-short"><p>The response message for Operations.ListOperations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_cloudshell1::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.OperationCancelCall.html" title="google_cloudshell1::api::OperationCancelCall struct">OperationCancelCall</a></td><td class="docblock-short"><p>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns <code>google.rpc.Code.UNIMPLEMENTED</code>. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to <code>Code.CANCELLED</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationDeleteCall.html" title="google_cloudshell1::api::OperationDeleteCall struct">OperationDeleteCall</a></td><td class="docblock-short"><p>Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns <code>google.rpc.Code.UNIMPLEMENTED</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationGetCall.html" title="google_cloudshell1::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.OperationListCall.html" title="google_cloudshell1::api::OperationListCall struct">OperationListCall</a></td><td class="docblock-short"><p>Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns <code>UNIMPLEMENTED</code>. NOTE: the <code>name</code> binding allows API services to override the binding to use different resource name schemes, such as <code>users/*/operations</code>. To override the binding, API services can add a binding such as <code>"/v1/{name=users/*}/operations"</code> to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.OperationMethods.html" title="google_cloudshell1::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>CloudShell</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RemovePublicKeyRequest.html" title="google_cloudshell1::api::RemovePublicKeyRequest struct">RemovePublicKeyRequest</a></td><td class="docblock-short"><p>Request message for RemovePublicKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.StartEnvironmentRequest.html" title="google_cloudshell1::api::StartEnvironmentRequest struct">StartEnvironmentRequest</a></td><td class="docblock-short"><p>Request message for StartEnvironment.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_cloudshell1::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.UserEnvironmentAddPublicKeyCall.html" title="google_cloudshell1::api::UserEnvironmentAddPublicKeyCall struct">UserEnvironmentAddPublicKeyCall</a></td><td class="docblock-short"><p>Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserEnvironmentAuthorizeCall.html" title="google_cloudshell1::api::UserEnvironmentAuthorizeCall struct">UserEnvironmentAuthorizeCall</a></td><td class="docblock-short"><p>Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserEnvironmentGetCall.html" title="google_cloudshell1::api::UserEnvironmentGetCall struct">UserEnvironmentGetCall</a></td><td class="docblock-short"><p>Gets an environment. Returns NOT_FOUND if the environment does not exist.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserEnvironmentRemovePublicKeyCall.html" title="google_cloudshell1::api::UserEnvironmentRemovePublicKeyCall struct">UserEnvironmentRemovePublicKeyCall</a></td><td class="docblock-short"><p>Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserEnvironmentStartCall.html" title="google_cloudshell1::api::UserEnvironmentStartCall struct">UserEnvironmentStartCall</a></td><td class="docblock-short"><p>Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UserMethods.html" title="google_cloudshell1::api::UserMethods struct">UserMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>user</em> resources.
|
||
It is not used directly, but through the <code>CloudShell</code> hub.</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_cloudshell1::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_cloudshell1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |