Class: Google::Apis::CloudtasksV2beta3::Task

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2beta3/classes.rb,
generated/google/apis/cloudtasks_v2beta3/representations.rb,
generated/google/apis/cloudtasks_v2beta3/representations.rb

Overview

A unit of scheduled work.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Task

Returns a new instance of Task



1409
1410
1411
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1409

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_http_request ⇒ Google::Apis::CloudtasksV2beta3::AppEngineHttpRequest

App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_queue set. 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 set, app_engine_routing_override 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 with login: admin. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with login: 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]. 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt. Corresponds to the JSON property appEngineHttpRequest

Returns:



1314
1315
1316
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1314

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

Returns:

  • (String) 


1320
1321
1322
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1320

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

Returns:

  • (Fixnum) 


1327
1328
1329
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1327

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 the dispatch_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 property dispatchDeadline

Returns:

  • (String) 


1357
1358
1359
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1357

def dispatch_deadline
  @dispatch_deadline
end

#first_attempt ⇒ Google::Apis::CloudtasksV2beta3::Attempt

The status of a task attempt. Corresponds to the JSON property firstAttempt

Returns:



1362
1363
1364
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1362

def first_attempt
  @first_attempt
end

#last_attempt ⇒ Google::Apis::CloudtasksV2beta3::Attempt

The status of a task attempt. Corresponds to the JSON property lastAttempt

Returns:



1367
1368
1369
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1367

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 projects
  • LOCATION_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 property name

Returns:

  • (String) 


1389
1390
1391
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1389

def name
  @name
end

#response_count ⇒ Fixnum

Output only. The number of attempts which have received a response. Corresponds to the JSON property responseCount

Returns:

  • (Fixnum) 


1394
1395
1396
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1394

def response_count
  @response_count
end

#schedule_time ⇒ String

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. Corresponds to the JSON property scheduleTime

Returns:

  • (String) 


1401
1402
1403
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1401

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

Returns:

  • (String) 


1407
1408
1409
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1407

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1414

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