OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_redis1/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

47 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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_redis1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_redis1::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">&#9776;</div><a href='../../google_redis1/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_redis1</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_redis1</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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_redis1/api.rs.html#1-5494" 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.CloudRedis.html" title="google_redis1::api::CloudRedis struct">CloudRedis</a></td><td class="docblock-short"><p>Central instance to access all CloudRedis related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_redis1::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.ExportInstanceRequest.html" title="google_redis1::api::ExportInstanceRequest struct">ExportInstanceRequest</a></td><td class="docblock-short"><p>Request for Export.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FailoverInstanceRequest.html" title="google_redis1::api::FailoverInstanceRequest struct">FailoverInstanceRequest</a></td><td class="docblock-short"><p>Request for Failover.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GcsDestination.html" title="google_redis1::api::GcsDestination struct">GcsDestination</a></td><td class="docblock-short"><p>The Cloud Storage location for the output content</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GcsSource.html" title="google_redis1::api::GcsSource struct">GcsSource</a></td><td class="docblock-short"><p>The Cloud Storage location for the input content</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ImportInstanceRequest.html" title="google_redis1::api::ImportInstanceRequest struct">ImportInstanceRequest</a></td><td class="docblock-short"><p>Request for Import.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InputConfig.html" title="google_redis1::api::InputConfig struct">InputConfig</a></td><td class="docblock-short"><p>The input content</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Instance.html" title="google_redis1::api::Instance struct">Instance</a></td><td class="docblock-short"><p>A Google Cloud Redis instance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.InstanceAuthString.html" title="google_redis1::api::InstanceAuthString struct">InstanceAuthString</a></td><td class="docblock-short"><p>Instance AUTH string details.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListInstancesResponse.html" title="google_redis1::api::ListInstancesResponse struct">ListInstancesResponse</a></td><td class="docblock-short"><p>Response for ListInstances.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_redis1::api::ListLocationsResponse struct">ListLocationsResponse</a></td><td class="docblock-short"><p>The response message for Locations.ListLocations.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListOperationsResponse.html" title="google_redis1::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.Location.html" title="google_redis1::api::Location struct">Location</a></td><td class="docblock-short"><p>A resource that represents Google Cloud Platform location.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Operation.html" title="google_redis1::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.OutputConfig.html" title="google_redis1::api::OutputConfig struct">OutputConfig</a></td><td class="docblock-short"><p>The output content</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationGetCall.html" title="google_redis1::api::ProjectLocationGetCall struct">ProjectLocationGetCall</a></td><td class="docblock-short"><p>Gets information about a location.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceCreateCall.html" title="google_redis1::api::ProjectLocationInstanceCreateCall struct">ProjectLocationInstanceCreateCall</a></td><td class="docblock-short"><p>Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's <a href="https://cloud.google.com/vpc/docs/vpc">default network</a>. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceDeleteCall.html" title="google_redis1::api::ProjectLocationInstanceDeleteCall struct">ProjectLocationInstanceDeleteCall</a></td><td class="docblock-short"><p>Deletes a specific Redis instance. Instance stops serving and data is deleted.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceExportCall.html" title="google_redis1::api::ProjectLocationInstanceExportCall struct">ProjectLocationInstanceExportCall</a></td><td class="docblock-short"><p>Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceFailoverCall.html" title="google_redis1::api::ProjectLocationInstanceFailoverCall struct">ProjectLocationInstanceFailoverCall</a></td><td class="docblock-short"><p>Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceGetAuthStringCall.html" title="google_redis1::api::ProjectLocationInstanceGetAuthStringCall struct">ProjectLocationInstanceGetAuthStringCall</a></td><td class="docblock-short"><p>Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceGetCall.html" title="google_redis1::api::ProjectLocationInstanceGetCall struct">ProjectLocationInstanceGetCall</a></td><td class="docblock-short"><p>Gets the details of a specific Redis instance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceImportCall.html" title="google_redis1::api::ProjectLocationInstanceImportCall struct">ProjectLocationInstanceImportCall</a></td><td class="docblock-short"><p>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceListCall.html" title="google_redis1::api::ProjectLocationInstanceListCall struct">ProjectLocationInstanceListCall</a></td><td class="docblock-short"><p>Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * <code>projects/{project_id}/locations/{location_id}</code> If <code>location_id</code> is specified as <code>-</code> (wildcard), then all regions available to the project are queried, and the results are aggregated.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstancePatchCall.html" title="google_redis1::api::ProjectLocationInstancePatchCall struct">ProjectLocationInstancePatchCall</a></td><td class="docblock-short"><p>Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceUpgradeCall.html" title="google_redis1::api::ProjectLocationInstanceUpgradeCall struct">ProjectLocationInstanceUpgradeCall</a></td><td class="docblock-short"><p>Upgrades Redis instance to the newer Redis version specified in the request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationListCall.html" title="google_redis1::api::ProjectLocationListCall struct">ProjectLocationListCall</a></td><td class="docblock-short"><p>Lists information about the supported locations for this service.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationOperationCancelCall.html" title="google_redis1::api::ProjectLocationOperationCancelCall struct">ProjectLocationOperationCancelCall</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.ProjectLocationOperationDeleteCall.html" title="google_redis1::api::ProjectLocationOperationDeleteCall struct">ProjectLocationOperationDeleteCall</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.ProjectLocationOperationGetCall.html" title="google_redis1::api::ProjectLocationOperationGetCall struct">ProjectLocationOperationGetCall</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.ProjectLocationOperationListCall.html" title="google_redis1::api::ProjectLocationOperationListCall struct">ProjectLocationOperationListCall</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>&quot;/v1/{name=users/*}/operations&quot;</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.ProjectMethods.html" title="google_redis1::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>CloudRedis</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_redis1::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.TlsCertificate.html" title="google_redis1::api::TlsCertificate struct">TlsCertificate</a></td><td class="docblock-short"><p>TlsCertificate Resource</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpgradeInstanceRequest.html" title="google_redis1::api::UpgradeInstanceRequest struct">UpgradeInstanceRequest</a></td><td class="docblock-short"><p>Request for UpgradeInstance.</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_redis1::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_redis1"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink