Interface TaskOrBuilder (2.54.0) 

public interface TaskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineHttpRequest()

public abstract AppEngineHttpRequest getAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta3.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
AppEngineHttpRequest

The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder()

public abstract AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta3.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
AppEngineHttpRequestOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
TimestampOrBuilder

getDispatchCount()

public abstract int getDispatchCount()

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

int32 dispatch_count = 6;

Returns
Type Description
int

The dispatchCount.

getDispatchDeadline()

public abstract Duration getDispatchDeadline()

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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 12;

Returns
Type Description
Duration

The dispatchDeadline.

getDispatchDeadlineOrBuilder()

public abstract DurationOrBuilder getDispatchDeadlineOrBuilder()

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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 12;

Returns
Type Description
DurationOrBuilder

getFirstAttempt()

public abstract Attempt getFirstAttempt()

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.

.google.cloud.tasks.v2beta3.Attempt first_attempt = 8;

Returns
Type Description
Attempt

The firstAttempt.

getFirstAttemptOrBuilder()

public abstract AttemptOrBuilder getFirstAttemptOrBuilder()

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.

.google.cloud.tasks.v2beta3.Attempt first_attempt = 8;

Returns
Type Description
AttemptOrBuilder

getHttpRequest()

public abstract HttpRequest getHttpRequest()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta3.HttpRequest http_request = 11;

Returns
Type Description
HttpRequest

The httpRequest.

getHttpRequestOrBuilder()

public abstract HttpRequestOrBuilder getHttpRequestOrBuilder()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta3.HttpRequest http_request = 11;

Returns
Type Description
HttpRequestOrBuilder

getLastAttempt()

public abstract Attempt getLastAttempt()

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

.google.cloud.tasks.v2beta3.Attempt last_attempt = 9;

Returns
Type Description
Attempt

The lastAttempt.

getLastAttemptOrBuilder()

public abstract AttemptOrBuilder getLastAttemptOrBuilder()

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

.google.cloud.tasks.v2beta3.Attempt last_attempt = 9;

Returns
Type Description
AttemptOrBuilder

getName()

public abstract String getName()

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.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPayloadTypeCase()

public abstract Task.PayloadTypeCase getPayloadTypeCase()
Returns
Type Description
Task.PayloadTypeCase

getPullMessage()

public abstract PullMessage getPullMessage()

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.

.google.cloud.tasks.v2beta3.PullMessage pull_message = 13;

Returns
Type Description
PullMessage

The pullMessage.

getPullMessageOrBuilder()

public abstract PullMessageOrBuilder getPullMessageOrBuilder()

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.

.google.cloud.tasks.v2beta3.PullMessage pull_message = 13;

Returns
Type Description
PullMessageOrBuilder

getResponseCount()

public abstract int getResponseCount()

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

int32 response_count = 7;

Returns
Type Description
int

The responseCount.

getScheduleTime()

public abstract Timestamp getScheduleTime()

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.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeOrBuilder()

public abstract TimestampOrBuilder getScheduleTimeOrBuilder()

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.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
TimestampOrBuilder

getView()

public abstract Task.View getView()

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

.google.cloud.tasks.v2beta3.Task.View view = 10;

Returns
Type Description
Task.View

The view.

getViewValue()

public abstract int getViewValue()

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

.google.cloud.tasks.v2beta3.Task.View view = 10;

Returns
Type Description
int

The enum numeric value on the wire for view.

hasAppEngineHttpRequest()

public abstract boolean hasAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta3.AppEngineHttpRequest app_engine_http_request = 3;

Returns
Type Description
boolean

Whether the appEngineHttpRequest field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDispatchDeadline()

public abstract boolean hasDispatchDeadline()

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.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 12;

Returns
Type Description
boolean

Whether the dispatchDeadline field is set.

hasFirstAttempt()

public abstract boolean hasFirstAttempt()

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.

.google.cloud.tasks.v2beta3.Attempt first_attempt = 8;

Returns
Type Description
boolean

Whether the firstAttempt field is set.

hasHttpRequest()

public abstract boolean hasHttpRequest()

HTTP request that is sent to the task's target.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2beta3.HttpRequest http_request = 11;

Returns
Type Description
boolean

Whether the httpRequest field is set.

hasLastAttempt()

public abstract boolean hasLastAttempt()

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

.google.cloud.tasks.v2beta3.Attempt last_attempt = 9;

Returns
Type Description
boolean

Whether the lastAttempt field is set.

hasPullMessage()

public abstract boolean hasPullMessage()

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.

.google.cloud.tasks.v2beta3.PullMessage pull_message = 13;

Returns
Type Description
boolean

Whether the pullMessage field is set.

hasScheduleTime()

public abstract boolean hasScheduleTime()

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.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
boolean

Whether the scheduleTime field is set.