Socket
Socket
Sign inDemoInstall

@google-cloud/tasks

Package Overview
Dependencies
178
Maintainers
5
Versions
62
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 0.3.0 to 0.4.0

29

CHANGELOG.md

@@ -7,2 +7,31 @@ # Changelog

## v0.4.0
03-06-2019 13:30 PST
### New Features
- feat: add alpha support for HTTP triggers ([#177](https://github.com/googleapis/nodejs-tasks/pull/177))
### Bug fixes
- fix: throw on invalid credentials
### Documentation
- docs: update contributing path in README ([#168](https://github.com/googleapis/nodejs-tasks/pull/168))
- docs: move CONTRIBUTING.md to root ([#167](https://github.com/googleapis/nodejs-tasks/pull/167))
- docs: add lint/fix example to contributing guide ([#165](https://github.com/googleapis/nodejs-tasks/pull/165))
- docs: fix example comments ([#164](https://github.com/googleapis/nodejs-tasks/pull/164))
- docs: update comments on protos ([#180](https://github.com/googleapis/nodejs-tasks/pull/180))
- docs: sync latest proto docs
- docs: update README to include samples ([#178](https://github.com/googleapis/nodejs-tasks/pull/178))
- docs: update links in contrib guide ([#174](https://github.com/googleapis/nodejs-tasks/pull/174))
### Internal / Testing Changes
- build: update release configuration
- chore(deps): update dependency mocha to v6 ([#176](https://github.com/googleapis/nodejs-tasks/pull/176))
- build: use linkinator for docs test ([#173](https://github.com/googleapis/nodejs-tasks/pull/173))
- fix(deps): update dependency yargs to v13 ([#171](https://github.com/googleapis/nodejs-tasks/pull/171))
- build: create docs test npm scripts ([#170](https://github.com/googleapis/nodejs-tasks/pull/170))
- build: test using @grpc/grpc-js in CI ([#169](https://github.com/googleapis/nodejs-tasks/pull/169))
- refactor: improve generated code style. ([#163](https://github.com/googleapis/nodejs-tasks/pull/163))
## v0.3.0

@@ -9,0 +38,0 @@

11

package.json
{
"name": "@google-cloud/tasks",
"description": "Cloud Tasks API client for Node.js",
"version": "0.3.0",
"version": "0.4.0",
"license": "Apache-2.0",

@@ -41,3 +41,5 @@ "author": "Google LLC",

"system-test": "mocha system-test/ smoke-test/ --timeout 600000",
"fix": "eslint '**/*.js' --fix"
"fix": "eslint '**/*.js' --fix",
"docs-test": "linkinator docs -r --skip www.googleapis.com",
"predocs-test": "npm run docs"
},

@@ -58,7 +60,8 @@ "dependencies": {

"jsdoc": "^3.5.5",
"mocha": "^5.2.0",
"mocha": "^6.0.0",
"nyc": "^13.0.0",
"power-assert": "^1.5.0",
"prettier": "^1.13.5"
"prettier": "^1.13.5",
"linkinator": "^1.1.2"
}
}

73

README.md

@@ -27,6 +27,4 @@ [//]: # "This README.md file is auto-generated, all changes to this file will be lost."

* [Quickstart](#quickstart)
* [Before you begin](#before-you-begin)
* [Installing the client library](#installing-the-client-library)
* [Using the client library](#using-the-client-library)
* [Using the client library](#using-the-client-library)
* [Samples](#samples)
* [Versioning](#versioning)

@@ -36,31 +34,59 @@ * [Contributing](#contributing)

## Quickstart
## Using the client library
### Before you begin
1. [Select or create a Cloud Platform project][projects].
1. Select or create a Cloud Platform project.
1. [Enable billing for your project][billing].
[Go to the projects page][projects]
1. [Enable the Google Cloud Tasks API][enable_api].
1. Enable billing for your project.
1. [Set up authentication with a service account][auth] so you can access the
API from your local workstation.
[Enable billing][billing]
1. Install the client library:
1. Enable the Google Cloud Tasks API.
npm install --save @google-cloud/tasks
[Enable the API][enable_api]
1. Try an example:
1. [Set up authentication with a service account][auth] so you can access the
API from your local workstation.
```js
// Imports the Google Cloud client library
const {CloudTasksClient} = require('@google-cloud/tasks');
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=tasks.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started
async function quickstart(
projectId = 'your-project-id', // Your Google Cloud Platform project ID
queue = 'my-appengine-queue', // Name of the Queue to create
location = 'us-central-1' // The region in which to create the queue
) {
// Instantiates a client
const client = new CloudTasksClient();
### Installing the client library
// Send create queue request.
const [response] = await client.createQueue({
// The fully qualified path to the location where the queue is created
parent: client.locationPath(projectId, location),
queue: {
// The fully qualified path to the queue
name: client.queuePath(projectId, location, queue),
appEngineHttpQueue: {
appEngineRoutingOverride: {
// The App Engine service that will receive the tasks.
service: 'default',
},
},
},
});
console.log(`Created queue ${response.name}`);
}
```
npm install --save @google-cloud/tasks
## Samples
Samples are in the [`samples/`](https://github.com/googleapis/nodejs-tasks/tree/master/samples) directory. The samples' `README.md`
has instructions for running the samples.
| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Queues | [source code](https://github.com/googleapis/nodejs-tasks/blob/master/samples/createQueue.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-tasks&page=editor&open_in_editor=samples/createQueue.js,samples/README.md) |
| Tasks | [source code](https://github.com/googleapis/nodejs-tasks/blob/master/samples/createTask.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-tasks&page=editor&open_in_editor=samples/createTask.js,samples/README.md) |

@@ -84,3 +110,3 @@ The [Cloud Tasks Node.js Client API Reference][client-docs] documentation

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-tasks/blob/master/.github/CONTRIBUTING.md).
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-tasks/blob/master/CONTRIBUTING.md).

@@ -96,2 +122,5 @@ ## License

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=tasks.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started

296

src/v2beta2/doc/google/cloud/tasks/v2beta2/doc_cloudtasks.js

@@ -19,3 +19,4 @@ // Copyright 2019 Google LLC

/**
* Request message for ListQueues.
* Request message for
* ListQueues.
*

@@ -29,7 +30,7 @@ * @property {string} parent

* @property {string} filter
* `filter` can be used to specify a subset of queues. Any Queue
* field can be used as a filter and several operators as supported.
* For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
* described in
* [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
* `filter` can be used to specify a subset of queues. Any
* Queue field can be used as a filter and
* several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
* filter syntax is the same as described in [Stackdriver's Advanced Logs
* Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
*

@@ -47,4 +48,4 @@ * Sample filter "app_engine_http_target: *".

* even if more queues exist; use the
* next_page_token in the
* response to determine if more queues exist.
* next_page_token
* in the response to determine if more queues exist.
*

@@ -56,6 +57,8 @@ * @property {string} pageToken

* request the next page of results, page_token must be the value of
* next_page_token returned
* from the previous call to ListQueues
* method. It is an error to switch the value of the
* filter while iterating through pages.
* next_page_token
* returned from the previous call to
* ListQueues method. It
* is an error to switch the value of the
* filter while
* iterating through pages.
*

@@ -71,3 +74,4 @@ * @typedef ListQueuesRequest

/**
* Response message for ListQueues.
* Response message for
* ListQueues.
*

@@ -83,3 +87,4 @@ * @property {Object[]} queues

* To return the next page of results, call
* ListQueues with this value as the
* ListQueues with this
* value as the
* page_token.

@@ -100,3 +105,4 @@ *

/**
* Request message for GetQueue.
* Request message for
* GetQueue.
*

@@ -118,3 +124,4 @@ * @property {string} name

/**
* Request message for CreateQueue.
* Request message for
* CreateQueue.
*

@@ -136,3 +143,4 @@ * @property {string} parent

*
* Queue's name cannot be the same as an existing queue.
* Queue's name cannot be the same as
* an existing queue.
*

@@ -150,3 +158,4 @@ * This object should have the same structure as [Queue]{@link google.cloud.tasks.v2beta2.Queue}

/**
* Request message for UpdateQueue.
* Request message for
* UpdateQueue.
*

@@ -158,7 +167,9 @@ * @property {Object} queue

*
* The queue's name must be specified.
* The queue's name must be
* specified.
*
* Output only fields cannot be modified using UpdateQueue.
* Any value specified for an output only field will be ignored.
* The queue's name cannot be changed.
* The queue's name cannot be
* changed.
*

@@ -183,3 +194,4 @@ * This object should have the same structure as [Queue]{@link google.cloud.tasks.v2beta2.Queue}

/**
* Request message for DeleteQueue.
* Request message for
* DeleteQueue.
*

@@ -201,3 +213,4 @@ * @property {string} name

/**
* Request message for PurgeQueue.
* Request message for
* PurgeQueue.
*

@@ -219,3 +232,4 @@ * @property {string} name

/**
* Request message for PauseQueue.
* Request message for
* PauseQueue.
*

@@ -237,3 +251,4 @@ * @property {string} name

/**
* Request message for ResumeQueue.
* Request message for
* ResumeQueue.
*

@@ -255,3 +270,4 @@ * @property {string} name

/**
* Request message for listing tasks using ListTasks.
* Request message for listing tasks using
* ListTasks.
*

@@ -265,14 +281,15 @@ * @property {string} parent

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -287,4 +304,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

* even if more tasks exist; use
* next_page_token in the
* response to determine if more tasks exist.
* next_page_token
* in the response to determine if more tasks exist.
*

@@ -296,5 +313,5 @@ * @property {string} pageToken

* request the next page of results, page_token must be the value of
* next_page_token returned
* from the previous call to ListTasks
* method.
* next_page_token
* returned from the previous call to
* ListTasks method.
*

@@ -312,3 +329,4 @@ * The page token is valid for only 2 hours.

/**
* Response message for listing tasks using ListTasks.
* Response message for listing tasks using
* ListTasks.
*

@@ -324,3 +342,4 @@ * @property {Object[]} tasks

* To return the next page of results, call
* ListTasks with this value as the
* ListTasks with this
* value as the
* page_token.

@@ -339,3 +358,4 @@ *

/**
* Request message for getting a task using GetTask.
* Request message for getting a task using
* GetTask.
*

@@ -349,14 +369,15 @@ * @property {string} name

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -374,3 +395,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

/**
* Request message for CreateTask.
* Request message for
* CreateTask.
*

@@ -392,9 +414,9 @@ * @property {string} parent

* `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
* The user can optionally specify a task name. If a
* name is not specified then the system will generate a random
* unique task id, which will be set in the task returned in the
* response.
* The user can optionally specify a task
* name. If a name is not specified
* then the system will generate a random unique task id, which will be set in
* the task returned in the response.
*
* If schedule_time is not set or is in the
* past then Cloud Tasks will set it to the current time.
* If schedule_time is not
* set or is in the past then Cloud Tasks will set it to the current time.
*

@@ -414,6 +436,6 @@ * Task De-duplication:

* Because there is an extra lookup cost to identify duplicate task
* names, these CreateTask calls have significantly
* increased latency. Using hashed strings for the task id or for
* the prefix of the task id is recommended. Choosing task ids that
* are sequential or have sequential prefixes, for example using a
* names, these CreateTask
* calls have significantly increased latency. Using hashed strings for the
* task id or for the prefix of the task id is recommended. Choosing task ids
* that are sequential or have sequential prefixes, for example using a
* timestamp, causes an increase in latency and error rates in all

@@ -427,14 +449,15 @@ * task commands. The infrastructure relies on an approximately

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -470,3 +493,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

/**
* Request message for leasing tasks using LeaseTasks.
* Request message for leasing tasks using
* LeaseTasks.
*

@@ -490,6 +514,7 @@ * @property {string} parent

* with the task, the worker must call via
* AcknowledgeTask before the
* schedule_time. Otherwise the task will be
* returned to a later LeaseTasks call so
* that another worker can retry it.
* AcknowledgeTask
* before the schedule_time.
* Otherwise the task will be returned to a later
* LeaseTasks call so that
* another worker can retry it.
*

@@ -502,14 +527,15 @@ * The maximum lease duration is 1 week.

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -522,9 +548,10 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

* When `filter` is set to `tag=<my-tag>` then the
* response will contain only tasks whose
* tag is equal to `<my-tag>`. `<my-tag>` must be
* less than 500 characters.
* response will contain only
* tasks whose tag is equal to
* `<my-tag>`. `<my-tag>` must be less than 500 characters.
*
* When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
* the same tag as the task with the oldest
* schedule_time will be returned.
* schedule_time will be
* returned.
*

@@ -547,4 +574,5 @@ * Grammar Syntax:

* aren't UTF-8 encoded can't be used in the
* filter and the task's
* tag will be displayed as empty in Cloud Tasks.
* filter and the
* task's tag will be displayed
* as empty in Cloud Tasks.
*

@@ -560,3 +588,4 @@ * @typedef LeaseTasksRequest

/**
* Response message for leasing tasks using LeaseTasks.
* Response message for leasing tasks using
* LeaseTasks.
*

@@ -592,4 +621,4 @@ * @property {Object[]} tasks

* LeaseTasks response or
* RenewLease response. This restriction is
* to ensure that your worker currently holds the lease.
* RenewLease response.
* This restriction is to ensure that your worker currently holds the lease.
*

@@ -622,4 +651,4 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* LeaseTasks response or
* RenewLease response. This restriction is
* to ensure that your worker currently holds the lease.
* RenewLease response.
* This restriction is to ensure that your worker currently holds the lease.
*

@@ -640,14 +669,15 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -680,4 +710,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

* LeaseTasks response or
* RenewLease response. This restriction is
* to ensure that your worker currently holds the lease.
* RenewLease response.
* This restriction is to ensure that your worker currently holds the lease.
*

@@ -687,14 +717,15 @@ * This object should have the same structure as [Timestamp]{@link google.protobuf.Timestamp}

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -722,14 +753,15 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -736,0 +768,0 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

171

src/v2beta2/doc/google/cloud/tasks/v2beta2/doc_queue.js

@@ -24,4 +24,5 @@ // Copyright 2019 Google LLC

* @property {string} name
* Caller-specified and required in CreateQueue,
* after which it becomes output only.
* Caller-specified and required in
* CreateQueue, after
* which it becomes output only.
*

@@ -36,3 +37,4 @@ * The queue name.

* For more information, see
* [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* [Identifying
* projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* * `LOCATION_ID` is the canonical ID for the queue's location.

@@ -48,3 +50,4 @@ * The list of available locations can be obtained by calling

*
* An App Engine queue is a queue that has an AppEngineHttpTarget.
* An App Engine queue is a queue that has an
* AppEngineHttpTarget.
*

@@ -56,3 +59,4 @@ * This object should have the same structure as [AppEngineHttpTarget]{@link google.cloud.tasks.v2beta2.AppEngineHttpTarget}

*
* A pull queue is a queue that has a PullTarget.
* A pull queue is a queue that has a
* PullTarget.
*

@@ -65,14 +69,16 @@ * This object should have the same structure as [PullTarget]{@link google.cloud.tasks.v2beta2.PullTarget}

* rate_limits and
* retry_config are related because they both
* control task attempts however they control how tasks are
* retry_config are related
* because they both control task attempts however they control how tasks are
* attempted in different ways:
*
* * rate_limits controls the total rate of
* * rate_limits controls the
* total rate of
* dispatches from a queue (i.e. all traffic dispatched from the
* queue, regardless of whether the dispatch is from a first
* attempt or a retry).
* * retry_config controls what happens to
* * retry_config controls
* what happens to
* particular a task after its first attempt fails. That is,
* retry_config controls task retries (the
* second attempt, third attempt, etc).
* retry_config controls
* task retries (the second attempt, third attempt, etc).
*

@@ -90,3 +96,4 @@ * This object should have the same structure as [RateLimits]{@link google.cloud.tasks.v2beta2.RateLimits}

* explicitly set on the task and were created by the App Engine SDK. See
* [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
* [App Engine
* documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
*

@@ -100,5 +107,7 @@ * This object should have the same structure as [RetryConfig]{@link google.cloud.tasks.v2beta2.RetryConfig}

* PauseQueue,
* ResumeQueue, or uploading
* ResumeQueue, or
* uploading
* [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
* UpdateQueue cannot be used to change `state`.
* UpdateQueue cannot be
* used to change `state`.
*

@@ -110,7 +119,9 @@ * The number should be among the values of [State]{@link google.cloud.tasks.v2beta2.State}

*
* All tasks that were created before this time
* were purged.
* All tasks that were created
* before this time were purged.
*
* A queue can be purged using PurgeQueue, the
* [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
* A queue can be purged using
* PurgeQueue, the [App
* Engine Task Queue SDK, or the Cloud
* Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
*

@@ -158,4 +169,4 @@ * Purge time will be truncated to the nearest microsecond. Purge

* still be added to it by the user. When a pull queue is paused,
* all LeaseTasks calls will return a
* FAILED_PRECONDITION.
* all LeaseTasks calls
* will return a FAILED_PRECONDITION.
*/

@@ -168,10 +179,12 @@ PAUSED: 2,

* A queue becomes `DISABLED` when
* [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) or
* [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) is uploaded
* which does not contain the queue. You cannot directly disable a queue.
* [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
* or
* [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref)
* is uploaded which does not contain the queue. You cannot directly disable
* a queue.
*
* When a queue is disabled, tasks can still be added to a queue
* but the tasks are not dispatched and
* LeaseTasks calls return a
* `FAILED_PRECONDITION` error.
* LeaseTasks calls
* return a `FAILED_PRECONDITION` error.
*

@@ -191,4 +204,6 @@ * To permanently delete this queue and all of its tasks, call

*
* Note: The debugging command, RunTask, will run a task
* even if the queue has reached its RateLimits.
* Note: The debugging command,
* RunTask, will run a task
* even if the queue has reached its
* RateLimits.
*

@@ -201,11 +216,15 @@ * @property {number} maxTasksDispatchedPerSecond

*
* * For App Engine queues, the maximum allowed value
* * For App Engine queues,
* the maximum allowed value
* is 500.
* * This field is output only for pull queues. In addition to the
* * This field is output only for pull
* queues. In addition to the
* `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
* LeaseTasks requests are allowed per pull queue.
* LeaseTasks requests
* are allowed per pull queue.
*
*
* This field has the same meaning as
* [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
* [rate in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
*

@@ -238,5 +257,5 @@ * @property {number} maxBurstSize

* Since `max_burst_size` is output only, if
* UpdateQueue is called on a queue
* created by `queue.yaml/xml`, `max_burst_size` will be reset based
* on the value of
* UpdateQueue is called
* on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset
* based on the value of
* max_tasks_dispatched_per_second,

@@ -260,8 +279,10 @@ * regardless of whether

* This field is output only for
* pull queues and always -1, which indicates no limit. No other
* queue types can have `max_concurrent_tasks` set to -1.
* pull queues and always -1, which
* indicates no limit. No other queue types can have `max_concurrent_tasks`
* set to -1.
*
*
* This field has the same meaning as
* [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
* [max_concurrent_requests in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
*

@@ -295,5 +316,5 @@ * @typedef RateLimits

* attempted. Once `max_retry_duration` time has passed *and* the
* task has been attempted max_attempts
* times, no further attempts will be made and the task will be
* deleted.
* task has been attempted
* max_attempts times,
* no further attempts will be made and the task will be deleted.
*

@@ -305,3 +326,4 @@ * If zero, then the task age is unlimited.

*
* This field is output only for pull queues.
* This field is output only for pull
* queues.
*

@@ -312,3 +334,4 @@ *

* This field has the same meaning as
* [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [task_age_limit in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -318,7 +341,9 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* @property {Object} minBackoff
* A task will be scheduled for retry between
* A task will be scheduled
* for retry between
* min_backoff and
* max_backoff duration after it fails,
* if the queue's RetryConfig specifies that the task should be
* retried.
* max_backoff duration
* after it fails, if the queue's
* RetryConfig specifies that the
* task should be retried.
*

@@ -328,3 +353,4 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

*
* This field is output only for pull queues.
* This field is output only for pull
* queues.
*

@@ -335,3 +361,4 @@ *

* This field has the same meaning as
* [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [min_backoff_seconds in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -341,7 +368,9 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* @property {Object} maxBackoff
* A task will be scheduled for retry between
* A task will be scheduled
* for retry between
* min_backoff and
* max_backoff duration after it fails,
* if the queue's RetryConfig specifies that the task should be
* retried.
* max_backoff duration
* after it fails, if the queue's
* RetryConfig specifies that the
* task should be retried.
*

@@ -351,3 +380,4 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

*
* This field is output only for pull queues.
* This field is output only for pull
* queues.
*

@@ -358,3 +388,4 @@ *

* This field has the same meaning as
* [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [max_backoff_seconds in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -367,17 +398,19 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* A task's retry interval starts at
* min_backoff, then doubles
* `max_doublings` times, then increases linearly, and finally
* retries retries at intervals of
* min_backoff, then
* doubles `max_doublings` times, then increases linearly, and finally retries
* retries at intervals of
* max_backoff up to
* max_attempts times.
*
* For example, if min_backoff is 10s,
* max_backoff is 300s, and
* `max_doublings` is 3, then the a task will first be retried in
* 10s. The retry interval will double three times, and then
* increase linearly by 2^3 * 10s. Finally, the task will retry at
* intervals of max_backoff until the
* task has been attempted max_attempts
* times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
* 240s, 300s, 300s, ....
* For example, if
* min_backoff is 10s,
* max_backoff is 300s,
* and `max_doublings` is 3, then the a task will first be retried in 10s. The
* retry interval will double three times, and then increase linearly by 2^3 *
* 10s. Finally, the task will retry at intervals of
* max_backoff until the
* task has been attempted
* max_attempts times.
* Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
* 300s, ....
*

@@ -387,7 +420,9 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

*
* This field is output only for pull queues.
* This field is output only for pull
* queues.
*
*
* This field has the same meaning as
* [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [max_doublings in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -394,0 +429,0 @@ * @typedef RetryConfig

179

src/v2beta2/doc/google/cloud/tasks/v2beta2/doc_target.js

@@ -30,3 +30,4 @@ // Copyright 2019 Google LLC

* The pull message contains data that can be used by the caller of
* LeaseTasks to process the task.
* LeaseTasks to process the
* task.
*

@@ -44,6 +45,7 @@ * This proto can only be used for tasks in a queue which has

* 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.
* 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.
*

@@ -56,3 +58,4 @@ * The task's tag can only be set when the

* SDK compatibility: Although the SDK allows tags to be either
* string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
* string or
* [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
* only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8

@@ -73,7 +76,11 @@ * encoded, the tag will be empty when the task is returned by Cloud Tasks.

* The task will be delivered to the App Engine application hostname
* specified by its AppEngineHttpTarget and AppEngineHttpRequest.
* The documentation for AppEngineHttpRequest explains how the
* task's host URL is constructed.
* specified by its
* AppEngineHttpTarget and
* AppEngineHttpRequest. The
* documentation for
* AppEngineHttpRequest
* explains how the task's host URL is constructed.
*
* Using AppEngineHttpTarget requires
* Using AppEngineHttpTarget
* requires
* [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)

@@ -87,7 +94,9 @@ * Google IAM permission for the project

* Overrides for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*
* If set, `app_engine_routing_override` is used for all tasks in
* the queue, no matter what the setting is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -111,5 +120,7 @@ * This object should have the same structure as [AppEngineRouting]{@link google.cloud.tasks.v2beta2.AppEngineRouting}

* This proto can only be used for tasks in a queue which has
* app_engine_http_target set.
* app_engine_http_target
* set.
*
* Using AppEngineHttpRequest requires
* Using AppEngineHttpRequest
* requires
* [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)

@@ -123,8 +134,11 @@ * Google IAM permission for the project

* project as the queue. For more information, see
* [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* [How Requests are
* Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and how routing is affected by
* [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
* [dispatch
* files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
*
* The AppEngineRouting used to construct the URL that the task is
* delivered to can be set at the queue-level or task-level:
* The AppEngineRouting used to
* construct the URL that the task is delivered to can be set at the queue-level
* or task-level:
*

@@ -135,3 +149,4 @@ * * If set,

* is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -158,6 +173,8 @@ *

* with error code 405 (Method Not Allowed). See
* [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* [Writing a push task request
* handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* and the documentation for the request handlers in the language your app is
* written in e.g.
* [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
* [Python Request
* Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
*

@@ -172,3 +189,4 @@ * The number should be among the values of [HttpMethod]{@link google.cloud.tasks.v2beta2.HttpMethod}

* is used for all tasks in the queue, no matter what the setting is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -201,3 +219,4 @@ * This object should have the same structure as [AppEngineRouting]{@link google.cloud.tasks.v2beta2.AppEngineRouting}

*
* If the task has a payload, Cloud
* If the task has a
* payload, Cloud
* Tasks sets the following headers:

@@ -221,3 +240,4 @@ *

* such as headers containing information about the task; see
* [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
* [request
* headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not

@@ -227,4 +247,6 @@ * 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.
* the size, there is a limit on the maximum size of the
* Task. For more information, see the
* CreateTask
* documentation.
*

@@ -251,6 +273,10 @@ * @property {string} payload

* For more information about services, versions, and instances see
* [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
* [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
* [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
* and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
* [An Overview of App
* Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
* [Microservices Architecture on Google App
* Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
* [App Engine Standard request
* routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
* and [App Engine Flex request
* routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
*

@@ -264,12 +290,14 @@ * @property {string} service

* 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
* Task Queue API, host is
* not parsable into
* service,
* version, and
* instance are the empty string.
* 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.
*

@@ -283,12 +311,14 @@ * @property {string} version

* 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
* Task Queue API, host is
* not parsable into
* service,
* version, and
* instance are the empty string.
* 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.
*

@@ -302,6 +332,9 @@ * @property {string} instance

* Requests can only be sent to a specific instance if
* [manual scaling is used in App Engine Standard](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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
* App Engine Flex does not support instances. For more information, see
* [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
* [App Engine Standard request
* routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and [App Engine Flex request
* routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
*

@@ -312,3 +345,4 @@ * @property {string} host

* For more information, see
* [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
* [How Requests are
* Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
*

@@ -332,5 +366,7 @@ * The host is constructed as:

*
* * `service =` service
* * `service =`
* service
*
* * `version =` version
* * `version =`
* version
*

@@ -341,32 +377,35 @@ * * `version_dot_service =`

*
* * `instance =` instance
* * `instance =`
* instance
*
* * `instance_dot_service =`
* instance `+ '.' +`
* service
* instance `+ '.'
* +` service
*
* * `instance_dot_version =`
* instance `+ '.' +`
* version
* instance `+ '.'
* +` version
*
* * `instance_dot_version_dot_service =`
* instance `+ '.' +`
* version `+ '.' +`
* service
* instance `+ '.'
* +` version `+ '.'
* +` 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 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 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 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.
* instance is
* invalid, then the task will be sent to the default version of the default
* service when the task is attempted.
*

@@ -373,0 +412,0 @@ * @typedef AppEngineRouting

68

src/v2beta2/doc/google/cloud/tasks/v2beta2/doc_task.js

@@ -22,3 +22,4 @@ // Copyright 2019 Google LLC

* @property {string} name
* Optionally caller-specified in CreateTask.
* Optionally caller-specified in
* CreateTask.
*

@@ -33,3 +34,4 @@ * The task name.

* For more information, see
* [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* [Identifying
* projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* * `LOCATION_ID` is the canonical ID for the task's location.

@@ -47,6 +49,8 @@ * The list of available locations can be obtained by calling

* be set only if
* app_engine_http_target is set
* on the queue.
* app_engine_http_target
* is set on the queue.
*
* An App Engine task is a task that has AppEngineHttpRequest set.
* An App Engine task is a task that has
* AppEngineHttpRequest
* set.
*

@@ -56,6 +60,9 @@ * This object should have the same structure as [AppEngineHttpRequest]{@link google.cloud.tasks.v2beta2.AppEngineHttpRequest}

* @property {Object} pullMessage
* LeaseTasks to process the task. Can be
* set only if pull_target is set on the queue.
* LeaseTasks to process
* the task. Can be set only if
* pull_target is set on the
* queue.
*
* A pull task is a task that has PullMessage set.
* A pull task is a task that has
* PullMessage set.
*

@@ -72,3 +79,4 @@ * This object should have the same structure as [PullMessage]{@link google.cloud.tasks.v2beta2.PullMessage}

* the current lease expires, that is, the time that the task was
* leased plus the lease_duration.
* leased plus the
* lease_duration.
*

@@ -92,4 +100,4 @@ * `schedule_time` will be truncated to the nearest microsecond.

* @property {number} view
* Output only. The view specifies which subset of the Task has
* been returned.
* Output only. The view specifies which subset of the
* Task has been returned.
*

@@ -106,3 +114,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta2.View}

/**
* The view specifies a subset of Task data.
* The view specifies a subset of Task
* data.
*

@@ -130,7 +139,9 @@ * When a task is returned in a response, not all

* This view does not include the
* (payload in AppEngineHttpRequest and
* payload in PullMessage). These payloads are
* desirable to return only when needed, because they can be large
* and because of the sensitivity of the data that you choose to
* store in it.
* (payload in
* AppEngineHttpRequest
* and payload in
* PullMessage). These
* payloads are desirable to return only when needed, because they can be
* large and because of the sensitivity of the data that you choose to store
* in it.
*/

@@ -142,5 +153,6 @@ BASIC: 1,

*
* Authorization for FULL requires
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Queue resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Queue resource.
*/

@@ -163,3 +175,4 @@ FULL: 2

*
* This field is not calculated for pull tasks.
* This field is not calculated for pull
* tasks.
*

@@ -169,6 +182,10 @@ * @property {Object} firstAttemptStatus

*
* Only dispatch_time will be set.
* The other AttemptStatus information is not retained by Cloud Tasks.
* Only
* dispatch_time
* will be set. The other
* AttemptStatus information is
* not retained by Cloud Tasks.
*
* This field is not calculated for pull tasks.
* This field is not calculated for pull
* tasks.
*

@@ -180,3 +197,4 @@ * This object should have the same structure as [AttemptStatus]{@link google.cloud.tasks.v2beta2.AttemptStatus}

*
* This field is not calculated for pull tasks.
* This field is not calculated for pull
* tasks.
*

@@ -183,0 +201,0 @@ * This object should have the same structure as [AttemptStatus]{@link google.cloud.tasks.v2beta2.AttemptStatus}

31

src/v2beta2/doc/google/rpc/doc_status.js

@@ -19,5 +19,5 @@ // Copyright 2019 Google LLC

/**
* The `Status` type defines a logical error model that is suitable for different
* programming environments, including REST APIs and RPC APIs. It is used by
* [gRPC](https://github.com/grpc). The error model is designed to be:
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
*

@@ -29,11 +29,12 @@ * - Simple to use and understand for most users

*
* The `Status` message contains three pieces of data: error code, error message,
* and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes if needed. The
* error message should be a developer-facing English message that helps
* developers *understand* and *resolve* the error. If a localized user-facing
* error message is needed, put the localized message in the error details or
* localize it in the client. The optional error details may contain arbitrary
* information about the error. There is a predefined set of error detail types
* in the package `google.rpc` that can be used for common error conditions.
* The `Status` message contains three pieces of data: error code, error
* message, and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes
* if needed. The error message should be a developer-facing English message
* that helps developers *understand* and *resolve* the error. If a localized
* user-facing error message is needed, put the localized message in the error
* details or localize it in the client. The optional error details may contain
* arbitrary information about the error. There is a predefined set of error
* detail types in the package `google.rpc` that can be used for common error
* conditions.
*

@@ -75,3 +76,4 @@ * # Language mapping

* @property {number} code
* The status code, which should be an enum value of google.rpc.Code.
* The status code, which should be an enum value of
* google.rpc.Code.
*

@@ -81,3 +83,4 @@ * @property {string} message

* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
* google.rpc.Status.details field, or localized
* by the client.
*

@@ -84,0 +87,0 @@ * @property {Object[]} details

192

src/v2beta3/doc/google/cloud/tasks/v2beta3/doc_cloudtasks.js

@@ -19,3 +19,4 @@ // Copyright 2019 Google LLC

/**
* Request message for ListQueues.
* Request message for
* ListQueues.
*

@@ -29,7 +30,7 @@ * @property {string} parent

* @property {string} filter
* `filter` can be used to specify a subset of queues. Any Queue
* field can be used as a filter and several operators as supported.
* For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
* described in
* [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
* `filter` can be used to specify a subset of queues. Any
* Queue field can be used as a filter and
* several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
* filter syntax is the same as described in [Stackdriver's Advanced Logs
* Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
*

@@ -47,4 +48,4 @@ * Sample filter "state: PAUSED".

* even if more queues exist; use the
* next_page_token in the
* response to determine if more queues exist.
* next_page_token
* in the response to determine if more queues exist.
*

@@ -56,6 +57,8 @@ * @property {string} pageToken

* request the next page of results, page_token must be the value of
* next_page_token returned
* from the previous call to ListQueues
* method. It is an error to switch the value of the
* filter while iterating through pages.
* next_page_token
* returned from the previous call to
* ListQueues method. It
* is an error to switch the value of the
* filter while
* iterating through pages.
*

@@ -71,3 +74,4 @@ * @typedef ListQueuesRequest

/**
* Response message for ListQueues.
* Response message for
* ListQueues.
*

@@ -83,3 +87,4 @@ * @property {Object[]} queues

* To return the next page of results, call
* ListQueues with this value as the
* ListQueues with this
* value as the
* page_token.

@@ -100,3 +105,4 @@ *

/**
* Request message for GetQueue.
* Request message for
* GetQueue.
*

@@ -118,3 +124,4 @@ * @property {string} name

/**
* Request message for CreateQueue.
* Request message for
* CreateQueue.
*

@@ -136,3 +143,4 @@ * @property {string} parent

*
* Queue's name cannot be the same as an existing queue.
* Queue's name cannot be the same as
* an existing queue.
*

@@ -150,3 +158,4 @@ * This object should have the same structure as [Queue]{@link google.cloud.tasks.v2beta3.Queue}

/**
* Request message for UpdateQueue.
* Request message for
* UpdateQueue.
*

@@ -158,7 +167,9 @@ * @property {Object} queue

*
* The queue's name must be specified.
* The queue's name must be
* specified.
*
* Output only fields cannot be modified using UpdateQueue.
* Any value specified for an output only field will be ignored.
* The queue's name cannot be changed.
* The queue's name cannot be
* changed.
*

@@ -183,3 +194,4 @@ * This object should have the same structure as [Queue]{@link google.cloud.tasks.v2beta3.Queue}

/**
* Request message for DeleteQueue.
* Request message for
* DeleteQueue.
*

@@ -201,3 +213,4 @@ * @property {string} name

/**
* Request message for PurgeQueue.
* Request message for
* PurgeQueue.
*

@@ -219,3 +232,4 @@ * @property {string} name

/**
* Request message for PauseQueue.
* Request message for
* PauseQueue.
*

@@ -237,3 +251,4 @@ * @property {string} name

/**
* Request message for ResumeQueue.
* Request message for
* ResumeQueue.
*

@@ -255,3 +270,4 @@ * @property {string} name

/**
* Request message for listing tasks using ListTasks.
* Request message for listing tasks using
* ListTasks.
*

@@ -265,14 +281,15 @@ * @property {string} parent

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -287,4 +304,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta3.View}

* even if more tasks exist; use
* next_page_token in the
* response to determine if more tasks exist.
* next_page_token
* in the response to determine if more tasks exist.
*

@@ -296,5 +313,5 @@ * @property {string} pageToken

* request the next page of results, page_token must be the value of
* next_page_token returned
* from the previous call to ListTasks
* method.
* next_page_token
* returned from the previous call to
* ListTasks method.
*

@@ -312,3 +329,4 @@ * The page token is valid for only 2 hours.

/**
* Response message for listing tasks using ListTasks.
* Response message for listing tasks using
* ListTasks.
*

@@ -324,3 +342,4 @@ * @property {Object[]} tasks

* To return the next page of results, call
* ListTasks with this value as the
* ListTasks with this
* value as the
* page_token.

@@ -339,3 +358,4 @@ *

/**
* Request message for getting a task using GetTask.
* Request message for getting a task using
* GetTask.
*

@@ -349,14 +369,15 @@ * @property {string} name

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -374,3 +395,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta3.View}

/**
* Request message for CreateTask.
* Request message for
* CreateTask.
*

@@ -392,9 +414,9 @@ * @property {string} parent

* `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
* The user can optionally specify a task name. If a
* name is not specified then the system will generate a random
* unique task id, which will be set in the task returned in the
* response.
* The user can optionally specify a task
* name. If a name is not specified
* then the system will generate a random unique task id, which will be set in
* the task returned in the response.
*
* If schedule_time is not set or is in the
* past then Cloud Tasks will set it to the current time.
* If schedule_time is not
* set or is in the past then Cloud Tasks will set it to the current time.
*

@@ -414,6 +436,6 @@ * Task De-duplication:

* Because there is an extra lookup cost to identify duplicate task
* names, these CreateTask calls have significantly
* increased latency. Using hashed strings for the task id or for
* the prefix of the task id is recommended. Choosing task ids that
* are sequential or have sequential prefixes, for example using a
* names, these CreateTask
* calls have significantly increased latency. Using hashed strings for the
* task id or for the prefix of the task id is recommended. Choosing task ids
* that are sequential or have sequential prefixes, for example using a
* timestamp, causes an increase in latency and error rates in all

@@ -427,14 +449,15 @@ * task commands. The infrastructure relies on an approximately

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -480,14 +503,15 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta3.View}

* @property {number} responseView
* The response_view specifies which subset of the Task will be
* returned.
* 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.
* 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
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Task resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Task resource.
*

@@ -494,0 +518,0 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta3.View}

139

src/v2beta3/doc/google/cloud/tasks/v2beta3/doc_queue.js

@@ -24,4 +24,5 @@ // Copyright 2019 Google LLC

* @property {string} name
* Caller-specified and required in CreateQueue,
* after which it becomes output only.
* Caller-specified and required in
* CreateQueue, after
* which it becomes output only.
*

@@ -36,3 +37,4 @@ * The queue name.

* For more information, see
* [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* [Identifying
* projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* * `LOCATION_ID` is the canonical ID for the queue's location.

@@ -46,4 +48,7 @@ * The list of available locations can be obtained by calling

* @property {Object} appEngineHttpQueue
* AppEngineHttpQueue settings apply only to
* App Engine tasks in this queue.
* AppEngineHttpQueue
* settings apply only to App Engine
* tasks in this queue.
* Http tasks are not affected by
* this proto.
*

@@ -55,14 +60,17 @@ * This object should have the same structure as [AppEngineHttpQueue]{@link google.cloud.tasks.v2beta3.AppEngineHttpQueue}

*
* rate_limits and retry_config are
* related because they both control task attempts. However they control task
* attempts in different ways:
* rate_limits and
* retry_config are related
* because they both control task attempts. However they control task attempts
* in different ways:
*
* * rate_limits controls the total rate of
* * rate_limits controls the
* total rate of
* dispatches from a queue (i.e. all traffic dispatched from the
* queue, regardless of whether the dispatch is from a first
* attempt or a retry).
* * retry_config controls what happens to
* * retry_config controls
* what happens to
* particular a task after its first attempt fails. That is,
* retry_config controls task retries (the
* second attempt, third attempt, etc).
* retry_config controls
* task retries (the second attempt, third attempt, etc).
*

@@ -90,3 +98,4 @@ * The queue's actual dispatch rate is the result of:

* explicitly set on the task and were created by the App Engine SDK. See
* [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
* [App Engine
* documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
*

@@ -100,5 +109,7 @@ * This object should have the same structure as [RetryConfig]{@link google.cloud.tasks.v2beta3.RetryConfig}

* PauseQueue,
* ResumeQueue, or uploading
* ResumeQueue, or
* uploading
* [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
* UpdateQueue cannot be used to change `state`.
* UpdateQueue cannot be
* used to change `state`.
*

@@ -110,7 +121,9 @@ * The number should be among the values of [State]{@link google.cloud.tasks.v2beta3.State}

*
* All tasks that were created before this time
* were purged.
* All tasks that were created
* before this time were purged.
*
* A queue can be purged using PurgeQueue, the
* [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
* A queue can be purged using
* PurgeQueue, the [App
* Engine Task Queue SDK, or the Cloud
* Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
*

@@ -187,4 +200,6 @@ * Purge time will be truncated to the nearest microsecond. Purge

*
* Note: The debugging command, RunTask, will run a task
* even if the queue has reached its RateLimits.
* Note: The debugging command,
* RunTask, will run a task
* even if the queue has reached its
* RateLimits.
*

@@ -197,3 +212,4 @@ * @property {number} maxDispatchesPerSecond

*
* * For App Engine queues, the maximum allowed value
* * For App Engine queues,
* the maximum allowed value
* is 500.

@@ -203,3 +219,4 @@ *

* This field has the same meaning as
* [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
* [rate in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
*

@@ -232,5 +249,5 @@ * @property {number} maxBurstSize

* Since `max_burst_size` is output only, if
* UpdateQueue is called on a queue
* created by `queue.yaml/xml`, `max_burst_size` will be reset based
* on the value of
* UpdateQueue is called
* on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset
* based on the value of
* max_dispatches_per_second,

@@ -255,3 +272,4 @@ * regardless of whether

* This field has the same meaning as
* [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
* [max_concurrent_requests in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
*

@@ -284,3 +302,4 @@ * @typedef RateLimits

* This field has the same meaning as
* [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [task_retry_limit in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -291,5 +310,5 @@ * @property {Object} maxRetryDuration

* attempted. Once `max_retry_duration` time has passed *and* the
* task has been attempted max_attempts
* times, no further attempts will be made and the task will be
* deleted.
* task has been attempted
* max_attempts times,
* no further attempts will be made and the task will be deleted.
*

@@ -305,3 +324,4 @@ * If zero, then the task age is unlimited.

* This field has the same meaning as
* [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [task_age_limit in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -311,7 +331,9 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* @property {Object} minBackoff
* A task will be scheduled for retry between
* A task will be scheduled
* for retry between
* min_backoff and
* max_backoff duration after it fails,
* if the queue's RetryConfig specifies that the task should be
* retried.
* max_backoff duration
* after it fails, if the queue's
* RetryConfig specifies that the
* task should be retried.
*

@@ -325,3 +347,4 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

* This field has the same meaning as
* [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [min_backoff_seconds in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -331,7 +354,9 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* @property {Object} maxBackoff
* A task will be scheduled for retry between
* A task will be scheduled
* for retry between
* min_backoff and
* max_backoff duration after it fails,
* if the queue's RetryConfig specifies that the task should be
* retried.
* max_backoff duration
* after it fails, if the queue's
* RetryConfig specifies that the
* task should be retried.
*

@@ -345,3 +370,4 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

* This field has the same meaning as
* [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [max_backoff_seconds in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -354,17 +380,19 @@ * This object should have the same structure as [Duration]{@link google.protobuf.Duration}

* A task's retry interval starts at
* min_backoff, then doubles
* `max_doublings` times, then increases linearly, and finally
* retries retries at intervals of
* min_backoff, then
* doubles `max_doublings` times, then increases linearly, and finally retries
* retries at intervals of
* max_backoff up to
* max_attempts times.
*
* For example, if min_backoff is 10s,
* max_backoff is 300s, and
* `max_doublings` is 3, then the a task will first be retried in
* 10s. The retry interval will double three times, and then
* increase linearly by 2^3 * 10s. Finally, the task will retry at
* intervals of max_backoff until the
* task has been attempted max_attempts
* times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
* 240s, 300s, 300s, ....
* For example, if
* min_backoff is 10s,
* max_backoff is 300s,
* and `max_doublings` is 3, then the a task will first be retried in 10s. The
* retry interval will double three times, and then increase linearly by 2^3 *
* 10s. Finally, the task will retry at intervals of
* max_backoff until the
* task has been attempted
* max_attempts times.
* Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
* 300s, ....
*

@@ -376,3 +404,4 @@ * If unspecified when the queue is created, Cloud Tasks will pick the

* This field has the same meaning as
* [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
* [max_doublings in
* queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
*

@@ -379,0 +408,0 @@ * @typedef RetryConfig

235

src/v2beta3/doc/google/cloud/tasks/v2beta3/doc_target.js

@@ -19,10 +19,111 @@ // Copyright 2019 Google LLC

/**
* HTTP request.
*
* Warning: This is an [alpha](https://cloud.google.com/terms/launch-stages)
* feature. If you haven't already joined, you can [use this form to sign
* up](https://docs.google.com/forms/d/e/1FAIpQLSfc4uEy9CBHKYUSdnY1hdhKDCX7julVZHy3imOiR-XrU7bUNQ/viewform?usp=sf_link).
*
* The task will be pushed to the worker as an HTTP request. If the worker
* or the redirected worker acknowledges the task by returning a successful HTTP
* response code ([`200` - `299`]), the task will removed from the queue. If
* any other HTTP response code is returned or no response is received, the
* task will be retried according to the following:
*
* * User-specified throttling: retry configuration,
* rate limits, and the queue's
* state.
*
* * System throttling: To prevent the worker from overloading, Cloud Tasks may
* temporarily reduce the queue's effective rate. User-specified settings
* will not be changed.
*
* System throttling happens because:
*
* * Cloud Tasks backoffs on all errors. Normally the backoff specified in
* rate limits will be used. But if the worker returns
* `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
* errors is high, Cloud Tasks will use a higher backoff rate. The retry
* specified in the `Retry-After` HTTP response header is considered.
*
* * To prevent traffic spikes and to smooth sudden large traffic spikes,
* dispatches ramp up slowly when the queue is newly created or idle and
* if large numbers of tasks suddenly become available to dispatch (due to
* spikes in create task rates, the queue being unpaused, or many tasks
* that are scheduled at the same time).
*
* @property {string} url
* Required. The full url path that the request will be sent to.
*
* This string must begin with either "http://" or "https://". Some examples
* are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
* encode some characters for safety and compatibility. The maximum allowed
* URL length is 2083 characters after encoding.
*
* The `Location` header response from a redirect response [`300` - `399`]
* may be followed. The redirect is not counted as a separate attempt.
*
* @property {number} httpMethod
* The HTTP method to use for the request. The default is POST.
*
* The number should be among the values of [HttpMethod]{@link google.cloud.tasks.v2beta3.HttpMethod}
*
* @property {Object.<string, string>} headers
* HTTP request headers.
*
* This map contains the header field names and values.
* Headers can be set when the
* task is created.
*
* These headers represent a subset of the headers that will accompany the
* task's HTTP request. Some HTTP request headers will be ignored or replaced.
*
* A partial list of headers that will be ignored or replaced is:
*
* * Host: This will be computed by Cloud Tasks and derived from
* HttpRequest.url.
* * Content-Length: This will be computed by Cloud Tasks.
* * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
* * X-Google-*: Google use only.
* * X-AppEngine-*: Google use only.
*
* `Content-Type` won't be set by Cloud Tasks. You can explicitly set
* `Content-Type` to a media type when the
* task is created.
* For example, `Content-Type` can be set to `"application/octet-stream"` or
* `"application/json"`.
*
* Headers which can have multiple values (according to RFC2616) can be
* specified using comma-separated values.
*
* The size of the headers must be less than 80KB.
*
* @property {string} body
* HTTP request body.
*
* A request body is allowed only if the
* HTTP method is POST,
* PUT, or PATCH. It is an error to set body on a task with an incompatible
* HttpMethod.
*
* @typedef HttpRequest
* @memberof google.cloud.tasks.v2beta3
* @see [google.cloud.tasks.v2beta3.HttpRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/tasks/v2beta3/target.proto}
*/
const HttpRequest = {
// This is for documentation. Actual contents will be loaded by gRPC.
};
/**
* App Engine HTTP queue.
*
* The task will be delivered to the App Engine application hostname
* specified by its AppEngineHttpQueue and AppEngineHttpRequest.
* The documentation for AppEngineHttpRequest explains how the
* task's host URL is constructed.
* specified by its
* AppEngineHttpQueue and
* AppEngineHttpRequest. The
* documentation for
* AppEngineHttpRequest
* explains how the task's host URL is constructed.
*
* Using AppEngineHttpQueue requires
* Using AppEngineHttpQueue
* requires
* [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)

@@ -36,7 +137,9 @@ * Google IAM permission for the project

* Overrides for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*
* If set, `app_engine_routing_override` is used for all tasks in
* the queue, no matter what the setting is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -60,5 +163,7 @@ * This object should have the same structure as [AppEngineRouting]{@link google.cloud.tasks.v2beta3.AppEngineRouting}

* This proto can only be used for tasks in a queue which has
* app_engine_http_queue set.
* app_engine_http_queue
* set.
*
* Using AppEngineHttpRequest requires
* Using AppEngineHttpRequest
* requires
* [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)

@@ -72,5 +177,7 @@ * Google IAM permission for the project

* project as the queue. For more information, see
* [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* [How Requests are
* Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and how routing is affected by
* [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
* [dispatch
* files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
* Traffic is encrypted during transport and never leaves Google datacenters.

@@ -82,4 +189,5 @@ * Because this traffic is carried over a communication mechanism internal to

*
* The AppEngineRouting used to construct the URL that the task is
* delivered to can be set at the queue-level or task-level:
* The AppEngineRouting used to
* construct the URL that the task is delivered to can be set at the queue-level
* or task-level:
*

@@ -90,3 +198,4 @@ * * If set,

* is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -101,6 +210,8 @@ *

* URIs restricted with
* [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
* [`login:
* admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
* Because tasks are not run as any user, they cannot be dispatched to URIs
* restricted with
* [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
* [`login:
* required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
* Task dispatches also do not follow redirects.

@@ -122,6 +233,8 @@ *

* with error code 405 (Method Not Allowed). See
* [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* [Writing a push task request
* handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
* and the documentation for the request handlers in the language your app is
* written in e.g.
* [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
* [Python Request
* Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
*

@@ -136,3 +249,4 @@ * The number should be among the values of [HttpMethod]{@link google.cloud.tasks.v2beta3.HttpMethod}

* is used for all tasks in the queue, no matter what the setting is for the
* task-level app_engine_routing.
* task-level
* app_engine_routing.
*

@@ -165,4 +279,5 @@ * This object should have the same structure as [AppEngineRouting]{@link google.cloud.tasks.v2beta3.AppEngineRouting}

*
* If the task has a body, Cloud
* Tasks sets the following headers:
* If the task has a
* body, Cloud Tasks
* sets the following headers:
*

@@ -185,3 +300,4 @@ * * `Content-Type`: By default, the `Content-Type` header is set to

* such as headers containing information about the task; see
* [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
* [request
* headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
* These headers are set only when the task is dispatched, so they are not

@@ -191,4 +307,6 @@ * 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.
* the size, there is a limit on the maximum size of the
* Task. For more information, see the
* CreateTask
* documentation.
*

@@ -199,3 +317,4 @@ * @property {string} body

* A request body is allowed only if the HTTP method is POST or PUT. It is
* an error to set a body on a task with an incompatible HttpMethod.
* an error to set a body on a task with an incompatible
* HttpMethod.
*

@@ -217,6 +336,10 @@ * @typedef AppEngineHttpRequest

* For more information about services, versions, and instances see
* [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
* [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
* [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
* and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
* [An Overview of App
* Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
* [Microservices Architecture on Google App
* Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
* [App Engine Standard request
* routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
* and [App Engine Flex request
* routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
*

@@ -230,12 +353,14 @@ * @property {string} service

* 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
* Task Queue API, host is
* not parsable into
* service,
* version, and
* instance are the empty string.
* 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.
*

@@ -249,12 +374,14 @@ * @property {string} version

* 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
* Task Queue API, host is
* not parsable into
* service,
* version, and
* instance are the empty string.
* 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.
*

@@ -268,6 +395,9 @@ * @property {string} instance

* Requests can only be sent to a specific instance if
* [manual scaling is used in App Engine Standard](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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
* App Engine Flex does not support instances. For more information, see
* [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
* [App Engine Standard request
* routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
* and [App Engine Flex request
* routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
*

@@ -279,8 +409,11 @@ * @property {string} host

* the queue's project ID (for example <app-id>.appspot.com), and the
* service, version,
* and instance. Tasks which were created using
* the App Engine SDK might have a custom domain name.
* service,
* version, and
* instance. Tasks
* which were created using the App Engine SDK might have a custom domain
* name.
*
* For more information, see
* [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
* [How Requests are
* Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
*

@@ -287,0 +420,0 @@ * @typedef AppEngineRouting

58

src/v2beta3/doc/google/cloud/tasks/v2beta3/doc_task.js

@@ -22,3 +22,4 @@ // Copyright 2019 Google LLC

* @property {string} name
* Optionally caller-specified in CreateTask.
* Optionally caller-specified in
* CreateTask.
*

@@ -33,3 +34,4 @@ * The task name.

* For more information, see
* [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* [Identifying
* projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
* * `LOCATION_ID` is the canonical ID for the task's location.

@@ -47,6 +49,20 @@ * The list of available locations can be obtained by calling

*
* An App Engine task is a task that has AppEngineHttpRequest set.
* An App Engine task is a task that has
* AppEngineHttpRequest
* set.
*
* This object should have the same structure as [AppEngineHttpRequest]{@link google.cloud.tasks.v2beta3.AppEngineHttpRequest}
*
* @property {Object} httpRequest
* HTTP request that is sent to the task's target.
*
* Warning: This is an [alpha](https://cloud.google.com/terms/launch-stages)
* feature. If you haven't already joined, you can [use this form to sign
* up](https://docs.google.com/forms/d/e/1FAIpQLSfc4uEy9CBHKYUSdnY1hdhKDCX7julVZHy3imOiR-XrU7bUNQ/viewform?usp=sf_link).
*
* An HTTP task is a task that has
* HttpRequest set.
*
* This object should have the same structure as [HttpRequest]{@link google.cloud.tasks.v2beta3.HttpRequest}
*
* @property {Object} scheduleTime

@@ -72,3 +88,4 @@ * The time when the task is scheduled to be attempted.

* is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
* task according to the RetryConfig.
* task according to the
* RetryConfig.
*

@@ -82,6 +99,11 @@ * Note that when the request is cancelled, Cloud Tasks will stop listing for

*
* * For HTTP tasks, the default is
* 10 minutes.
* The deadline must be in the interval [15 seconds, 30 minutes].
*
* * For App Engine tasks, 0 indicates that the
* * For App Engine tasks,
* 0 indicates that the
* request has the default deadline. The default deadline depends on the
* [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
* [scaling
* type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
* of the service: 10 minutes for standard apps with automatic scaling, 24

@@ -105,3 +127,3 @@ * hours for standard apps with manual and basic scaling, and 60 minutes for

*
* This count includes tasks which have been dispatched but haven't
* This count includes attempts which have been dispatched but haven't
* received a response.

@@ -115,4 +137,5 @@ *

*
* Only dispatch_time will be set.
* The other Attempt information is not retained by Cloud Tasks.
* Only dispatch_time will
* be set. The other Attempt information
* is not retained by Cloud Tasks.
*

@@ -127,4 +150,4 @@ * This object should have the same structure as [Attempt]{@link google.cloud.tasks.v2beta3.Attempt}

* @property {number} view
* Output only. The view specifies which subset of the Task has
* been returned.
* Output only. The view specifies which subset of the
* Task has been returned.
*

@@ -141,3 +164,4 @@ * The number should be among the values of [View]{@link google.cloud.tasks.v2beta3.View}

/**
* The view specifies a subset of Task data.
* The view specifies a subset of Task
* data.
*

@@ -165,3 +189,4 @@ * When a task is returned in a response, not all

* This view does not include the
* body in AppEngineHttpRequest.
* body in
* AppEngineHttpRequest.
* Bodies are desirable to return only when needed, because they

@@ -176,5 +201,6 @@ * can be large and because of the sensitivity of the data that you

*
* Authorization for FULL requires
* `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
* permission on the Queue resource.
* Authorization for FULL
* requires `cloudtasks.tasks.fullView` [Google
* IAM](https://cloud.google.com/iam/) permission on the
* Queue resource.
*/

@@ -181,0 +207,0 @@ FULL: 2

31

src/v2beta3/doc/google/rpc/doc_status.js

@@ -19,5 +19,5 @@ // Copyright 2019 Google LLC

/**
* The `Status` type defines a logical error model that is suitable for different
* programming environments, including REST APIs and RPC APIs. It is used by
* [gRPC](https://github.com/grpc). The error model is designed to be:
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
*

@@ -29,11 +29,12 @@ * - Simple to use and understand for most users

*
* The `Status` message contains three pieces of data: error code, error message,
* and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes if needed. The
* error message should be a developer-facing English message that helps
* developers *understand* and *resolve* the error. If a localized user-facing
* error message is needed, put the localized message in the error details or
* localize it in the client. The optional error details may contain arbitrary
* information about the error. There is a predefined set of error detail types
* in the package `google.rpc` that can be used for common error conditions.
* The `Status` message contains three pieces of data: error code, error
* message, and error details. The error code should be an enum value of
* google.rpc.Code, but it may accept additional error codes
* if needed. The error message should be a developer-facing English message
* that helps developers *understand* and *resolve* the error. If a localized
* user-facing error message is needed, put the localized message in the error
* details or localize it in the client. The optional error details may contain
* arbitrary information about the error. There is a predefined set of error
* detail types in the package `google.rpc` that can be used for common error
* conditions.
*

@@ -75,3 +76,4 @@ * # Language mapping

* @property {number} code
* The status code, which should be an enum value of google.rpc.Code.
* The status code, which should be an enum value of
* google.rpc.Code.
*

@@ -81,3 +83,4 @@ * @property {string} message

* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
* google.rpc.Status.details field, or localized
* by the client.
*

@@ -84,0 +87,0 @@ * @property {Object[]} details

protos/google/cloud/tasks/v2beta2/cloudtasks.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta2/queue.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta2/target.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta2/task.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta3/cloudtasks.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta3/queue.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta3/target.proto

Sorry, the diff of this file is not supported yet

protos/google/cloud/tasks/v2beta3/task.proto

Sorry, the diff of this file is not supported yet

src/v2beta2/cloud_tasks_client.js

Sorry, the diff of this file is too big to display

src/v2beta3/cloud_tasks_client.js

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc