Class: Google::Cloud::Tasks::V2beta3::Task
- Inherits:
-
Object
- Object
- Google::Cloud::Tasks::V2beta3::Task
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/tasks/v2beta3/task.rb
Overview
A unit of scheduled work.
Defined Under Namespace
Modules: View
Instance Attribute Summary collapse
-
#app_engine_http_request ⇒ ::Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest
HTTP request that is sent to the App Engine app handler.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
Output only.
-
#dispatch_count ⇒ ::Integer
Output only.
-
#dispatch_deadline ⇒ ::Google::Protobuf::Duration
The deadline for requests sent to the worker.
-
#first_attempt ⇒ ::Google::Cloud::Tasks::V2beta3::Attempt
Output only.
-
#http_request ⇒ ::Google::Cloud::Tasks::V2beta3::HttpRequest
HTTP request that is sent to the task's target.
-
#last_attempt ⇒ ::Google::Cloud::Tasks::V2beta3::Attempt
Output only.
-
#name ⇒ ::String
Optionally caller-specified in CreateTask.
-
#pull_message ⇒ ::Google::Cloud::Tasks::V2beta3::PullMessage
Pull Message contained in a task in a PULL queue type.
-
#response_count ⇒ ::Integer
Output only.
-
#schedule_time ⇒ ::Google::Protobuf::Timestamp
The time when the task is scheduled to be attempted.
-
#view ⇒ ::Google::Cloud::Tasks::V2beta3::Task::View
Output only.
Instance Attribute Details
#app_engine_http_request ⇒ ::Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest
Returns HTTP request that is sent to the App Engine app handler.
An App Engine task is a task that has AppEngineHttpRequest set.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#create_time ⇒ ::Google::Protobuf::Timestamp
Returns Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#dispatch_count ⇒ ::Integer
Returns Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't received a response.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#dispatch_deadline ⇒ ::Google::Protobuf::Duration
Returns 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.
Note that when the request is cancelled, Cloud Tasks will stop listening 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, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].
For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type 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 thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts.
dispatch_deadline
will be truncated to the nearest millisecond. The
deadline is an approximate deadline.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#first_attempt ⇒ ::Google::Cloud::Tasks::V2beta3::Attempt
Returns Output only. The status of the task's first attempt.
Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#http_request ⇒ ::Google::Cloud::Tasks::V2beta3::HttpRequest
Returns HTTP request that is sent to the task's target.
An HTTP task is a task that has HttpRequest set.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#last_attempt ⇒ ::Google::Cloud::Tasks::V2beta3::Attempt
Returns Output only. The status of the task's last attempt.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#name ⇒ ::String
Returns Optionally caller-specified in 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 projectsLOCATION_ID
is the canonical ID for the task's location. The list of available locations can be obtained by calling::Google::Cloud::Location::Locations::Client#list_locations
. 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.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#pull_message ⇒ ::Google::Cloud::Tasks::V2beta3::PullMessage
Returns Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#response_count ⇒ ::Integer
Returns Output only. The number of attempts which have received a response.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#schedule_time ⇒ ::Google::Protobuf::Timestamp
Returns 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.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |
#view ⇒ ::Google::Cloud::Tasks::V2beta3::Task::View
Returns Output only. The view specifies which subset of the Task has been returned.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'proto_docs/google/cloud/tasks/v2beta3/task.rb', line 141 class Task include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The view specifies a subset of {::Google::Cloud::Tasks::V2beta3::Task 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. module 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 {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} # requires `cloudtasks.tasks.fullView` [Google # IAM](https://cloud.google.com/iam/) permission on the # {::Google::Cloud::Tasks::V2beta3::Queue Queue} resource. FULL = 2 end end |