alu/tra-analysis
1
0
Fork 0
mirror of https://github.com/titanscouting/tra-analysis.git synced 2025-09-07 07:27:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

push all website files

Browse Source
This commit is contained in:
Jacob Levine
2019-01-06 13:14:45 -06:00
parent d7301e26c3
commit d2d5d4c04e
15662 changed files with 2166516 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

850
website/functions/node_modules/google-proto-files/google/cloud/tasks/v2beta2/cloudtasks.proto generated vendored Normal file
View File

@@ -0,0 +1,850 @@
// Copyright 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.tasks.v2beta2;
import "google/api/annotations.proto";
import "google/cloud/tasks/v2beta2/queue.proto";
import "google/cloud/tasks/v2beta2/task.proto";
import "google/iam/v1/iam_policy.proto";
import "google/iam/v1/policy.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/code.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
option java_multiple_files = true;
option java_outer_classname = "CloudTasksProto";
option java_package = "com.google.cloud.tasks.v2beta2";
// Cloud Tasks allows developers to manage the execution of background
// work in their applications.
service CloudTasks {
// Lists queues.
//
// Queues are returned in lexicographical order.
rpc ListQueues(ListQueuesRequest) returns (ListQueuesResponse) {
option (google.api.http) = {
get: "/v2beta2/{parent=projects/*/locations/*}/queues"
};
}
// Gets a queue.
rpc GetQueue(GetQueueRequest) returns (Queue) {
option (google.api.http) = {
get: "/v2beta2/{name=projects/*/locations/*/queues/*}"
};
}
// Creates a queue.
//
// Queues created with this method allow tasks to live for a maximum of 31
// days. After a task is 31 days old, the task will be deleted regardless of whether
// it was dispatched or not.
//
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
// before using this method.
rpc CreateQueue(CreateQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2beta2/{parent=projects/*/locations/*}/queues"
body: "queue"
};
}
// Updates a queue.
//
// This method creates the queue if it does not exist and updates
// the queue if it does exist.
//
// Queues created with this method allow tasks to live for a maximum of 31
// days. After a task is 31 days old, the task will be deleted regardless of whether
// it was dispatched or not.
//
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
// before using this method.
rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
option (google.api.http) = {
patch: "/v2beta2/{queue.name=projects/*/locations/*/queues/*}"
body: "queue"
};
}
// Deletes a queue.
//
// This command will delete the queue even if it has tasks in it.
//
// Note: If you delete a queue, a queue with the same name can't be created
// for 7 days.
//
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)
// before using this method.
rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2beta2/{name=projects/*/locations/*/queues/*}"
};
}
// Purges a queue by deleting all of its tasks.
//
// All tasks created before this method is called are permanently deleted.
//
// Purge operations can take up to one minute to take effect. Tasks
// might be dispatched before the purge takes effect. A purge is irreversible.
rpc PurgeQueue(PurgeQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*}:purge"
body: "*"
};
}
// Pauses the queue.
//
// If a queue is paused then the system will stop dispatching tasks
// until the queue is resumed via
// [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added
// when the queue is paused. A queue is paused if its
// [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
rpc PauseQueue(PauseQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*}:pause"
body: "*"
};
}
// Resume a queue.
//
// This method resumes a queue after it has been
// [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or
// [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored
// in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it
// will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING].
//
// WARNING: Resuming many high-QPS queues at the same time can
// lead to target overloading. If you are resuming high-QPS
// queues, follow the 500/50/5 pattern described in
// [Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).
rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*}:resume"
body: "*"
};
}
// Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
// Returns an empty policy if the resource exists and does not have a policy
// set.
//
// Authorization requires the following [Google IAM](/iam) permission on the
// specified resource parent:
//
// * `cloudtasks.queues.getIamPolicy`
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy"
body: "*"
};
}
// Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing
// policy.
//
// Note: The Cloud Console does not check queue-level IAM permissions yet.
// Project-level permissions are required to use the Cloud Console.
//
// Authorization requires the following [Google IAM](/iam) permission on the
// specified resource parent:
//
// * `cloudtasks.queues.setIamPolicy`
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy"
body: "*"
};
}
// Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
// If the resource does not exist, this will return an empty set of
// permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
//
// Note: This operation is designed to be used for building permission-aware
// UIs and command-line tools, not for authorization checking. This operation
// may "fail open" without warning.
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions"
body: "*"
};
}
// Lists the tasks in a queue.
//
// By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved
// due to performance considerations;
// [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the
// subset of information which is returned.
rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) {
option (google.api.http) = {
get: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks"
};
}
// Gets a task.
rpc GetTask(GetTaskRequest) returns (Task) {
option (google.api.http) = {
get: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}"
};
}
// Creates a task and adds it to a queue.
//
// Tasks cannot be updated after creation; there is no UpdateTask command.
//
// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
// the maximum task size is 100KB.
// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
// the maximum task size is 1MB.
rpc CreateTask(CreateTaskRequest) returns (Task) {
option (google.api.http) = {
post: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks"
body: "*"
};
}
// Deletes a task.
//
// A task can be deleted if it is scheduled or dispatched. A task
// cannot be deleted if it has completed successfully or permanently
// failed.
rpc DeleteTask(DeleteTaskRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}"
};
}
// Leases tasks from a pull queue for
// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
//
// This method is invoked by the worker to obtain a lease. The
// worker must acknowledge the task via
// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have
// performed the work associated with the task.
//
// The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that
// the worker needs to perform the work associated with the task. To
// return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
// [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to
// [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
//
// A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
// requests are allowed per
// queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
// is returned when this limit is
// exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
// is also returned when
// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
// is exceeded.
rpc LeaseTasks(LeaseTasksRequest) returns (LeaseTasksResponse) {
option (google.api.http) = {
post: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks:lease"
body: "*"
};
}
// Acknowledges a pull task.
//
// The worker, that is, the entity that
// [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method
// to indicate that the work associated with the task has finished.
//
// The worker must acknowledge a task within the
// [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease
// will expire and the task will become available to be leased
// again. After the task is acknowledged, it will not be returned
// by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
// [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
rpc AcknowledgeTask(AcknowledgeTaskRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:acknowledge"
body: "*"
};
}
// Renew the current lease of a pull task.
//
// The worker can use this method to extend the lease by a new
// duration, starting from now. The new task lease will be
// returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
rpc RenewLease(RenewLeaseRequest) returns (Task) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:renewLease"
body: "*"
};
}
// Cancel a pull task's lease.
//
// The worker can use this method to cancel a task's lease by
// setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will
// make the task available to be leased to the next caller of
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
rpc CancelLease(CancelLeaseRequest) returns (Task) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:cancelLease"
body: "*"
};
}
// Forces a task to run now.
//
// When this method is called, Cloud Tasks will dispatch the task, even if
// the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or
// is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
//
// This command is meant to be used for manual debugging. For
// example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed
// task after a fix has been made or to manually force a task to be
// dispatched now.
//
// The dispatched task is returned. That is, the task that is returned
// contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but
// before the task is received by its target.
//
// If Cloud Tasks receives a successful response from the task's
// target, then the task will be deleted; otherwise the task's
// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that
// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified
// in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
//
// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns
// [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
// task that has already succeeded or permanently failed.
//
// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a
// [pull task][google.cloud.tasks.v2beta2.PullMessage].
rpc RunTask(RunTaskRequest) returns (Task) {
option (google.api.http) = {
post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:run"
body: "*"
};
}
}
// Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
message ListQueuesRequest {
// Required.
//
// The location name.
// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
string parent = 1;
// `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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](/logging/docs/view/advanced_filters).
//
// Sample filter "app_engine_http_target: *".
//
// Note that using filters might cause fewer queues than the
// requested_page size to be returned.
string filter = 2;
// Requested page size.
//
// The maximum page size is 9800. If unspecified, the page size will
// be the maximum. Fewer queues than requested might be returned,
// even if more queues exist; use the
// [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the
// response to determine if more queues exist.
int32 page_size = 3;
// A token identifying the page of results to return.
//
// To request the first page results, page_token must be empty. To
// request the next page of results, page_token must be the value of
// [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned
// from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]
// method. It is an error to switch the value of the
// [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.
string page_token = 4;
}
// Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
message ListQueuesResponse {
// The list of queues.
repeated Queue queues = 1;
// A token to retrieve next page of results.
//
// To return the next page of results, call
// [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] with this value as the
// [page_token][google.cloud.tasks.v2beta2.ListQueuesRequest.page_token].
//
// If the next_page_token is empty, there are no more results.
//
// The page token is valid for only 2 hours.
string next_page_token = 2;
}
// Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].
message GetQueueRequest {
// Required.
//
// The resource name of the queue. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
string name = 1;
}
// Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].
message CreateQueueRequest {
// Required.
//
// The location name in which the queue will be created.
// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
//
// The list of allowed locations can be obtained by calling Cloud
// Tasks' implementation of
// [ListLocations][google.cloud.location.Locations.ListLocations].
string parent = 1;
// Required.
//
// The queue to create.
//
// [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue.
Queue queue = 2;
}
// Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].
message UpdateQueueRequest {
// Required.
//
// The queue to create or update.
//
// The queue's [name][google.cloud.tasks.v2beta2.Queue.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][google.cloud.tasks.v2beta2.Queue.name] cannot be changed.
Queue queue = 1;
// A mask used to specify which fields of the queue are being updated.
//
// If empty, then all fields will be updated.
google.protobuf.FieldMask update_mask = 2;
}
// Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
message DeleteQueueRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
string name = 1;
}
// Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].
message PurgeQueueRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
string name = 1;
}
// Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].
message PauseQueueRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
string name = 1;
}
// Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].
message ResumeQueueRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
string name = 1;
}
// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
message ListTasksRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
string parent = 1;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 2;
// Sort order used for the query. The only fields supported for sorting
// are `schedule_time` and `pull_message.tag`. All results will be
// returned in approximately ascending order. The default ordering is by
// `schedule_time`.
string order_by = 3;
// Requested page size. Fewer tasks than requested might be returned.
//
// The maximum page size is 1000. If unspecified, the page size will
// be the maximum. Fewer tasks than requested might be returned,
// even if more tasks exist; use
// [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] in the
// response to determine if more tasks exist.
int32 page_size = 4;
// A token identifying the page of results to return.
//
// To request the first page results, page_token must be empty. To
// request the next page of results, page_token must be the value of
// [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] returned
// from the previous call to [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]
// method.
//
// The page token is valid for only 2 hours.
string page_token = 5;
}
// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
message ListTasksResponse {
// The list of tasks.
repeated Task tasks = 1;
// A token to retrieve next page of results.
//
// To return the next page of results, call
// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] with this value as the
// [page_token][google.cloud.tasks.v2beta2.ListTasksRequest.page_token].
//
// If the next_page_token is empty, there are no more results.
string next_page_token = 2;
}
// Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
message GetTaskRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 2;
}
// Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
message CreateTaskRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
//
// The queue must already exist.
string parent = 1;
// Required.
//
// The task to add.
//
// Task names have the following format:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
// The user can optionally specify a task [name][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.Task.name].
//
// If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not set or is in the
// past then Cloud Tasks will set it to the current time.
//
// Task De-duplication:
//
// Explicitly specifying a task ID enables task de-duplication. If
// a task's ID is identical to that of an existing task or a task
// that was deleted or completed recently then the call will fail
// with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
// If the task's queue was created using Cloud Tasks, then another task with
// the same name can't be created for ~1hour after the original task was
// deleted or completed. If the task's queue was created using queue.yaml or
// queue.xml, then another task with the same name can't be created
// for ~9days after the original task was deleted or completed.
//
// Because there is an extra lookup cost to identify duplicate task
// names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.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
// task commands. The infrastructure relies on an approximately
// uniform distribution of task ids to store and serve tasks
// efficiently.
Task task = 2;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 3;
}
// Request message for deleting a task using
// [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
message DeleteTaskRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
}
// Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
message LeaseTasksRequest {
// Required.
//
// The queue name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
string parent = 1;
// The maximum number of tasks to lease. The maximum that can be
// requested is 1000.
int32 max_tasks = 2;
//
// After the worker has successfully finished the work associated
// with the task, the worker must call via
// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the
// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be
// returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so
// that another worker can retry it.
//
// The maximum lease duration is 1 week.
// `lease_duration` will be truncated to the nearest second.
google.protobuf.Duration lease_duration = 3;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 4;
// `filter` can be used to specify a subset of tasks to lease.
//
// When `filter` is set to `tag=<my-tag>` then the
// [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose
// [tag][google.cloud.tasks.v2beta2.PullMessage.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][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned.
//
// Grammar Syntax:
//
// * `filter = "tag=" tag | "tag_function=" function`
//
// * `tag = string`
//
// * `function = "oldest_tag()"`
//
// The `oldest_tag()` function returns tasks which have the same tag as the
// oldest task (ordered by schedule time).
//
// SDK compatibility: Although the SDK allows tags to be either
// string or
// [bytes](/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. Tag which
// aren't UTF-8 encoded can't be used in the
// [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task's
// [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks.
string filter = 5;
}
// Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
message LeaseTasksResponse {
// The leased tasks.
repeated Task tasks = 1;
}
// Request message for acknowledging a task using
// [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
message AcknowledgeTaskRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
// Required.
//
// The task's current schedule time, available in the
// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
// to ensure that your worker currently holds the lease.
google.protobuf.Timestamp schedule_time = 2;
}
// Request message for renewing a lease using
// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
message RenewLeaseRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
// Required.
//
// The task's current schedule time, available in the
// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
// to ensure that your worker currently holds the lease.
google.protobuf.Timestamp schedule_time = 2;
// Required.
//
// The desired new lease duration, starting from now.
//
//
// The maximum lease duration is 1 week.
// `lease_duration` will be truncated to the nearest second.
google.protobuf.Duration lease_duration = 3;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 4;
}
// Request message for canceling a lease using
// [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
message CancelLeaseRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
// Required.
//
// The task's current schedule time, available in the
// [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or
// [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is
// to ensure that your worker currently holds the lease.
google.protobuf.Timestamp schedule_time = 2;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 3;
}
// Request message for forcing a task to run now using
// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
message RunTaskRequest {
// Required.
//
// The task name. For example:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
string name = 1;
// The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be
// returned.
//
// By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.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][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the
// [Task][google.cloud.tasks.v2beta2.Task] resource.
Task.View response_view = 2;
}

357
website/functions/node_modules/google-proto-files/google/cloud/tasks/v2beta2/queue.proto generated vendored Normal file
View File

@@ -0,0 +1,357 @@
// Copyright 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.tasks.v2beta2;
import "google/api/annotations.proto";
import "google/cloud/tasks/v2beta2/target.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
option java_multiple_files = true;
option java_outer_classname = "QueueProto";
option java_package = "com.google.cloud.tasks.v2beta2";
// A queue is a container of related tasks. Queues are configured to manage
// how those tasks are dispatched. Configurable properties include rate limits,
// retry options, target types, and others.
message Queue {
// State of the queue.
enum State {
// Unspecified state.
STATE_UNSPECIFIED = 0;
// The queue is running. Tasks can be dispatched.
//
// If the queue was created using Cloud Tasks and the queue has
// had no activity (method calls or task dispatches) for 30 days,
// the queue may take a few minutes to re-activate. Some method
// calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
// tasks may not be dispatched for a few minutes until the queue
// has been re-activated.
RUNNING = 1;
// Tasks are paused by the user. If the queue is paused then Cloud
// Tasks will stop delivering tasks from it, but more tasks can
// still be added to it by the user. When a pull queue is paused,
// all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls will return a
// [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].
PAUSED = 2;
// The queue is disabled.
//
// A queue becomes `DISABLED` when
// [queue.yaml](/appengine/docs/python/config/queueref) or
// [queue.xml](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][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls return a
// `FAILED_PRECONDITION` error.
//
// To permanently delete this queue and all of its tasks, call
// [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
DISABLED = 3;
}
// The queue name.
//
// The queue name must have the following format:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
//
// * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
// hyphens (-), colons (:), or periods (.).
// For more information, see
// [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)
// * `LOCATION_ID` is the canonical ID for the queue's location.
// The list of available locations can be obtained by calling
// [ListLocations][google.cloud.location.Locations.ListLocations].
// For more information, see https://cloud.google.com/about/locations/.
// * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
// hyphens (-). The maximum length is 100 characters.
//
// Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue],
// after which it becomes output only.
string name = 1;
// The queue's target.
//
// The target applies to all tasks in the queue.
//
// Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue][],
// after which the queue config type becomes output only, though fields within
// the config are mutable.
oneof target_type {
// App Engine HTTP target.
//
// An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
AppEngineHttpTarget app_engine_http_target = 3;
// Pull target.
//
// A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
PullTarget pull_target = 4;
}
// Rate limits for task dispatches.
//
// [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
// [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both
// control task attempts however they control how tasks are
// attempted in different ways:
//
// * [rate_limits][google.cloud.tasks.v2beta2.Queue.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][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to
// particular a task after its first attempt fails. That is,
// [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the
// second attempt, third attempt, etc).
RateLimits rate_limits = 5;
// Settings that determine the retry behavior.
//
// * For tasks created using Cloud Tasks: the queue-level retry settings
// apply to all tasks in the queue that were created using Cloud Tasks.
// Retry settings cannot be set on individual tasks.
// * For tasks created using the App Engine SDK: the queue-level retry
// settings apply to all tasks in the queue which do not have retry settings
// explicitly set on the task and were created by the App Engine SDK. See
// [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
RetryConfig retry_config = 6;
// Output only. The state of the queue.
//
// `state` can only be changed by called
// [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
// [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading
// [queue.yaml/xml](/appengine/docs/python/config/queueref).
// [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
State state = 7;
// Output only. The last time this queue was purged.
//
// All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time
// were purged.
//
// A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the
// [App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
//
// Purge time will be truncated to the nearest microsecond. Purge
// time will be unset if the queue has never been purged.
google.protobuf.Timestamp purge_time = 8;
}
// Rate limits.
//
// This message determines the maximum rate that tasks can be dispatched by a
// queue, regardless of whether the dispatch is a first task attempt or a retry.
//
// Note: The debugging command, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task
// even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits].
message RateLimits {
// The maximum rate at which tasks are dispatched from this queue.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
// * For App Engine queues, the maximum allowed value is 500.
// * This field is output only for [pull queues](google.cloud.tasks.v2beta2.PullTarget). In
// addition to the `max_tasks_dispatched_per_second` limit, a
// maximum of 10 QPS of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
// requests are allowed per pull queue.
//
//
// This field has the same meaning as
// [rate in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#rate).
double max_tasks_dispatched_per_second = 1;
// Output only. The max burst size.
//
// Max burst size limits how fast tasks in queue are processed when
// many tasks are in the queue and the rate is high. This field
// allows the queue to have a high rate so processing starts shortly
// after a task is enqueued, but still limits resource usage when
// many tasks are enqueued in a short period of time.
//
// The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
// algorithm is used to control the rate of task dispatches. Each
// queue has a token bucket that holds tokens, up to the maximum
// specified by `max_burst_size`. Each time a task is dispatched, a
// token is removed from the bucket. Tasks will be dispatched until
// the queue's bucket runs out of tokens. The bucket will be
// continuously refilled with new tokens based on
// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second].
//
// Cloud Tasks will pick the value of `max_burst_size` based on the
// value of
// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second].
//
// For App Engine queues that were created or updated using
// `queue.yaml/xml`, `max_burst_size` is equal to
// [bucket_size](/appengine/docs/standard/python/config/queueref#bucket_size).
// Since `max_burst_size` is output only, if
// [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second],
// regardless of whether
// [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
// is updated.
//
int32 max_burst_size = 2;
// The maximum number of concurrent tasks that Cloud Tasks allows
// to be dispatched for this queue. After this threshold has been
// reached, Cloud Tasks stops dispatching tasks until the number of
// concurrent requests decreases.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
//
// The maximum allowed value is 5,000.
//
// This field is output only for
// [pull queues](google.cloud.tasks.v2beta2.PullTarget) 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](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
int32 max_concurrent_tasks = 3;
}
// Retry config.
//
// These settings determine how a failed task attempt is retried.
message RetryConfig {
// Number of attempts per task.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
//
//
// This field has the same meaning as
// [task_retry_limit in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).
oneof num_attempts {
// The maximum number of attempts for a task.
//
// Cloud Tasks will attempt the task `max_attempts` times (that
// is, if the first attempt fails, then there will be
// `max_attempts - 1` retries). Must be > 0.
int32 max_attempts = 1;
// If true, then the number of attempts is unlimited.
bool unlimited_attempts = 2;
}
// If positive, `max_retry_duration` specifies the time limit for
// retrying a failed task, measured from when the task was first
// attempted. Once `max_retry_duration` time has passed *and* the
// task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
// times, no further attempts will be made and the task will be
// deleted.
//
// If zero, then the task age is unlimited.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
// This field is output only for
// [pull queues](google.cloud.tasks.v2beta2.PullTarget).
//
//
// `max_retry_duration` will be truncated to the nearest second.
//
// This field has the same meaning as
// [task_age_limit in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).
google.protobuf.Duration max_retry_duration = 3;
// A task will be [scheduled](Task.schedule_time) for retry between
// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
// if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
// retried.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
// This field is output only for
// [pull queues](google.cloud.tasks.v2beta2.PullTarget).
//
//
// `min_backoff` will be truncated to the nearest second.
//
// This field has the same meaning as
// [min_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).
google.protobuf.Duration min_backoff = 4;
// A task will be [scheduled](Task.schedule_time) for retry between
// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and
// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails,
// if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be
// retried.
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
// This field is output only for
// [pull queues](google.cloud.tasks.v2beta2.PullTarget).
//
//
// `max_backoff` will be truncated to the nearest second.
//
// This field has the same meaning as
// [max_backoff_seconds in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).
google.protobuf.Duration max_backoff = 5;
// The time between retries will double `max_doublings` times.
//
// A task's retry interval starts at
// [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then doubles
// `max_doublings` times, then increases linearly, and finally
// retries retries at intervals of
// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to
// [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times.
//
// For example, if [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s,
// [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.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][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the
// task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
// times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
// 240s, 300s, 300s, ....
//
// If unspecified when the queue is created, Cloud Tasks will pick the
// default.
//
// This field is output only for
// [pull queues](google.cloud.tasks.v2beta2.PullTarget).
//
//
// This field has the same meaning as
// [max_doublings in queue.yaml/xml](/appengine/docs/standard/python/config/queueref#retry_parameters).
int32 max_doublings = 6;
}

353
website/functions/node_modules/google-proto-files/google/cloud/tasks/v2beta2/target.proto generated vendored Normal file
View File

@@ -0,0 +1,353 @@
// Copyright 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.tasks.v2beta2;
import "google/api/annotations.proto";
import "google/protobuf/duration.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
option java_multiple_files = true;
option java_outer_classname = "TargetProto";
option java_package = "com.google.cloud.tasks.v2beta2";
// Pull target.
message PullTarget {
}
// The pull message contains data that can be used by the caller of
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
//
// This proto can only be used for tasks in a queue which has
// [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set.
message PullMessage {
// A data payload consumed by the worker to execute the task.
bytes payload = 1;
// The task's tag.
//
// Tags allow similar tasks to be processed in a batch. If you label
// tasks with a tag, your worker can
// [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the same tag using
// [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example, if you want to
// aggregate the events associated with a specific user once a day,
// you could tag tasks with the user ID.
//
// The task's tag can only be set when the
// [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
//
// The tag must be less than 500 characters.
//
// SDK compatibility: Although the SDK allows tags to be either
// string or [bytes](/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
// encoded, the tag will be empty when the task is returned by Cloud Tasks.
string tag = 2;
}
// App Engine HTTP target.
//
// The task will be delivered to the App Engine application hostname
// specified by its [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest].
// The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the
// task's host URL is constructed.
//
// Using [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] requires
// [`appengine.applications.get`](/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
message AppEngineHttpTarget {
// Overrides for the
// [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
AppEngineRouting app_engine_routing_override = 1;
}
// App Engine HTTP request.
//
// The message defines the HTTP request that is sent to an App Engine app when
// the task is dispatched.
//
// This proto can only be used for tasks in a queue which has
// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set.
//
// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] requires
// [`appengine.applications.get`](/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
//
// The task will be delivered to the App Engine app which belongs to the same
// project as the queue. For more information, see
// [How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)
// and how routing is affected by
// [dispatch files](/appengine/docs/python/config/dispatchref).
//
// The [AppEngineRouting][google.cloud.tasks.v2beta2.AppEngineRouting] used to construct the URL that the task is
// delivered to can be set at the queue-level or task-level:
//
// * If set,
// [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
//
//
// The `url` that the task will be sent to is:
//
// * `url =` [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] `+`
// [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]
//
// The task attempt has succeeded if the app's request handler returns
// an HTTP response code in the range [`200` - `299`]. `503` is
// considered an App Engine system error instead of an application
// error. Requests returning error `503` will be retried regardless of
// retry configuration and not counted against retry counts.
// Any other response code or a failure to receive a response before the
// deadline is a failed attempt.
message AppEngineHttpRequest {
// The HTTP method to use for the request. The default is POST.
//
// The app's request handler for the task's target URL must be able to handle
// HTTP requests with this http_method, otherwise the task attempt will fail
// with error code 405 (Method Not Allowed). See
// [Writing a push task request handler](/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](/appengine/docs/python/tools/webapp/requesthandlerclass).
HttpMethod http_method = 1;
// Task-level setting for App Engine routing.
//
// If set,
// [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
AppEngineRouting app_engine_routing = 2;
// The relative URL.
//
// The relative URL must begin with "/" and must be a valid HTTP relative URL.
// It can contain a path and query string arguments.
// If the relative URL is empty, then the root path "/" will be used.
// No spaces are allowed, and the maximum length allowed is 2083 characters.
string relative_url = 3;
// HTTP request headers.
//
// This map contains the header field names and values.
// Headers can be set when the
// [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
// Repeated headers are not supported but a header value can contain commas.
//
// Cloud Tasks sets some headers to default values:
//
// * `User-Agent`: By default, this header is
// `"AppEngine-Google; (+http://code.google.com/appengine)"`.
// This header can be modified, but Cloud Tasks will append
// `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
// modified `User-Agent`.
//
// If the task has a [payload][google.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], Cloud
// Tasks sets the following headers:
//
// * `Content-Type`: By default, the `Content-Type` header is set to
// `"application/octet-stream"`. The default can be overridden by explicitly
// setting `Content-Type` to a particular media type when the
// [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
// For example, `Content-Type` can be set to `"application/json"`.
// * `Content-Length`: This is computed by Cloud Tasks. This value is
// output only. It cannot be changed.
//
// The headers below cannot be set or overridden:
//
// * `Host`
// * `X-Google-*`
// * `X-AppEngine-*`
//
// In addition, Cloud Tasks sets some headers when the task is dispatched,
// such as headers containing information about the task; see
// [request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
// These headers are set only when the task is dispatched, so they are not
// visible when the task is returned in a Cloud Tasks response.
//
// Although there is no specific limit for the maximum number of headers or
// the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2beta2.Task]. For more
// information, see the [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] documentation.
map<string, string> headers = 4;
// Payload.
//
// The payload will be sent as the HTTP message body. A message
// body, and thus a payload, is allowed only if the HTTP method is
// POST or PUT. It is an error to set a data payload on a task with
// an incompatible [HttpMethod][google.cloud.tasks.v2beta2.HttpMethod].
bytes payload = 5;
}
// App Engine Routing.
//
// For more information about services, versions, and instances see
// [An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),
// [Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),
// [App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),
// and [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).
message AppEngineRouting {
// App service.
//
// By default, the task is sent to the service which is the default
// service when the task is attempted ("default").
//
// For some queues or tasks which were created using the App Engine
// Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable
// into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then
// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.
string service = 1;
// App version.
//
// By default, the task is sent to the version which is the default
// version when the task is attempted ("default").
//
// For some queues or tasks which were created using the App Engine
// Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable
// into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.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][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then
// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string.
string version = 2;
// App instance.
//
// By default, the task is sent to an instance which is available when
// the task is attempted.
//
// Requests can only be sent to a specific instance if
// [manual scaling is used in App Engine Standard](/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](/appengine/docs/standard/python/how-requests-are-routed)
// and [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).
string instance = 3;
// Output only. The host that the task is sent to.
//
// For more information, see
// [How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).
//
// The host is constructed as:
//
//
// * `host = [application_domain_name]`</br>
// `| [service] + '.' + [application_domain_name]`</br>
// `| [version] + '.' + [application_domain_name]`</br>
// `| [version_dot_service]+ '.' + [application_domain_name]`</br>
// `| [instance] + '.' + [application_domain_name]`</br>
// `| [instance_dot_service] + '.' + [application_domain_name]`</br>
// `| [instance_dot_version] + '.' + [application_domain_name]`</br>
// `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
//
// * `application_domain_name` = The domain name of the app, for
// example <app-id>.appspot.com, which is associated with the
// queue's project ID. Some tasks which were created using the App Engine
// SDK use a custom domain name.
//
// * `service =` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
//
// * `version =` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]
//
// * `version_dot_service =`
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
//
// * `instance =` [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]
//
// * `instance_dot_service =`
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
//
// * `instance_dot_version =`
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version]
//
// * `instance_dot_version_dot_service =`
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +`
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +`
// [service][google.cloud.tasks.v2beta2.AppEngineRouting.service]
//
// If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty, then the task will be sent
// to the service which is the default service when the task is attempted.
//
// If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty, then the task will be sent
// to the version which is the default version when the task is attempted.
//
// If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is empty, then the task
// will be sent to an instance which is available when the task is
// attempted.
//
// When [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is "default",
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is "default", and
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is empty,
// [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is shortened to just the
// `application_domain_name`.
//
// If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or
// [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is invalid, then the task
// will be sent to the default version of the default service when
// the task is attempted.
string host = 4;
}
// The HTTP method used to execute the task.
enum HttpMethod {
// HTTP method unspecified
HTTP_METHOD_UNSPECIFIED = 0;
// HTTP Post
POST = 1;
// HTTP Get
GET = 2;
// HTTP Head
HEAD = 3;
// HTTP Put
PUT = 4;
// HTTP Delete
DELETE = 5;
}

180
website/functions/node_modules/google-proto-files/google/cloud/tasks/v2beta2/task.proto generated vendored Normal file
View File

@@ -0,0 +1,180 @@
// Copyright 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.tasks.v2beta2;
import "google/api/annotations.proto";
import "google/cloud/tasks/v2beta2/target.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta2;tasks";
option java_multiple_files = true;
option java_outer_classname = "TaskProto";
option java_package = "com.google.cloud.tasks.v2beta2";
// A unit of scheduled work.
message Task {
// The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.
//
// When a task is returned in a response, 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.
enum View {
// Unspecified. Defaults to BASIC.
VIEW_UNSPECIFIED = 0;
// The basic view omits fields which can be large or can contain
// sensitive data.
//
// This view does not include the
// ([payload in AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] and
// [payload in PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). 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.
BASIC = 1;
// All information is returned.
//
// Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires
// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
// permission on the [Queue][google.cloud.tasks.v2beta2.Queue] resource.
FULL = 2;
}
// The task name.
//
// The task name must have the following format:
// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
//
// * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
// hyphens (-), colons (:), or periods (.).
// For more information, see
// [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)
// * `LOCATION_ID` is the canonical ID for the task's location.
// The list of available locations can be obtained by calling
// [ListLocations][google.cloud.location.Locations.ListLocations].
// For more information, see https://cloud.google.com/about/locations/.
// * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
// hyphens (-). The maximum length is 100 characters.
// * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
// hyphens (-), or underscores (_). The maximum length is 500 characters.
//
// Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
string name = 1;
// Required.
//
// The task's payload is used by the task's target to process the task.
// A payload is valid only if it is compatible with the queue's target.
oneof payload_type {
// App Engine HTTP request that is sent to the task's target. Can
// be set only if
// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set
// on the queue.
//
// An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.
AppEngineHttpRequest app_engine_http_request = 3;
// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be
// set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
//
// A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
PullMessage pull_message = 4;
}
// The time when the task is scheduled to be attempted.
//
// For App Engine queues, this is when the task will be attempted or retried.
//
// For pull queues, this is the time when the task is available to
// be leased; if a task is currently leased, this is the time when
// the current lease expires, that is, the time that the task was
// leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
//
// `schedule_time` will be truncated to the nearest microsecond.
google.protobuf.Timestamp schedule_time = 5;
// Output only. The time that the task was created.
//
// `create_time` will be truncated to the nearest second.
google.protobuf.Timestamp create_time = 6;
// Output only. The task status.
TaskStatus status = 7;
// Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has
// been returned.
View view = 8;
}
// Status of the task.
message TaskStatus {
// Output only. The number of attempts dispatched.
//
// This count includes tasks which have been dispatched but haven't
// received a response.
int32 attempt_dispatch_count = 1;
// Output only. The number of attempts which have received a response.
//
// This field is not calculated for
// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
int32 attempt_response_count = 2;
// Output only. The status of the task's first attempt.
//
// Only [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time] will be set.
// The other [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is not retained by Cloud Tasks.
//
// This field is not calculated for
// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
AttemptStatus first_attempt_status = 3;
// Output only. The status of the task's last attempt.
//
// This field is not calculated for
// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
AttemptStatus last_attempt_status = 4;
}
// The status of a task attempt.
message AttemptStatus {
// Output only. The time that this attempt was scheduled.
//
// `schedule_time` will be truncated to the nearest microsecond.
google.protobuf.Timestamp schedule_time = 1;
// Output only. The time that this attempt was dispatched.
//
// `dispatch_time` will be truncated to the nearest microsecond.
google.protobuf.Timestamp dispatch_time = 2;
// Output only. The time that this attempt response was received.
//
// `response_time` will be truncated to the nearest microsecond.
google.protobuf.Timestamp response_time = 3;
// Output only. The response from the target for this attempt.
//
// If the task has not been attempted or the task is currently running
// then the response status is unset.
google.rpc.Status response_status = 4;
}