Built motion from commit 6a09e18b.|2.6.11
[motion2.git] / legacy-libs / google-proto-files / google / cloud / tasks / v2beta3 / task.proto
diff --git a/legacy-libs/google-proto-files/google/cloud/tasks/v2beta3/task.proto b/legacy-libs/google-proto-files/google/cloud/tasks/v2beta3/task.proto
new file mode 100644 (file)
index 0000000..4d32acd
--- /dev/null
@@ -0,0 +1,202 @@
+// Copyright 2019 Google LLC.
+//
+// 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.v2beta3;
+
+import "google/api/annotations.proto";
+import "google/cloud/tasks/v2beta3/target.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2beta3;tasks";
+option java_multiple_files = true;
+option java_outer_classname = "TaskProto";
+option java_package = "com.google.cloud.tasks.v2beta3";
+
+// A unit of scheduled work.
+message Task {
+  // The view specifies a subset of [Task][google.cloud.tasks.v2beta3.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
+    // [body in
+    // AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body].
+    // Bodies 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.v2beta3.Task.View.FULL]
+    // requires `cloudtasks.tasks.fullView` [Google
+    // IAM](https://cloud.google.com/iam/) permission on the
+    // [Queue][google.cloud.tasks.v2beta3.Queue] resource.
+    FULL = 2;
+  }
+
+  // Optionally caller-specified in
+  // [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
+  //
+  // 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](https://cloud.google.com/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.
+  string name = 1;
+
+  // Required. The message to send to the worker.
+  oneof payload_type {
+    // HTTP request that is sent to the App Engine app handler.
+    //
+    // An App Engine task is a task that has
+    // [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]
+    // set.
+    AppEngineHttpRequest app_engine_http_request = 3;
+
+    // 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][google.cloud.tasks.v2beta3.HttpRequest] set.
+    HttpRequest http_request = 11;
+  }
+
+  // The time when the task is scheduled to be attempted.
+  //
+  // For App Engine queues, this is when the task will be attempted or retried.
+  //
+  // `schedule_time` will be truncated to the nearest microsecond.
+  google.protobuf.Timestamp schedule_time = 4;
+
+  // Output only. The time that the task was created.
+  //
+  // `create_time` will be truncated to the nearest second.
+  google.protobuf.Timestamp create_time = 5;
+
+  // The deadline for requests sent to the worker. If the worker does not
+  // respond by this deadline then the request is cancelled and the attempt
+  // is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
+  // task according to the
+  // [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
+  //
+  // Note that when the request is cancelled, Cloud Tasks will stop listing for
+  // the response, but whether the worker stops processing depends on the
+  // worker. For example, if the worker is stuck, it may not react to cancelled
+  // requests.
+  //
+  // The default and maximum values depend on the type of request:
+  //
+  // * For [HTTP tasks][google.cloud.tasks.v2beta3.HttpRequest], the default is
+  //   10 minutes.
+  //   The deadline must be in the interval [15 seconds, 30 minutes].
+  //
+  // * For [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest],
+  // 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)
+  //   of the service: 10 minutes for standard apps with automatic scaling, 24
+  //   hours for standard apps with manual and basic scaling, and 60 minutes for
+  //   flex apps. If the request deadline is set, it must be in the interval [15
+  //   seconds, 24 hours 15 seconds]. Regardless of the task's
+  //   `dispatch_deadline`, the app handler will not run for longer than than
+  //   the service's timeout. We recommend setting the `dispatch_deadline` to
+  //   at most a few seconds more than the app handler's timeout. For more
+  //   information see
+  //   [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
+  //
+  // `dispatch_deadline` will be truncated to the nearest millisecond. The
+  // deadline is an approximate deadline.
+  google.protobuf.Duration dispatch_deadline = 12;
+
+  // Output only. The number of attempts dispatched.
+  //
+  // This count includes attempts which have been dispatched but haven't
+  // received a response.
+  int32 dispatch_count = 6;
+
+  // Output only. The number of attempts which have received a response.
+  int32 response_count = 7;
+
+  // Output only. The status of the task's first attempt.
+  //
+  // Only [dispatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_time] will
+  // be set. The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information
+  // is not retained by Cloud Tasks.
+  Attempt first_attempt = 8;
+
+  // Output only. The status of the task's last attempt.
+  Attempt last_attempt = 9;
+
+  // Output only. The view specifies which subset of the
+  // [Task][google.cloud.tasks.v2beta3.Task] has been returned.
+  View view = 10;
+}
+
+// The status of a task attempt.
+message Attempt {
+  // 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 worker for this attempt.
+  //
+  // If `response_time` is unset, then the task has not been attempted or is
+  // currently running and the `response_status` field is meaningless.
+  google.rpc.Status response_status = 4;
+}