Files
google-apis-rs/google_cloudtasks2_beta2_cli/projects_locations-queues-tasks-get/index.html
2024-03-05 21:06:01 +01:00

288 lines
13 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-cloudtasks2_beta2-cli/projects_locations-queues-tasks-get/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Locations Queues Tasks Get - Cloud Tasks v5.0.4+20240223</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Locations Queues Tasks Get";
var mkdocs_page_input_path = "projects_locations-queues-tasks-get.md";
var mkdocs_page_url = "/google-apis-rs/google-cloudtasks2_beta2-cli/projects_locations-queues-tasks-get/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</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-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Cloud Tasks v5.0.4+20240223
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Api</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../api_queue-update/">Queue Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-cmek-config/">Locations Get Cmek Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-create/">Locations Queues Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-delete/">Locations Queues Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-get/">Locations Queues Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-get-iam-policy/">Locations Queues Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-list/">Locations Queues List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-patch/">Locations Queues Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-pause/">Locations Queues Pause</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-purge/">Locations Queues Purge</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-resume/">Locations Queues Resume</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-set-iam-policy/">Locations Queues Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-acknowledge/">Locations Queues Tasks Acknowledge</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-buffer/">Locations Queues Tasks Buffer</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-cancel-lease/">Locations Queues Tasks Cancel Lease</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-create/">Locations Queues Tasks Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-delete/">Locations Queues Tasks Delete</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Queues Tasks Get</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-lease/">Locations Queues Tasks Lease</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-list/">Locations Queues Tasks List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-renew-lease/">Locations Queues Tasks Renew Lease</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-run/">Locations Queues Tasks Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-test-iam-permissions/">Locations Queues Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-update-cmek-config/">Locations Update Cmek Config</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Cloud Tasks v5.0.4+20240223</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=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Locations Queues Tasks Get</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2_beta2-cli/edit/master/docs/projects_locations-queues-tasks-get.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Gets a task.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<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>cloudtasks2-beta2 --scope &lt;scope&gt; projects locations-queues-tasks-get ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Required. The task name. For example: <code>projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID</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-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li><strong>-p response-view=string</strong><ul>
<li>The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires <code>cloudtasks.tasks.fullView</code> <a href="https://cloud.google.com/iam/">Google IAM</a> permission on the Task resource.</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_locations-queues-tasks-delete/" class="btn btn-neutral float-left" title="Locations Queues Tasks Delete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_locations-queues-tasks-lease/" class="btn btn-neutral float-right" title="Locations Queues Tasks Lease">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2_beta2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_locations-queues-tasks-delete/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_locations-queues-tasks-lease/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>