Skip to content

Commit

Permalink
docs: update comments on protos (#180)
Browse files Browse the repository at this point in the history
docs: update comments on protos
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Mar 1, 2019
1 parent 3778a90 commit c0cc663
Show file tree
Hide file tree
Showing 19 changed files with 1,963 additions and 1,437 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ 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.
// 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
Expand All @@ -44,22 +44,26 @@ message Task {
// 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.
// ([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.
// 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;
}

// Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
// Optionally caller-specified in
// [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
//
// The task name.
//
Expand All @@ -69,7 +73,8 @@ message Task {
// * `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)
// [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].
Expand All @@ -87,16 +92,21 @@ message Task {
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.
// [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.
// 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.
// [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.
// A pull task is a task that has
// [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
PullMessage pull_message = 4;
}

Expand All @@ -107,7 +117,8 @@ message Task {
// 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].
// 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;
Expand All @@ -120,8 +131,8 @@ message Task {
// 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.
// Output only. The view specifies which subset of the
// [Task][google.cloud.tasks.v2beta2.Task] has been returned.
View view = 8;
}

Expand All @@ -135,20 +146,26 @@ message TaskStatus {

// Output only. The number of attempts which have received a response.
//
// This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage].
// This field is not calculated for [pull
// tasks][google.cloud.tasks.v2beta2.PullMessage].
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.
// 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.PullMessage].
// This field is not calculated for [pull
// tasks][google.cloud.tasks.v2beta2.PullMessage].
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.PullMessage].
// This field is not calculated for [pull
// tasks][google.cloud.tasks.v2beta2.PullMessage].
AttemptStatus last_attempt_status = 4;
}

Expand Down
Loading

0 comments on commit c0cc663

Please sign in to comment.