OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-29 13:22:37 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_pubsub1_cli/projects_snapshots-get/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

449 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Snapshots Get - Pubsub v3.0.0+20220221</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Pubsub v3.0.0+20220221</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-create">Schemas Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-delete">Schemas Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-get">Schemas Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-get-iam-policy">Schemas Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-list">Schemas List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-set-iam-policy">Schemas Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-test-iam-permissions">Schemas Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-validate">Schemas Validate</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_schemas-validate-message">Schemas Validate Message</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-create">Snapshots Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-delete">Snapshots Delete</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Snapshots Get</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-get-iam-policy">Snapshots Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-list">Snapshots List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-patch">Snapshots Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-set-iam-policy">Snapshots Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_snapshots-test-iam-permissions">Snapshots Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-acknowledge">Subscriptions Acknowledge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-create">Subscriptions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-delete">Subscriptions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-detach">Subscriptions Detach</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-get">Subscriptions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-get-iam-policy">Subscriptions Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-list">Subscriptions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-modify-ack-deadline">Subscriptions Modify Ack Deadline</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-modify-push-config">Subscriptions Modify Push Config</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-patch">Subscriptions Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-pull">Subscriptions Pull</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-seek">Subscriptions Seek</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-set-iam-policy">Subscriptions Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_subscriptions-test-iam-permissions">Subscriptions Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-create">Topics Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-delete">Topics Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-get">Topics Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-get-iam-policy">Topics Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-list">Topics List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-patch">Topics Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-publish">Topics Publish</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-set-iam-policy">Topics Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-snapshots-list">Topics Snapshots List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-subscriptions-list">Topics Subscriptions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_topics-test-iam-permissions">Topics Test Iam Permissions</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Snapshots Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/pubsub1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/pubsub</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
You can set the scope for this method like this: <code>pubsub1 --scope &lt;scope&gt; projects snapshots-get ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;snapshot&gt;</strong> <em>(string)</em><ul>
<li>Required. The name of the snapshot to get. Format is <code>projects/{project}/snapshots/{snap}</code>.</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_snapshots-get-iam-policy" class="btn btn-neutral float-right" title="Snapshots Get Iam Policy"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_snapshots-delete" class="btn btn-neutral" title="Snapshots Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_snapshots-delete" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_snapshots-get-iam-policy" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink