Class Task

A unit of scheduled work.

Inheritance
object
Task
Implements
Inherited Members
Namespace: Google.Apis.CloudTasks.v2beta3.Data
Assembly: Google.Apis.CloudTasks.v2beta3.dll
Syntax
public class Task : IDirectResponseSchema

Properties

AppEngineHttpRequest

HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.

Declaration
[JsonProperty("appEngineHttpRequest")]
public virtual AppEngineHttpRequest AppEngineHttpRequest { get; set; }
Property Value
Type Description
AppEngineHttpRequest

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time that the task was created. create_time will be truncated to the nearest second.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DispatchCount

Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.

Declaration
[JsonProperty("dispatchCount")]
public virtual int? DispatchCount { get; set; }
Property Value
Type Description
int?

DispatchDeadline

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 the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

Declaration
[JsonProperty("dispatchDeadline")]
public virtual object DispatchDeadline { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FirstAttempt

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.

Declaration
[JsonProperty("firstAttempt")]
public virtual Attempt FirstAttempt { get; set; }
Property Value
Type Description
Attempt

HttpRequest

HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.

Declaration
[JsonProperty("httpRequest")]
public virtual HttpRequest HttpRequest { get; set; }
Property Value
Type Description
HttpRequest

LastAttempt

Output only. The status of the task's last attempt.

Declaration
[JsonProperty("lastAttempt")]
public virtual Attempt LastAttempt { get; set; }
Property Value
Type Description
Attempt

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PullMessage

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.

Declaration
[JsonProperty("pullMessage")]
public virtual PullMessage PullMessage { get; set; }
Property Value
Type Description
PullMessage

ResponseCount

Output only. The number of attempts which have received a response.

Declaration
[JsonProperty("responseCount")]
public virtual int? ResponseCount { get; set; }
Property Value
Type Description
int?

ScheduleTime

object representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ScheduleTimeDateTimeOffset instead.")]
public virtual object ScheduleTime { get; set; }
Property Value
Type Description
object

ScheduleTimeDateTimeOffset

DateTimeOffset representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ScheduleTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ScheduleTimeRaw

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.

Declaration
[JsonProperty("scheduleTime")]
public virtual string ScheduleTimeRaw { get; set; }
Property Value
Type Description
string

View

Output only. The view specifies which subset of the Task has been returned.

Declaration
[JsonProperty("view")]
public virtual string View { get; set; }
Property Value
Type Description
string

Implements