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



1348
1349
1350
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1348

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:



1284
1285
1286
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1284

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) 


1290
1291
1292
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1290

def create_time
  @create_time
end

#dispatch_count ⇒ Fixnum

Output only. The number of attempts dispatched. This count includes tasks which have been dispatched but haven't received a response. Corresponds to the JSON property dispatchCount

Returns:

  • (Fixnum) 


1297
1298
1299
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1297

def dispatch_count
  @dispatch_count
end

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

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

Returns:



1302
1303
1304
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1302

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:



1307
1308
1309
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1307

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) 


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

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) 


1333
1334
1335
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1333

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) 


1340
1341
1342
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1340

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) 


1346
1347
1348
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1346

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 1353

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)
  @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