Class: Google::Apis::CloudtasksV2::Task
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2::Task
- Defined in:
- generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/representations.rb
Overview
A unit of scheduled work.
Instance Attribute Summary collapse
-
#app_engine_http_request ⇒ Google::Apis::CloudtasksV2::AppEngineHttpRequest
App Engine HTTP request.
-
#create_time ⇒ String
Output only.
-
#dispatch_count ⇒ Fixnum
Output only.
-
#dispatch_deadline ⇒ String
The deadline for requests sent to the worker.
-
#first_attempt ⇒ Google::Apis::CloudtasksV2::Attempt
The status of a task attempt.
-
#last_attempt ⇒ Google::Apis::CloudtasksV2::Attempt
The status of a task attempt.
-
#name ⇒ String
Optionally caller-specified in CreateTask.
-
#response_count ⇒ Fixnum
Output only.
-
#schedule_time ⇒ String
The time when the task is scheduled to be attempted or retried.
-
#view ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Task
constructor
A new instance of Task.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Task
Returns a new instance of Task
1350 1351 1352 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1350 def initialize(**args) update!(**args) end |
Instance Attribute Details
#app_engine_http_request ⇒ Google::Apis::CloudtasksV2::AppEngineHttpRequest
App Engine HTTP request.
The message defines the HTTP request that is sent to an App Engine app when
the task is dispatched.
Using AppEngineHttpRequest requires
appengine.applications.get
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
and how routing is affected by
dispatch
files.
Traffic is encrypted during transport and never leaves Google datacenters.
Because this traffic is carried over a communication mechanism internal to
Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
The request to the handler, however, will appear to have used the HTTP
protocol.
The AppEngineRouting used to construct the URL that the task is
delivered to can be set at the queue-level or task-level:
- If app_engine_routing_override is set on the
queue, this value is used for all
tasks in the queue, no matter what the setting is for the task-level
app_engine_routing.
The
url
that the task will be sent to is: url =
host+
relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted withlogin: admin
. Because tasks are not run as any user, they cannot be dispatched to URIs restricted withlogin: required
Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [200
-299
]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration.503
(Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a429
(Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. Corresponds to the JSON propertyappEngineHttpRequest
1256 1257 1258 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1256 def app_engine_http_request @app_engine_http_request end |
#create_time ⇒ String
Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
Corresponds to the JSON property createTime
1262 1263 1264 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1262 def create_time @create_time end |
#dispatch_count ⇒ Fixnum
Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't
received a response.
Corresponds to the JSON property dispatchCount
1269 1270 1271 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1269 def dispatch_count @dispatch_count end |
#dispatch_deadline ⇒ String
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 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 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. Corresponds to the JSON propertydispatchDeadline
1299 1300 1301 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1299 def dispatch_deadline @dispatch_deadline end |
#first_attempt ⇒ Google::Apis::CloudtasksV2::Attempt
The status of a task attempt.
Corresponds to the JSON property firstAttempt
1304 1305 1306 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1304 def first_attempt @first_attempt end |
#last_attempt ⇒ Google::Apis::CloudtasksV2::Attempt
The status of a task attempt.
Corresponds to the JSON property lastAttempt
1309 1310 1311 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1309 def last_attempt @last_attempt end |
#name ⇒ String
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 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. Corresponds to the JSON propertyname
1331 1332 1333 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1331 def name @name end |
#response_count ⇒ Fixnum
Output only. The number of attempts which have received a response.
Corresponds to the JSON property responseCount
1336 1337 1338 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1336 def response_count @response_count end |
#schedule_time ⇒ String
The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond.
Corresponds to the JSON property scheduleTime
1342 1343 1344 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1342 def schedule_time @schedule_time end |
#view ⇒ String
Output only. The view specifies which subset of the Task has
been returned.
Corresponds to the JSON property view
1348 1349 1350 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1348 def view @view end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 |
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 1355 def update!(**args) @app_engine_http_request = args[:app_engine_http_request] if args.key?(:app_engine_http_request) @create_time = args[:create_time] if args.key?(:create_time) @dispatch_count = args[:dispatch_count] if args.key?(:dispatch_count) @dispatch_deadline = args[:dispatch_deadline] if args.key?(:dispatch_deadline) @first_attempt = args[:first_attempt] if args.key?(:first_attempt) @last_attempt = args[:last_attempt] if args.key?(:last_attempt) @name = args[:name] if args.key?(:name) @response_count = args[:response_count] if args.key?(:response_count) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) @view = args[:view] if args.key?(:view) end |