mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
145 lines
47 KiB
HTML
145 lines
47 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 `ProjectMethods` struct in crate `google_redis1`."><meta name="keywords" content="rust, rustlang, rust-lang, ProjectMethods"><title>google_redis1::api::ProjectMethods - 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 struct"><!--[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_redis1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct ProjectMethods</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.locations_get">locations_get</a><a href="#method.locations_instances_create">locations_instances_create</a><a href="#method.locations_instances_delete">locations_instances_delete</a><a href="#method.locations_instances_export">locations_instances_export</a><a href="#method.locations_instances_failover">locations_instances_failover</a><a href="#method.locations_instances_get">locations_instances_get</a><a href="#method.locations_instances_get_auth_string">locations_instances_get_auth_string</a><a href="#method.locations_instances_import">locations_instances_import</a><a href="#method.locations_instances_list">locations_instances_list</a><a href="#method.locations_instances_patch">locations_instances_patch</a><a href="#method.locations_instances_upgrade">locations_instances_upgrade</a><a href="#method.locations_list">locations_list</a><a href="#method.locations_operations_cancel">locations_operations_cancel</a><a href="#method.locations_operations_delete">locations_operations_delete</a><a href="#method.locations_operations_get">locations_operations_get</a><a href="#method.locations_operations_list">locations_operations_list</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-MethodsBuilder">MethodsBuilder</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Instrument">Instrument</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">google_redis1</a>::<wbr><a href="index.html">api</a></p><div id="sidebar-vars" data-name="ProjectMethods" data-ty="struct" 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">Struct <a href="../index.html">google_redis1</a>::<wbr><a href="index.html">api</a>::<wbr><a class="struct" href="">ProjectMethods</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_redis1/api.rs.html#612-616" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct ProjectMethods<'a, C> <span class="where fmt-newline">where<br> C: 'a, </span> { /* fields omitted */ }</pre></div><div class="docblock"><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>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<p>Instantiate a resource builder</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">hyper</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">hyper_rustls</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">yup_oauth2</span> <span class="kw">as</span> <span class="ident">oauth2</span>;
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">google_redis1</span> <span class="kw">as</span> <span class="ident">redis1</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">default</span>::<span class="ident">Default</span>;
|
||
<span class="kw">use</span> <span class="ident">oauth2</span>;
|
||
<span class="kw">use</span> <span class="ident">redis1</span>::<span class="ident">CloudRedis</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">secret</span>: <span class="ident">oauth2</span>::<span class="ident">ApplicationSecret</span> <span class="op">=</span> <span class="ident">Default</span>::<span class="ident">default</span>();
|
||
<span class="kw">let</span> <span class="ident">auth</span> <span class="op">=</span> <span class="ident">yup_oauth2</span>::<span class="ident">InstalledFlowAuthenticator</span>::<span class="ident">builder</span>(
|
||
<span class="ident">secret</span>,
|
||
<span class="ident">yup_oauth2</span>::<span class="ident">InstalledFlowReturnMethod</span>::<span class="ident">HTTPRedirect</span>,
|
||
).<span class="ident">build</span>().<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">hub</span> <span class="op">=</span> <span class="ident">CloudRedis</span>::<span class="ident">new</span>(<span class="ident">hyper</span>::<span class="ident">Client</span>::<span class="ident">builder</span>().<span class="ident">build</span>(<span class="ident">hyper_rustls</span>::<span class="ident">HttpsConnector</span>::<span class="ident">with_native_roots</span>()), <span class="ident">auth</span>);
|
||
<span class="comment">// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*</span>
|
||
<span class="comment">// like `locations_get(...)`, `locations_instances_create(...)`, `locations_instances_delete(...)`, `locations_instances_export(...)`, `locations_instances_failover(...)`, `locations_instances_get(...)`, `locations_instances_get_auth_string(...)`, `locations_instances_import(...)`, `locations_instances_list(...)`, `locations_instances_patch(...)`, `locations_instances_upgrade(...)`, `locations_list(...)`, `locations_operations_cancel(...)`, `locations_operations_delete(...)`, `locations_operations_get(...)` and `locations_operations_list(...)`</span>
|
||
<span class="comment">// to build up your call.</span>
|
||
<span class="kw">let</span> <span class="ident">rb</span> <span class="op">=</span> <span class="ident">hub</span>.<span class="ident">projects</span>();</pre></div>
|
||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'a, C> <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/google_redis1/api.rs.html#620-915" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.locations_instances_create" class="method"><code>pub fn <a href="#method.locations_instances_create" class="fnname">locations_instances_create</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.Instance.html" title="struct google_redis1::api::Instance">Instance</a>, <br> parent: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceCreateCall.html" title="struct google_redis1::api::ProjectLocationInstanceCreateCall">ProjectLocationInstanceCreateCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#630-640" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments" class="section-header"><a href="#arguments">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>parent</code> - Required. The resource name of the instance location using the form: <code>projects/{project_id}/locations/{location_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_delete" class="method"><code>pub fn <a href="#method.locations_instances_delete" class="fnname">locations_instances_delete</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceDeleteCall.html" title="struct google_redis1::api::ProjectLocationInstanceDeleteCall">ProjectLocationInstanceDeleteCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#649-657" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Deletes a specific Redis instance. Instance stops serving and data is deleted.</p>
|
||
<h1 id="arguments-1" class="section-header"><a href="#arguments-1">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_export" class="method"><code>pub fn <a href="#method.locations_instances_export" class="fnname">locations_instances_export</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.ExportInstanceRequest.html" title="struct google_redis1::api::ExportInstanceRequest">ExportInstanceRequest</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceExportCall.html" title="struct google_redis1::api::ProjectLocationInstanceExportCall">ProjectLocationInstanceExportCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#667-676" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-2" class="section-header"><a href="#arguments-2">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_failover" class="method"><code>pub fn <a href="#method.locations_instances_failover" class="fnname">locations_instances_failover</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.FailoverInstanceRequest.html" title="struct google_redis1::api::FailoverInstanceRequest">FailoverInstanceRequest</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceFailoverCall.html" title="struct google_redis1::api::ProjectLocationInstanceFailoverCall">ProjectLocationInstanceFailoverCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#686-695" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.</p>
|
||
<h1 id="arguments-3" class="section-header"><a href="#arguments-3">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_get" class="method"><code>pub fn <a href="#method.locations_instances_get" class="fnname">locations_instances_get</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceGetCall.html" title="struct google_redis1::api::ProjectLocationInstanceGetCall">ProjectLocationInstanceGetCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#704-712" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Gets the details of a specific Redis instance.</p>
|
||
<h1 id="arguments-4" class="section-header"><a href="#arguments-4">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_get_auth_string" class="method"><code>pub fn <a href="#method.locations_instances_get_auth_string" class="fnname">locations_instances_get_auth_string</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceGetAuthStringCall.html" title="struct google_redis1::api::ProjectLocationInstanceGetAuthStringCall">ProjectLocationInstanceGetAuthStringCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#721-729" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-5" class="section-header"><a href="#arguments-5">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_import" class="method"><code>pub fn <a href="#method.locations_instances_import" class="fnname">locations_instances_import</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.ImportInstanceRequest.html" title="struct google_redis1::api::ImportInstanceRequest">ImportInstanceRequest</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceImportCall.html" title="struct google_redis1::api::ProjectLocationInstanceImportCall">ProjectLocationInstanceImportCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#739-748" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-6" class="section-header"><a href="#arguments-6">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_list" class="method"><code>pub fn <a href="#method.locations_instances_list" class="fnname">locations_instances_list</a>(<br> &self, <br> parent: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceListCall.html" title="struct google_redis1::api::ProjectLocationInstanceListCall">ProjectLocationInstanceListCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#757-767" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-7" class="section-header"><a href="#arguments-7">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>parent</code> - Required. The resource name of the instance location using the form: <code>projects/{project_id}/locations/{location_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_patch" class="method"><code>pub fn <a href="#method.locations_instances_patch" class="fnname">locations_instances_patch</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.Instance.html" title="struct google_redis1::api::Instance">Instance</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstancePatchCall.html" title="struct google_redis1::api::ProjectLocationInstancePatchCall">ProjectLocationInstancePatchCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#777-787" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-8" class="section-header"><a href="#arguments-8">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>name</code> - Required. Unique name of the resource in this scope including project and location using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_instances_upgrade" class="method"><code>pub fn <a href="#method.locations_instances_upgrade" class="fnname">locations_instances_upgrade</a>(<br> &self, <br> request: <a class="struct" href="../../google_redis1/api/struct.UpgradeInstanceRequest.html" title="struct google_redis1::api::UpgradeInstanceRequest">UpgradeInstanceRequest</a>, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationInstanceUpgradeCall.html" title="struct google_redis1::api::ProjectLocationInstanceUpgradeCall">ProjectLocationInstanceUpgradeCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#797-806" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Upgrades Redis instance to the newer Redis version specified in the request.</p>
|
||
<h1 id="arguments-9" class="section-header"><a href="#arguments-9">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>request</code> - No description provided.</li>
|
||
<li><code>name</code> - Required. Redis instance resource name using the form: <code>projects/{project_id}/locations/{location_id}/instances/{instance_id}</code> where <code>location_id</code> refers to a GCP region.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_operations_cancel" class="method"><code>pub fn <a href="#method.locations_operations_cancel" class="fnname">locations_operations_cancel</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationOperationCancelCall.html" title="struct google_redis1::api::ProjectLocationOperationCancelCall">ProjectLocationOperationCancelCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#815-823" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-10" class="section-header"><a href="#arguments-10">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - The name of the operation resource to be cancelled.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_operations_delete" class="method"><code>pub fn <a href="#method.locations_operations_delete" class="fnname">locations_operations_delete</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationOperationDeleteCall.html" title="struct google_redis1::api::ProjectLocationOperationDeleteCall">ProjectLocationOperationDeleteCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#832-840" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-11" class="section-header"><a href="#arguments-11">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - The name of the operation resource to be deleted.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_operations_get" class="method"><code>pub fn <a href="#method.locations_operations_get" class="fnname">locations_operations_get</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationOperationGetCall.html" title="struct google_redis1::api::ProjectLocationOperationGetCall">ProjectLocationOperationGetCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#849-857" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-12" class="section-header"><a href="#arguments-12">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - The name of the operation resource.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_operations_list" class="method"><code>pub fn <a href="#method.locations_operations_list" class="fnname">locations_operations_list</a>(<br> &self, <br> name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationOperationListCall.html" title="struct google_redis1::api::ProjectLocationOperationListCall">ProjectLocationOperationListCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#866-877" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<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>
|
||
<h1 id="arguments-13" class="section-header"><a href="#arguments-13">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - The name of the operation's parent resource.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_get" class="method"><code>pub fn <a href="#method.locations_get" class="fnname">locations_get</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationGetCall.html" title="struct google_redis1::api::ProjectLocationGetCall">ProjectLocationGetCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#886-894" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Gets information about a location.</p>
|
||
<h1 id="arguments-14" class="section-header"><a href="#arguments-14">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - Resource name for the location.</li>
|
||
</ul>
|
||
</div><h4 id="method.locations_list" class="method"><code>pub fn <a href="#method.locations_list" class="fnname">locations_list</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../../google_redis1/api/struct.ProjectLocationListCall.html" title="struct google_redis1::api::ProjectLocationListCall">ProjectLocationListCall</a><'a, C></code><a class="srclink" href="../../src/google_redis1/api.rs.html#903-914" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a builder to help you perform the following task:</p>
|
||
<p>Lists information about the supported locations for this service.</p>
|
||
<h1 id="arguments-15" class="section-header"><a href="#arguments-15">Arguments</a></h1>
|
||
<ul>
|
||
<li><code>name</code> - The resource that owns the locations collection, if applicable.</li>
|
||
</ul>
|
||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-MethodsBuilder" class="impl"><code class="in-band">impl<'a, C> <a class="trait" href="../../google_redis1/client/trait.MethodsBuilder.html" title="trait google_redis1::client::MethodsBuilder">MethodsBuilder</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-MethodsBuilder" class="anchor"></a><a class="srclink" href="../../src/google_redis1/api.rs.html#618" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<'a, C> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../../src/google_redis1/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<'a, C> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../../src/google_redis1/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<'a, C> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../../src/google_redis1/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a, C> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../../src/google_redis1/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<'a, C> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../google_redis1/api/struct.ProjectMethods.html" title="struct google_redis1::api::ProjectMethods">ProjectMethods</a><'a, C></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../../src/google_redis1/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#131-135" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#132" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#207-211" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-218" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-549" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#546" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Instrument" class="impl"><code class="in-band">impl<T> <a class="trait" href="../../tracing/instrument/trait.Instrument.html" title="trait tracing::instrument::Instrument">Instrument</a> for T</code><a href="#impl-Instrument" class="anchor"></a><a class="srclink" href="../../src/tracing/instrument.rs.html#155" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.instrument" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.instrument" class="fnname">instrument</a>(self, span: <a class="struct" href="../../tracing/span/struct.Span.html" title="struct tracing::span::Span">Span</a>) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#38" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the provided <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.instrument">Read more</a></p>
|
||
</div><h4 id="method.in_current_span" class="method hidden"><code>pub fn <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span" class="fnname">in_current_span</a>(self) -> <a class="struct" href="../../tracing/instrument/struct.Instrumented.html" title="struct tracing::instrument::Instrumented">Instrumented</a><Self></code><a class="srclink" href="../../src/tracing/instrument.rs.html#74" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Instruments this type with the <a href="../struct.Span.html#method.current">current</a> <code>Span</code>, returning an
|
||
<code>Instrumented</code> wrapper. <a href="../../tracing/instrument/trait.Instrument.html#method.in_current_span">Read more</a></p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#534-541" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#538" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></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> |