Class Task.Builder (2.80.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 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
publicstaticfinalclass Task.BuilderextendsGeneratedMessageV3.Builder<Task.Builder>implementsTaskOrBuilderA unit of scheduled work.
Protobuf type google.cloud.tasks.v2.Task
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Task.BuilderImplements
TaskOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicTask.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
build()
publicTaskbuild()| Returns | |
|---|---|
| Type | Description |
Task |
|
buildPartial()
publicTaskbuildPartial()| Returns | |
|---|---|
| Type | Description |
Task |
|
clear()
publicTask.Builderclear()| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearAppEngineHttpRequest()
publicTask.BuilderclearAppEngineHttpRequest()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()
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 = 5;
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearDispatchCount()
publicTask.BuilderclearDispatchCount()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()
publicTask.BuilderclearDispatchDeadline() 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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)
publicTask.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearFirstAttempt()
publicTask.BuilderclearFirstAttempt()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()
publicTask.BuilderclearHttpRequest()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()
publicTask.BuilderclearLastAttempt()Output only. The status of the task's last attempt.
.google.cloud.tasks.v2.Attempt last_attempt = 10;
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearMessageType()
publicTask.BuilderclearMessageType()| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearName()
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_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)
publicTask.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
clearResponseCount()
publicTask.BuilderclearResponseCount()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()
publicTask.BuilderclearScheduleTime()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()
publicTask.BuilderclearView()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()
publicTask.Builderclone()| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
getAppEngineHttpRequest()
publicAppEngineHttpRequestgetAppEngineHttpRequest()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()
publicAppEngineHttpRequest.BuildergetAppEngineHttpRequestBuilder()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()
publicAppEngineHttpRequestOrBuildergetAppEngineHttpRequestOrBuilder()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()
publicTimestampgetCreateTime()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()
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 = 5;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()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()
publicTaskgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Task |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDispatchCount()
publicintgetDispatchCount()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()
publicDurationgetDispatchDeadline() 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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()
publicDuration.BuildergetDispatchDeadlineBuilder() 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill be truncated to the nearest millisecond. The deadline is an approximate deadline.
.google.protobuf.Duration dispatch_deadline = 6;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getDispatchDeadlineOrBuilder()
publicDurationOrBuildergetDispatchDeadlineOrBuilder() 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill be truncated to the nearest millisecond. The deadline is an approximate deadline.
.google.protobuf.Duration dispatch_deadline = 6;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getFirstAttempt()
publicAttemptgetFirstAttempt()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()
publicAttempt.BuildergetFirstAttemptBuilder()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()
publicAttemptOrBuildergetFirstAttemptOrBuilder()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()
publicHttpRequestgetHttpRequest()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()
publicHttpRequest.BuildergetHttpRequestBuilder()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()
publicHttpRequestOrBuildergetHttpRequestOrBuilder()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()
publicAttemptgetLastAttempt()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()
publicAttempt.BuildergetLastAttemptBuilder()Output only. The status of the task's last attempt.
.google.cloud.tasks.v2.Attempt last_attempt = 10;
| Returns | |
|---|---|
| Type | Description |
Attempt.Builder |
|
getLastAttemptOrBuilder()
publicAttemptOrBuildergetLastAttemptOrBuilder()Output only. The status of the task's last attempt.
.google.cloud.tasks.v2.Attempt last_attempt = 10;
| Returns | |
|---|---|
| Type | Description |
AttemptOrBuilder |
|
getMessageTypeCase()
publicTask.MessageTypeCasegetMessageTypeCase()| Returns | |
|---|---|
| Type | Description |
Task.MessageTypeCase |
|
getName()
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_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()
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_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. |
getResponseCount()
publicintgetResponseCount()Output only. The number of attempts which have received a response.
int32 response_count = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The responseCount. |
getScheduleTime()
publicTimestampgetScheduleTime()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()
publicTimestamp.BuildergetScheduleTimeBuilder()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()
publicTimestampOrBuildergetScheduleTimeOrBuilder()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()
publicTask.ViewgetView()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()
publicintgetViewValue()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()
publicbooleanhasAppEngineHttpRequest()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()
publicbooleanhasCreateTime()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()
publicbooleanhasDispatchDeadline() 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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()
publicbooleanhasFirstAttempt()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()
publicbooleanhasHttpRequest()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()
publicbooleanhasLastAttempt()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()
publicbooleanhasScheduleTime()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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAppEngineHttpRequest(AppEngineHttpRequest value)
publicTask.BuildermergeAppEngineHttpRequest(AppEngineHttpRequestvalue)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)
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 = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
mergeDispatchDeadline(Duration value)
publicTask.BuildermergeDispatchDeadline(Durationvalue) 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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)
publicTask.BuildermergeFirstAttempt(Attemptvalue)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)
publicTask.BuildermergeFrom(Taskother)| Parameter | |
|---|---|
| Name | Description |
other |
Task |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicTask.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicTask.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
mergeHttpRequest(HttpRequest value)
publicTask.BuildermergeHttpRequest(HttpRequestvalue)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)
publicTask.BuildermergeLastAttempt(Attemptvalue)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)
publicTask.BuildermergeScheduleTime(Timestampvalue)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)
publicfinalTask.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setAppEngineHttpRequest(AppEngineHttpRequest value)
publicTask.BuildersetAppEngineHttpRequest(AppEngineHttpRequestvalue)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)
publicTask.BuildersetAppEngineHttpRequest(AppEngineHttpRequest.BuilderbuilderForValue)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)
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 = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
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 = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setDispatchCount(int value)
publicTask.BuildersetDispatchCount(intvalue)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)
publicTask.BuildersetDispatchDeadline(Durationvalue) 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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)
publicTask.BuildersetDispatchDeadline(Duration.BuilderbuilderForValue) 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 thedispatch_deadlineto at most a few seconds more than the app handler's timeout. For more information see Timeouts.dispatch_deadlinewill 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)
publicTask.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setFirstAttempt(Attempt value)
publicTask.BuildersetFirstAttempt(Attemptvalue)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)
publicTask.BuildersetFirstAttempt(Attempt.BuilderbuilderForValue)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)
publicTask.BuildersetHttpRequest(HttpRequestvalue)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)
publicTask.BuildersetHttpRequest(HttpRequest.BuilderbuilderForValue)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)
publicTask.BuildersetLastAttempt(Attemptvalue)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)
publicTask.BuildersetLastAttempt(Attempt.BuilderbuilderForValue)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)
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_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 |
String The name to set. |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
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_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 |
ByteString The bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicTask.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setResponseCount(int value)
publicTask.BuildersetResponseCount(intvalue)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)
publicTask.BuildersetScheduleTime(Timestampvalue)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)
publicTask.BuildersetScheduleTime(Timestamp.BuilderbuilderForValue)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)
publicfinalTask.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.Builder |
|
setView(Task.View value)
publicTask.BuildersetView(Task.Viewvalue)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)
publicTask.BuildersetViewValue(intvalue)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. |