Class Task.Builder (2.16.0)

public static final class Task.Builder extends GeneratedMessageV3.Builder<Task.Builder> implements TaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2beta2.Task

Implements

TaskOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Task.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Task.Builder
Overrides

build()

public Task build()
Returns
TypeDescription
Task

buildPartial()

public Task buildPartial()
Returns
TypeDescription
Task

clear()

public Task.Builder clear()
Returns
TypeDescription
Task.Builder
Overrides

clearAppEngineHttpRequest()

public Task.Builder clearAppEngineHttpRequest()

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
TypeDescription
Task.Builder

clearCreateTime()

public Task.Builder clearCreateTime()

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
TypeDescription
Task.Builder

clearField(Descriptors.FieldDescriptor field)

public Task.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Task.Builder
Overrides

clearName()

public Task.Builder clearName()

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
TypeDescription
Task.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Task.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Task.Builder
Overrides

clearPayloadType()

public Task.Builder clearPayloadType()
Returns
TypeDescription
Task.Builder

clearPullMessage()

public Task.Builder clearPullMessage()

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
TypeDescription
Task.Builder

clearScheduleTime()

public Task.Builder clearScheduleTime()

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
TypeDescription
Task.Builder

clearStatus()

public Task.Builder clearStatus()

Output only. The task status.

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

Returns
TypeDescription
Task.Builder

clearView()

public Task.Builder clearView()

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

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

Returns
TypeDescription
Task.Builder

This builder for chaining.

clone()

public Task.Builder clone()
Returns
TypeDescription
Task.Builder
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
TypeDescription
AppEngineHttpRequest

The appEngineHttpRequest.

getAppEngineHttpRequestBuilder()

public AppEngineHttpRequest.Builder getAppEngineHttpRequestBuilder()

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
TypeDescription
AppEngineHttpRequest.Builder

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
TypeDescription
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
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Task getDefaultInstanceForType()
Returns
TypeDescription
Task

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getPayloadTypeCase()

public Task.PayloadTypeCase getPayloadTypeCase()
Returns
TypeDescription
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
TypeDescription
PullMessage

The pullMessage.

getPullMessageBuilder()

public PullMessage.Builder getPullMessageBuilder()

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
TypeDescription
PullMessage.Builder

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
TypeDescription
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
TypeDescription
Timestamp

The scheduleTime.

getScheduleTimeBuilder()

public Timestamp.Builder getScheduleTimeBuilder()

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
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

getStatus()

public TaskStatus getStatus()

Output only. The task status.

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

Returns
TypeDescription
TaskStatus

The status.

getStatusBuilder()

public TaskStatus.Builder getStatusBuilder()

Output only. The task status.

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

Returns
TypeDescription
TaskStatus.Builder

getStatusOrBuilder()

public TaskStatusOrBuilder getStatusOrBuilder()

Output only. The task status.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the createTime 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
TypeDescription
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
TypeDescription
boolean

Whether the scheduleTime field is set.

hasStatus()

public boolean hasStatus()

Output only. The task status.

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

Returns
TypeDescription
boolean

Whether the status field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAppEngineHttpRequest(AppEngineHttpRequest value)

public Task.Builder mergeAppEngineHttpRequest(AppEngineHttpRequest value)

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;

Parameter
NameDescription
valueAppEngineHttpRequest
Returns
TypeDescription
Task.Builder

mergeCreateTime(Timestamp value)

public Task.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Task.Builder

mergeFrom(Task other)

public Task.Builder mergeFrom(Task other)
Parameter
NameDescription
otherTask
Returns
TypeDescription
Task.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Task.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Task.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Task.Builder
Overrides

mergePullMessage(PullMessage value)

public Task.Builder mergePullMessage(PullMessage value)

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;

Parameter
NameDescription
valuePullMessage
Returns
TypeDescription
Task.Builder

mergeScheduleTime(Timestamp value)

public Task.Builder mergeScheduleTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Task.Builder

mergeStatus(TaskStatus value)

public Task.Builder mergeStatus(TaskStatus value)

Output only. The task status.

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

Parameter
NameDescription
valueTaskStatus
Returns
TypeDescription
Task.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Task.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Task.Builder
Overrides

setAppEngineHttpRequest(AppEngineHttpRequest value)

public Task.Builder setAppEngineHttpRequest(AppEngineHttpRequest value)

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;

Parameter
NameDescription
valueAppEngineHttpRequest
Returns
TypeDescription
Task.Builder

setAppEngineHttpRequest(AppEngineHttpRequest.Builder builderForValue)

public Task.Builder setAppEngineHttpRequest(AppEngineHttpRequest.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueAppEngineHttpRequest.Builder
Returns
TypeDescription
Task.Builder

setCreateTime(Timestamp value)

public Task.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Task.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Task.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Task.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Task.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Task.Builder
Overrides

setName(String value)

public Task.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Task.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Task.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Task.Builder

This builder for chaining.

setPullMessage(PullMessage value)

public Task.Builder setPullMessage(PullMessage value)

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;

Parameter
NameDescription
valuePullMessage
Returns
TypeDescription
Task.Builder

setPullMessage(PullMessage.Builder builderForValue)

public Task.Builder setPullMessage(PullMessage.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuePullMessage.Builder
Returns
TypeDescription
Task.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Task.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Task.Builder
Overrides

setScheduleTime(Timestamp value)

public Task.Builder setScheduleTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Task.Builder

setScheduleTime(Timestamp.Builder builderForValue)

public Task.Builder setScheduleTime(Timestamp.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Task.Builder

setStatus(TaskStatus value)

public Task.Builder setStatus(TaskStatus value)

Output only. The task status.

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

Parameter
NameDescription
valueTaskStatus
Returns
TypeDescription
Task.Builder

setStatus(TaskStatus.Builder builderForValue)

public Task.Builder setStatus(TaskStatus.Builder builderForValue)

Output only. The task status.

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

Parameter
NameDescription
builderForValueTaskStatus.Builder
Returns
TypeDescription
Task.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Task.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Task.Builder
Overrides

setView(Task.View value)

public Task.Builder setView(Task.View value)

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

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

Parameter
NameDescription
valueTask.View

The view to set.

Returns
TypeDescription
Task.Builder

This builder for chaining.

setViewValue(int value)

public Task.Builder setViewValue(int value)

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

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for view to set.

Returns
TypeDescription
Task.Builder

This builder for chaining.