Class Task.Builder (2.20.0)

publicstaticfinalclass Task.BuilderextendsGeneratedMessageV3.Builder<Task.Builder>implementsTaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2beta2.Task

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Task.Builder

Implements

TaskOrBuilder

Inherited Members

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicTask.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicTaskbuild()

publicTaskbuildPartial()

publicTask.Builderclear()

GeneratedMessageV3.Builder<BuilderType>.clear()

publicTask.BuilderclearAppEngineHttpRequest()

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;

publicTask.BuilderclearCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTask.BuilderclearField(Descriptors.FieldDescriptorfield)

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

publicTask.BuilderclearName()

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;

publicTask.BuilderclearOneof(Descriptors.OneofDescriptoroneof)

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

publicTask.BuilderclearPayloadType()

publicTask.BuilderclearPullMessage()

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;

publicTask.BuilderclearScheduleTime()

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;

publicTask.BuilderclearStatus()

Output only. The task status.

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

publicTask.BuilderclearView()

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

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

publicTask.Builderclone()

GeneratedMessageV3.Builder<BuilderType>.clone()

publicAppEngineHttpRequestgetAppEngineHttpRequest()

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;

publicAppEngineHttpRequest.BuildergetAppEngineHttpRequestBuilder()

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;

publicAppEngineHttpRequestOrBuildergetAppEngineHttpRequestOrBuilder()

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;

publicTimestampgetCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTimestamp.BuildergetCreateTimeBuilder()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTaskgetDefaultInstanceForType()

publicDescriptors.DescriptorgetDescriptorForType()

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

publicStringgetName()

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;

publicByteStringgetNameBytes()

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;

publicTask.PayloadTypeCasegetPayloadTypeCase()

publicPullMessagegetPullMessage()

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;

publicPullMessage.BuildergetPullMessageBuilder()

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;

publicPullMessageOrBuildergetPullMessageOrBuilder()

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;

publicTimestampgetScheduleTime()

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;

publicTimestamp.BuildergetScheduleTimeBuilder()

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;

publicTimestampOrBuildergetScheduleTimeOrBuilder()

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;

publicTaskStatusgetStatus()

Output only. The task status.

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

publicTaskStatus.BuildergetStatusBuilder()

Output only. The task status.

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

publicTaskStatusOrBuildergetStatusOrBuilder()

Output only. The task status.

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

publicTask.ViewgetView()

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

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

publicintgetViewValue()

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

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

publicbooleanhasAppEngineHttpRequest()

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;

publicbooleanhasCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicbooleanhasPullMessage()

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;

publicbooleanhasScheduleTime()

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;

publicbooleanhasStatus()

Output only. The task status.

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

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

publicTask.BuildermergeAppEngineHttpRequest(AppEngineHttpRequestvalue)

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;

publicTask.BuildermergeCreateTime(Timestampvalue)

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTask.BuildermergeFrom(Taskother)

publicTask.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicTask.BuildermergeFrom(Messageother)

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

publicTask.BuildermergePullMessage(PullMessagevalue)

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;

publicTask.BuildermergeScheduleTime(Timestampvalue)

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;

publicTask.BuildermergeStatus(TaskStatusvalue)

Output only. The task status.

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

publicfinalTask.BuildermergeUnknownFields(UnknownFieldSetunknownFields)

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

publicTask.BuildersetAppEngineHttpRequest(AppEngineHttpRequestvalue)

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;

publicTask.BuildersetAppEngineHttpRequest(AppEngineHttpRequest.BuilderbuilderForValue)

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;

publicTask.BuildersetCreateTime(Timestampvalue)

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTask.BuildersetCreateTime(Timestamp.BuilderbuilderForValue)

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 6;

publicTask.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

publicTask.BuildersetName(Stringvalue)

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;

publicTask.BuildersetNameBytes(ByteStringvalue)

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;

publicTask.BuildersetPullMessage(PullMessagevalue)

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;

publicTask.BuildersetPullMessage(PullMessage.BuilderbuilderForValue)

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;

publicTask.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicTask.BuildersetScheduleTime(Timestampvalue)

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;

publicTask.BuildersetScheduleTime(Timestamp.BuilderbuilderForValue)

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;

publicTask.BuildersetStatus(TaskStatusvalue)

Output only. The task status.

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

publicTask.BuildersetStatus(TaskStatus.BuilderbuilderForValue)

Output only. The task status.

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

publicfinalTask.BuildersetUnknownFields(UnknownFieldSetunknownFields)

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

publicTask.BuildersetView(Task.Viewvalue)

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

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

publicTask.BuildersetViewValue(intvalue)

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

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