Interface TaskOrBuilder (2.3.1)

Version 2.3.1

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.12
• 2.2.0
• 2.1.11

public interface TaskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineHttpRequest()

public abstract AppEngineHttpRequest getAppEngineHttpRequest()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.

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

Returns

Type	Description
AppEngineHttpRequest	The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder()

public abstract AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta2.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 = 6;

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 = 6;

Returns

Type	Description
TimestampOrBuilder

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

LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns

Type	Description
PullMessage	The pullMessage.

getPullMessageOrBuilder()

public abstract PullMessageOrBuilder getPullMessageOrBuilder()

LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns

Type	Description
PullMessageOrBuilder

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. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

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. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

Returns

Type	Description
TimestampOrBuilder

getStatus()

public abstract TaskStatus getStatus()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns

Type	Description
TaskStatus	The status.

getStatusOrBuilder()

public abstract TaskStatusOrBuilder getStatusOrBuilder()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns

Type	Description
TaskStatusOrBuilder

getView()

public abstract Task.View getView()

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

.google.cloud.tasks.v2beta2.Task.View view = 8;

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.v2beta2.Task.View view = 8;

Returns

Type	Description
int	The enum numeric value on the wire for view.

hasAppEngineHttpRequest()

public abstract boolean hasAppEngineHttpRequest()

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2beta2.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 = 6;

Returns

Type	Description
boolean	Whether the createTime field is set.

hasPullMessage()

public abstract boolean hasPullMessage()

LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

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. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 5;

Returns

Type	Description
boolean	Whether the scheduleTime field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. The task status.

.google.cloud.tasks.v2beta2.TaskStatus status = 7;

Returns

Type	Description
boolean	Whether the status field is set.