- 2.53.0 (latest)
- 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 static final class Task.Builder extends GeneratedMessageV3.Builder<Task.Builder> implements TaskOrBuilderA unit of scheduled work.
Protobuf type google.cloud.tasks.v2beta2.Task
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Task.BuilderImplements
TaskOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Task.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
build()
public Task build()| Returns | |
|---|---|
| Type | Description |
Task | |
buildPartial()
public Task buildPartial()| Returns | |
|---|---|
| Type | Description |
Task | |
clear()
public Task.Builder clear()| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Task.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Task.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
clearHttpRequest()
public Task.Builder clearHttpRequest()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 |
Task.Builder | |
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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Task.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Task.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
clearPayloadType()
public Task.Builder clearPayloadType()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Task.Builder | |
clearStatus()
public Task.Builder clearStatus()Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Task.Builder | This builder for chaining. |
clone()
public Task.Builder clone()| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDefaultInstanceForType()
public Task getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Task | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getHttpRequestBuilder()
public HttpRequest.Builder getHttpRequestBuilder()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.Builder | |
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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_IDcan 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_IDcan 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 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getStatus()
public TaskStatus getStatus()Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Returns | |
|---|---|
| Type | Description |
TaskStatus | The status. |
getStatusBuilder()
public TaskStatus.Builder getStatusBuilder()Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Returns | |
|---|---|
| Type | Description |
TaskStatus.Builder | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
|---|---|
| Name | Description |
value | AppEngineHttpRequest |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
mergeFrom(Task other)
public Task.Builder mergeFrom(Task other)| Parameter | |
|---|---|
| Name | Description |
other | Task |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Task.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Task.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
mergeHttpRequest(HttpRequest value)
public Task.Builder mergeHttpRequest(HttpRequest value)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;
| Parameter | |
|---|---|
| Name | Description |
value | HttpRequest |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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 | |
|---|---|
| Name | Description |
value | PullMessage |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
mergeStatus(TaskStatus value)
public Task.Builder mergeStatus(TaskStatus value)Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Parameter | |
|---|---|
| Name | Description |
value | TaskStatus |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Task.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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 | |
|---|---|
| Name | Description |
value | AppEngineHttpRequest |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | AppEngineHttpRequest.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Task.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setHttpRequest(HttpRequest value)
public Task.Builder setHttpRequest(HttpRequest value)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;
| Parameter | |
|---|---|
| Name | Description |
value | HttpRequest |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setHttpRequest(HttpRequest.Builder builderForValue)
public Task.Builder setHttpRequest(HttpRequest.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | HttpRequest.Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | PullMessage |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | PullMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Task.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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 | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setStatus(TaskStatus value)
public Task.Builder setStatus(TaskStatus value)Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;
| Parameter | |
|---|---|
| Name | Description |
value | TaskStatus |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | TaskStatus.Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Task.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | |
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 | |
|---|---|
| Name | Description |
value | Task.ViewThe view to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for view to set. |
| Returns | |
|---|---|
| Type | Description |
Task.Builder | This builder for chaining. |