proto_docs/google/cloud/tasks/v2/task.rb in google-cloud-tasks-v2-0.7.0 vs proto_docs/google/cloud/tasks/v2/task.rb in google-cloud-tasks-v2-0.8.0
- old
+ new
@@ -22,11 +22,12 @@
module Tasks
module V2
# A unit of scheduled work.
# @!attribute [rw] name
# @return [::String]
- # Optionally caller-specified in {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}.
+ # Optionally caller-specified in
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}.
#
# The task name.
#
# The task name must have the following format:
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
@@ -46,16 +47,18 @@
# hyphens (-), or underscores (_). The maximum length is 500 characters.
# @!attribute [rw] app_engine_http_request
# @return [::Google::Cloud::Tasks::V2::AppEngineHttpRequest]
# HTTP request that is sent to the App Engine app handler.
#
- # An App Engine task is a task that has {::Google::Cloud::Tasks::V2::AppEngineHttpRequest AppEngineHttpRequest} set.
+ # An App Engine task is a task that has
+ # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest AppEngineHttpRequest} set.
# @!attribute [rw] http_request
# @return [::Google::Cloud::Tasks::V2::HttpRequest]
# HTTP request that is sent to the worker.
#
- # An HTTP task is a task that has {::Google::Cloud::Tasks::V2::HttpRequest HttpRequest} set.
+ # An HTTP task is a task that has
+ # {::Google::Cloud::Tasks::V2::HttpRequest HttpRequest} set.
# @!attribute [rw] schedule_time
# @return [::Google::Protobuf::Timestamp]
# The time when the task is scheduled to be attempted or retried.
#
# `schedule_time` will be truncated to the nearest microsecond.
@@ -76,14 +79,16 @@
# 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 {::Google::Cloud::Tasks::V2::HttpRequest HTTP tasks}, the default is 10 minutes. The deadline
+ # * For {::Google::Cloud::Tasks::V2::HttpRequest HTTP tasks}, the default is 10
+ # minutes. The deadline
# must be in the interval [15 seconds, 30 minutes].
#
- # * For {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks}, 0 indicates that the
+ # * For {::Google::Cloud::Tasks::V2::AppEngineHttpRequest 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)
# 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
@@ -108,19 +113,20 @@
# Output only. The number of attempts which have received a response.
# @!attribute [rw] first_attempt
# @return [::Google::Cloud::Tasks::V2::Attempt]
# Output only. The status of the task's first attempt.
#
- # Only {::Google::Cloud::Tasks::V2::Attempt#dispatch_time dispatch_time} will be set.
- # The other {::Google::Cloud::Tasks::V2::Attempt Attempt} information is not retained by Cloud Tasks.
+ # Only {::Google::Cloud::Tasks::V2::Attempt#dispatch_time dispatch_time} will be
+ # set. The other {::Google::Cloud::Tasks::V2::Attempt Attempt} information is not
+ # retained by Cloud Tasks.
# @!attribute [rw] last_attempt
# @return [::Google::Cloud::Tasks::V2::Attempt]
# Output only. The status of the task's last attempt.
# @!attribute [rw] view
# @return [::Google::Cloud::Tasks::V2::Task::View]
- # Output only. The view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} has
- # been returned.
+ # Output only. The view specifies which subset of the
+ # {::Google::Cloud::Tasks::V2::Task Task} has been returned.
class Task
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# The view specifies a subset of {::Google::Cloud::Tasks::V2::Task Task} data.
@@ -136,10 +142,11 @@
# The basic view omits fields which can be large or can contain
# sensitive data.
#
# This view does not include the
- # {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#body body in AppEngineHttpRequest}.
+ # [body in
+ # AppEngineHttpRequest][google.cloud.tasks.v2.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