Class Task (2.43.0)

public final class Task extends GeneratedMessageV3 implements TaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2beta2.Task

Implements

TaskOrBuilder

Static Fields

APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

HTTP_REQUEST_FIELD_NUMBER

public static final int HTTP_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PULL_MESSAGE_FIELD_NUMBER

public static final int PULL_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Task getDefaultInstance()
Returns
Type Description
Task

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Task.Builder newBuilder()
Returns
Type Description
Task.Builder

newBuilder(Task prototype)

public static Task.Builder newBuilder(Task prototype)
Parameter
Name Description
prototype Task
Returns
Type Description
Task.Builder

parseDelimitedFrom(InputStream input)

public static Task parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Task parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Task parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Task parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Task> parser()
Returns
Type Description
Parser<Task>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppEngineHttpRequest()

public 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 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 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 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

getDefaultInstanceForType()

public Task getDefaultInstanceForType()
Returns
Type Description
Task

getHttpRequest()

public 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.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
HttpRequest

The httpRequest.

getHttpRequestOrBuilder()

public 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.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
HttpRequestOrBuilder

getName()

public 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 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.

getParserForType()

public Parser<Task> getParserForType()
Returns
Type Description
Parser<Task>
Overrides

getPayloadTypeCase()

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

getPullMessage()

public 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 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 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public TaskStatus getStatus()

Output only. The task status.

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

Returns
Type Description
TaskStatus

The status.

getStatusOrBuilder()

public TaskStatusOrBuilder getStatusOrBuilder()

Output only. The task status.

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

Returns
Type Description
TaskStatusOrBuilder

getView()

public 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 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 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 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.

hasHttpRequest()

public 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.v2beta2.HttpRequest http_request = 13;

Returns
Type Description
boolean

Whether the httpRequest field is set.

hasPullMessage()

public 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 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 boolean hasStatus()

Output only. The task status.

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

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Task.Builder newBuilderForType()
Returns
Type Description
Task.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Task.Builder toBuilder()
Returns
Type Description
Task.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException