mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 05:12:45 +01:00
31 lines
12 KiB
HTML
31 lines
12 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_workflows1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_workflows1::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_workflows1/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_workflows1</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_workflows1</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_workflows1/api.rs.html#1-3475" 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.Empty.html" title="google_workflows1::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.ListLocationsResponse.html" title="google_workflows1::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_workflows1::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.ListWorkflowsResponse.html" title="google_workflows1::api::ListWorkflowsResponse struct">ListWorkflowsResponse</a></td><td class="docblock-short"><p>Response for the ListWorkflows method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Location.html" title="google_workflows1::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_workflows1::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.ProjectLocationGetCall.html" title="google_workflows1::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.ProjectLocationListCall.html" title="google_workflows1::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.ProjectLocationOperationDeleteCall.html" title="google_workflows1::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_workflows1::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_workflows1::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>"/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.ProjectLocationWorkflowCreateCall.html" title="google_workflows1::api::ProjectLocationWorkflowCreateCall struct">ProjectLocationWorkflowCreateCall</a></td><td class="docblock-short"><p>Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationWorkflowDeleteCall.html" title="google_workflows1::api::ProjectLocationWorkflowDeleteCall struct">ProjectLocationWorkflowDeleteCall</a></td><td class="docblock-short"><p>Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationWorkflowGetCall.html" title="google_workflows1::api::ProjectLocationWorkflowGetCall struct">ProjectLocationWorkflowGetCall</a></td><td class="docblock-short"><p>Gets details of a single Workflow.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationWorkflowListCall.html" title="google_workflows1::api::ProjectLocationWorkflowListCall struct">ProjectLocationWorkflowListCall</a></td><td class="docblock-short"><p>Lists Workflows in a given project and location. The default order is not specified.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationWorkflowPatchCall.html" title="google_workflows1::api::ProjectLocationWorkflowPatchCall struct">ProjectLocationWorkflowPatchCall</a></td><td class="docblock-short"><p>Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_workflows1::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>Workflows</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_workflows1::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.Workflow.html" title="google_workflows1::api::Workflow struct">Workflow</a></td><td class="docblock-short"><p>Workflow program to be executed by Workflows.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Workflows.html" title="google_workflows1::api::Workflows struct">Workflows</a></td><td class="docblock-short"><p>Central instance to access all Workflows related resource activities</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_workflows1::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_workflows1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |