Class Task.Builder (2.53.0) 

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

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2.Task

Inheritance

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

Implements

TaskOrBuilder

Static 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
Overrides

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
Overrides

clearAppEngineHttpRequest()

public Task.Builder clearAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

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

Returns
Type Description
Task.Builder

clearDispatchCount()

public Task.Builder clearDispatchCount()

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

int32 dispatch_count = 7;

Returns
Type Description
Task.Builder

This builder for chaining.

clearDispatchDeadline()

public Task.Builder clearDispatchDeadline()

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 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
Overrides

clearFirstAttempt()

public Task.Builder clearFirstAttempt()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
Task.Builder

clearHttpRequest()

public Task.Builder clearHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
Task.Builder

clearLastAttempt()

public Task.Builder clearLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
Task.Builder

clearMessageType()

public Task.Builder clearMessageType()
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_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
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
Overrides

clearResponseCount()

public Task.Builder clearResponseCount()

Output only. The number of attempts which have received a response.

int32 response_count = 8;

Returns
Type Description
Task.Builder

This builder for chaining.

clearScheduleTime()

public Task.Builder clearScheduleTime()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

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.v2.Task.View view = 11;

Returns
Type Description
Task.Builder

This builder for chaining.

clone()

public Task.Builder clone()
Returns
Type Description
Task.Builder
Overrides

getAppEngineHttpRequest()

public AppEngineHttpRequest getAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Returns
Type Description
AppEngineHttpRequest

The appEngineHttpRequest.

getAppEngineHttpRequestBuilder()

public AppEngineHttpRequest.Builder getAppEngineHttpRequestBuilder()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Returns
Type Description
AppEngineHttpRequest.Builder

getAppEngineHttpRequestOrBuilder()

public AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

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

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

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Task getDefaultInstanceForType()
Returns
Type Description
Task

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDispatchCount()

public int getDispatchCount()

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

int32 dispatch_count = 7;

Returns
Type Description
int

The dispatchCount.

getDispatchDeadline()

public Duration getDispatchDeadline()

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
Duration

The dispatchDeadline.

getDispatchDeadlineBuilder()

public Duration.Builder getDispatchDeadlineBuilder()

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
Builder

getDispatchDeadlineOrBuilder()

public DurationOrBuilder getDispatchDeadlineOrBuilder()

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
DurationOrBuilder

getFirstAttempt()

public Attempt getFirstAttempt()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
Attempt

The firstAttempt.

getFirstAttemptBuilder()

public Attempt.Builder getFirstAttemptBuilder()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
Attempt.Builder

getFirstAttemptOrBuilder()

public AttemptOrBuilder getFirstAttemptOrBuilder()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
AttemptOrBuilder

getHttpRequest()

public HttpRequest getHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
HttpRequest

The httpRequest.

getHttpRequestBuilder()

public HttpRequest.Builder getHttpRequestBuilder()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
HttpRequest.Builder

getHttpRequestOrBuilder()

public HttpRequestOrBuilder getHttpRequestOrBuilder()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
HttpRequestOrBuilder

getLastAttempt()

public Attempt getLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
Attempt

The lastAttempt.

getLastAttemptBuilder()

public Attempt.Builder getLastAttemptBuilder()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
Attempt.Builder

getLastAttemptOrBuilder()

public AttemptOrBuilder getLastAttemptOrBuilder()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
AttemptOrBuilder

getMessageTypeCase()

public Task.MessageTypeCase getMessageTypeCase()
Returns
Type Description
Task.MessageTypeCase

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.

getResponseCount()

public int getResponseCount()

Output only. The number of attempts which have received a response.

int32 response_count = 8;

Returns
Type Description
int

The responseCount.

getScheduleTime()

public Timestamp getScheduleTime()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeBuilder()

public Timestamp.Builder getScheduleTimeBuilder()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
Builder

getScheduleTimeOrBuilder()

public TimestampOrBuilder getScheduleTimeOrBuilder()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
TimestampOrBuilder

getView()

public Task.View getView()

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

.google.cloud.tasks.v2.Task.View view = 11;

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.v2.Task.View view = 11;

Returns
Type Description
int

The enum numeric value on the wire for view.

hasAppEngineHttpRequest()

public boolean hasAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasDispatchDeadline()

public boolean hasDispatchDeadline()

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Returns
Type Description
boolean

Whether the dispatchDeadline field is set.

hasFirstAttempt()

public boolean hasFirstAttempt()

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Returns
Type Description
boolean

Whether the firstAttempt field is set.

hasHttpRequest()

public boolean hasHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Returns
Type Description
boolean

Whether the httpRequest field is set.

hasLastAttempt()

public boolean hasLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Returns
Type Description
boolean

Whether the lastAttempt field is set.

hasScheduleTime()

public boolean hasScheduleTime()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Returns
Type Description
boolean

Whether the scheduleTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppEngineHttpRequest(AppEngineHttpRequest value)

public Task.Builder mergeAppEngineHttpRequest(AppEngineHttpRequest value)

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Task.Builder

mergeDispatchDeadline(Duration value)

public Task.Builder mergeDispatchDeadline(Duration value)

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Parameter
Name Description
value Duration
Returns
Type Description
Task.Builder

mergeFirstAttempt(Attempt value)

public Task.Builder mergeFirstAttempt(Attempt value)

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Parameter
Name Description
value Attempt
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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Task.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Task.Builder
Overrides

mergeHttpRequest(HttpRequest value)

public Task.Builder mergeHttpRequest(HttpRequest value)

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Parameter
Name Description
value HttpRequest
Returns
Type Description
Task.Builder

mergeLastAttempt(Attempt value)

public Task.Builder mergeLastAttempt(Attempt value)

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Parameter
Name Description
value Attempt
Returns
Type Description
Task.Builder

mergeScheduleTime(Timestamp value)

public Task.Builder mergeScheduleTime(Timestamp value)

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Parameter
Name Description
value Timestamp
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
Overrides

setAppEngineHttpRequest(AppEngineHttpRequest value)

public Task.Builder setAppEngineHttpRequest(AppEngineHttpRequest value)

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

Parameter
Name Description
value AppEngineHttpRequest
Returns
Type Description
Task.Builder

setAppEngineHttpRequest(AppEngineHttpRequest.Builder builderForValue)

public Task.Builder setAppEngineHttpRequest(AppEngineHttpRequest.Builder builderForValue)

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Task.Builder

setDispatchCount(int value)

public Task.Builder setDispatchCount(int value)

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

int32 dispatch_count = 7;

Parameter
Name Description
value int

The dispatchCount to set.
Returns
Type Description
Task.Builder

This builder for chaining.

setDispatchDeadline(Duration value)

public Task.Builder setDispatchDeadline(Duration value)

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

Parameter
Name Description
value Duration
Returns
Type Description
Task.Builder

setDispatchDeadline(Duration.Builder builderForValue)

public Task.Builder setDispatchDeadline(Duration.Builder builderForValue)

The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

The default and maximum values depend on the type of request:

  • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

  • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 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
Overrides

setFirstAttempt(Attempt value)

public Task.Builder setFirstAttempt(Attempt value)

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Parameter
Name Description
value Attempt
Returns
Type Description
Task.Builder

setFirstAttempt(Attempt.Builder builderForValue)

public Task.Builder setFirstAttempt(Attempt.Builder builderForValue)

Output only. The status of the task's first attempt.

Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

Parameter
Name Description
builderForValue Attempt.Builder
Returns
Type Description
Task.Builder

setHttpRequest(HttpRequest value)

public Task.Builder setHttpRequest(HttpRequest value)

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

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

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

Parameter
Name Description
builderForValue HttpRequest.Builder
Returns
Type Description
Task.Builder

setLastAttempt(Attempt value)

public Task.Builder setLastAttempt(Attempt value)

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Parameter
Name Description
value Attempt
Returns
Type Description
Task.Builder

setLastAttempt(Attempt.Builder builderForValue)

public Task.Builder setLastAttempt(Attempt.Builder builderForValue)

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

Parameter
Name Description
builderForValue Attempt.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_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
Name Description
value String

The 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_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
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Task.Builder

This builder for chaining.

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
Overrides

setResponseCount(int value)

public Task.Builder setResponseCount(int value)

Output only. The number of attempts which have received a response.

int32 response_count = 8;

Parameter
Name Description
value int

The responseCount to set.
Returns
Type Description
Task.Builder

This builder for chaining.

setScheduleTime(Timestamp value)

public Task.Builder setScheduleTime(Timestamp value)

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

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 or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

Parameter
Name Description
builderForValue 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
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.v2.Task.View view = 11;

Parameter
Name Description
value Task.View

The 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.v2.Task.View view = 11;

Parameter
Name Description
value int

The enum numeric value on the wire for view to set.
Returns
Type Description
Task.Builder

This builder for chaining.