mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
542 lines
28 KiB
HTML
542 lines
28 KiB
HTML
<!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>Locations Queues Tasks Create - Cloud Tasks v3.0.0+20220212</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"> Cloud Tasks v3.0.0+20220212</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_locations-get">Locations Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-list">Locations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-create">Locations Queues Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-delete">Locations Queues Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-get">Locations Queues Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-get-iam-policy">Locations Queues Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-list">Locations Queues List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-patch">Locations Queues Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-pause">Locations Queues Pause</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-purge">Locations Queues Purge</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-resume">Locations Queues Resume</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-set-iam-policy">Locations Queues Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-acknowledge">Locations Queues Tasks Acknowledge</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-cancel-lease">Locations Queues Tasks Cancel Lease</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Locations Queues Tasks Create</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="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</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_locations-queues-tasks-delete">Locations Queues Tasks Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-get">Locations Queues Tasks Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-lease">Locations Queues Tasks Lease</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-list">Locations Queues Tasks List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-renew-lease">Locations Queues Tasks Renew Lease</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-tasks-run">Locations Queues Tasks Run</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-queues-test-iam-permissions">Locations Queues Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</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> »</li>
|
|
<li>Locations Queues Tasks Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2_beta2-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * For pull queues, the maximum task size is 1MB.</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 <scope> projects locations-queues-tasks-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The queue name. For example: <code>projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID</code> The queue must already exist.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>CreateTaskRequest:
|
|
response-view: string
|
|
task:
|
|
app-engine-http-request:
|
|
app-engine-routing:
|
|
host: string
|
|
instance: string
|
|
service: string
|
|
version: string
|
|
headers: { string: string }
|
|
http-method: string
|
|
payload: string
|
|
relative-url: string
|
|
create-time: string
|
|
name: string
|
|
pull-message:
|
|
payload: string
|
|
tag: string
|
|
schedule-time: string
|
|
status:
|
|
attempt-dispatch-count: integer
|
|
attempt-response-count: integer
|
|
first-attempt-status:
|
|
dispatch-time: string
|
|
response-status:
|
|
code: integer
|
|
message: string
|
|
response-time: string
|
|
schedule-time: string
|
|
last-attempt-status:
|
|
dispatch-time: string
|
|
response-status:
|
|
code: integer
|
|
message: string
|
|
response-time: string
|
|
schedule-time: string
|
|
view: string
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . response-view=voluptua.</code><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>
|
|
<li><code>task.app-engine-http-request.app-engine-routing host=amet.</code><ul>
|
|
<li>Output only. The host that the task is sent to. For more information, see <a href="https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed">How Requests are Routed</a>. The host is constructed as: * <code>host = [application_domain_name]</code> <code>| [service] + &#39;.&#39; + [application_domain_name]</code> <code>| [version] + &#39;.&#39; + [application_domain_name]</code> <code>| [version_dot_service]+ &#39;.&#39; + [application_domain_name]</code> <code>| [instance] + &#39;.&#39; + [application_domain_name]</code> <code>| [instance_dot_service] + &#39;.&#39; + [application_domain_name]</code> <code>| [instance_dot_version] + &#39;.&#39; + [application_domain_name]</code> <code>| [instance_dot_version_dot_service] + &#39;.&#39; + [application_domain_name]</code> * <code>application_domain_name</code> = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * <code>service =</code> service * <code>version =</code> version * <code>version_dot_service =</code> version <code>+ &#39;.&#39; +</code> service * <code>instance =</code> instance * <code>instance_dot_service =</code> instance <code>+ &#39;.&#39; +</code> service * <code>instance_dot_version =</code> instance <code>+ &#39;.&#39; +</code> version * <code>instance_dot_version_dot_service =</code> instance <code>+ &#39;.&#39; +</code> version <code>+ &#39;.&#39; +</code> service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>instance=consetetur</code><ul>
|
|
<li>App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if <a href="https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes">manual scaling is used in App Engine Standard</a>. App Engine Flex does not support instances. For more information, see <a href="https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed">App Engine Standard request routing</a> and <a href="https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed">App Engine Flex request routing</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service=diam</code><ul>
|
|
<li>App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version=dolor</code></p>
|
|
<ul>
|
|
<li>App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. headers=key=et</code></p>
|
|
<ul>
|
|
<li>HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * <code>User-Agent</code>: By default, this header is <code>&#34;AppEngine-Google; (+http://code.google.com/appengine)&#34;</code>. This header can be modified, but Cloud Tasks will append <code>&#34;AppEngine-Google; (+http://code.google.com/appengine)&#34;</code> to the modified <code>User-Agent</code>. If the task has a payload, Cloud Tasks sets the following headers: * <code>Content-Type</code>: By default, the <code>Content-Type</code> header is set to <code>&#34;application/octet-stream&#34;</code>. The default can be overridden by explicitly setting <code>Content-Type</code> to a particular media type when the task is created. For example, <code>Content-Type</code> can be set to <code>&#34;application/json&#34;</code>. * <code>Content-Length</code>: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * <code>Host</code> * <code>X-Google-*</code> * <code>X-AppEngine-*</code> In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see <a href="https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers">request headers</a>. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>http-method=et</code><ul>
|
|
<li>The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See <a href="https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler">Writing a push task request handler</a> and the App Engine documentation for your runtime on <a href="https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled">How Requests are Handled</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>payload=sadipscing</code><ul>
|
|
<li>Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>relative-url=stet</code></p>
|
|
<ul>
|
|
<li>The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=dolor</code></p>
|
|
<ul>
|
|
<li>Output only. The time that the task was created. <code>create_time</code> will be truncated to the nearest second.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=duo</code><ul>
|
|
<li>Optionally caller-specified in CreateTask. The task name. The task name must have the following format: <code>projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID</code> * <code>PROJECT_ID</code> can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see <a href="https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects">Identifying projects</a> * <code>LOCATION_ID</code> is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * <code>QUEUE_ID</code> can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * <code>TASK_ID</code> can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>pull-message payload=vero</code><ul>
|
|
<li>A data payload consumed by the worker to execute the task.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>tag=vero</code></p>
|
|
<ul>
|
|
<li>The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or <a href="https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-">bytes</a>, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. schedule-time=invidunt</code></p>
|
|
<ul>
|
|
<li>The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. <code>schedule_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status attempt-dispatch-count=36</code><ul>
|
|
<li>Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>attempt-response-count=25</code><ul>
|
|
<li>Output only. The number of attempts which have received a response. This field is not calculated for pull tasks.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>first-attempt-status dispatch-time=elitr</code><ul>
|
|
<li>Output only. The time that this attempt was dispatched. <code>dispatch_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>response-status code=95</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=diam</code></p>
|
|
<ul>
|
|
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. response-time=no</code></p>
|
|
<ul>
|
|
<li>Output only. The time that this attempt response was received. <code>response_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>schedule-time=ipsum</code></p>
|
|
<ul>
|
|
<li>Output only. The time that this attempt was scheduled. <code>schedule_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..last-attempt-status dispatch-time=accusam</code></p>
|
|
<ul>
|
|
<li>Output only. The time that this attempt was dispatched. <code>dispatch_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>response-status code=42</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=consetetur</code></p>
|
|
<ul>
|
|
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. response-time=voluptua.</code></p>
|
|
<ul>
|
|
<li>Output only. The time that this attempt response was received. <code>response_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>schedule-time=et</code></p>
|
|
<ul>
|
|
<li>Output only. The time that this attempt was scheduled. <code>schedule_time</code> will be truncated to the nearest microsecond.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... view=erat</code></p>
|
|
<ul>
|
|
<li>Output only. The view specifies which subset of the Task has been returned.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</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-right" title="Locations Queues Tasks Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../projects_locations-queues-tasks-cancel-lease" class="btn btn-neutral" title="Locations Queues Tasks Cancel Lease"><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_locations-queues-tasks-cancel-lease" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-queues-tasks-delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |