com.google.cloud.tasks.v2

Interface TaskOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Task, Task.Builder

public interface TaskOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AppEngineHttpRequest	getAppEngineHttpRequest() HTTP request that is sent to the App Engine app handler.
AppEngineHttpRequestOrBuilder	getAppEngineHttpRequestOrBuilder() HTTP request that is sent to the App Engine app handler.
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
int	getDispatchCount() Output only.
Duration	getDispatchDeadline() The deadline for requests sent to the worker.
DurationOrBuilder	getDispatchDeadlineOrBuilder() The deadline for requests sent to the worker.
Attempt	getFirstAttempt() Output only.
AttemptOrBuilder	getFirstAttemptOrBuilder() Output only.
HttpRequest	getHttpRequest() HTTP request that is sent to the worker.
HttpRequestOrBuilder	getHttpRequestOrBuilder() HTTP request that is sent to the worker.
Attempt	getLastAttempt() Output only.
AttemptOrBuilder	getLastAttemptOrBuilder() Output only.
Task.MessageTypeCase	getMessageTypeCase()
String	getName() Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
ByteString	getNameBytes() Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
int	getResponseCount() Output only.
Timestamp	getScheduleTime() The time when the task is scheduled to be attempted or retried.
TimestampOrBuilder	getScheduleTimeOrBuilder() The time when the task is scheduled to be attempted or retried.
Task.View	getView() Output only.
int	getViewValue() Output only.
boolean	hasAppEngineHttpRequest() HTTP request that is sent to the App Engine app handler.
boolean	hasCreateTime() Output only.
boolean	hasDispatchDeadline() The deadline for requests sent to the worker.
boolean	hasFirstAttempt() Output only.
boolean	hasHttpRequest() HTTP request that is sent to the worker.
boolean	hasLastAttempt() Output only.
boolean	hasScheduleTime() The time when the task is scheduled to be attempted or retried.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the task's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.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:

The name.

getNameBytes

ByteString getNameBytes()

 Optionally caller-specified in [CreateTask][google.cloud.tasks.v2.CloudTasks.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](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the task's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.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:

The bytes for name.

hasAppEngineHttpRequest

boolean hasAppEngineHttpRequest()

 HTTP request that is sent to the App Engine app handler.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
 

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

Returns:

Whether the appEngineHttpRequest field is set.

getAppEngineHttpRequest

AppEngineHttpRequest getAppEngineHttpRequest()

 HTTP request that is sent to the App Engine app handler.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
 

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

Returns:

The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder

AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()

 HTTP request that is sent to the App Engine app handler.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
 

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

hasHttpRequest

boolean hasHttpRequest()

 HTTP request that is sent to the worker.
 An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
 

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

Returns:

Whether the httpRequest field is set.

getHttpRequest

HttpRequest getHttpRequest()

 HTTP request that is sent to the worker.
 An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
 

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

Returns:

The httpRequest.

getHttpRequestOrBuilder

HttpRequestOrBuilder getHttpRequestOrBuilder()

 HTTP request that is sent to the worker.
 An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
 

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

hasScheduleTime

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:

Whether the scheduleTime field is set.

getScheduleTime

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:

The scheduleTime.

getScheduleTimeOrBuilder

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;

hasCreateTime

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:

Whether the createTime field is set.

getCreateTime

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:

The createTime.

getCreateTimeOrBuilder

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;

hasDispatchDeadline

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][google.cloud.tasks.v2.RetryConfig].
 Note that when the request is cancelled, Cloud Tasks will stop listing 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][google.cloud.tasks.v2.HttpRequest], the default is 10 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].
 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
 

.google.protobuf.Duration dispatch_deadline = 6;

Returns:

Whether the dispatchDeadline field is set.

getDispatchDeadline

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][google.cloud.tasks.v2.RetryConfig].
 Note that when the request is cancelled, Cloud Tasks will stop listing 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][google.cloud.tasks.v2.HttpRequest], the default is 10 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].
 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
 

.google.protobuf.Duration dispatch_deadline = 6;

Returns:

The dispatchDeadline.

getDispatchDeadlineOrBuilder

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][google.cloud.tasks.v2.RetryConfig].
 Note that when the request is cancelled, Cloud Tasks will stop listing 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][google.cloud.tasks.v2.HttpRequest], the default is 10 minutes. The deadline
   must be in the interval [15 seconds, 30 minutes].
 * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0 indicates that the
   request has the default deadline. The default deadline depends on the
   [scaling
   type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)
   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](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
 `dispatch_deadline` will be truncated to the nearest millisecond. The
 deadline is an approximate deadline.
 

.google.protobuf.Duration dispatch_deadline = 6;

getDispatchCount

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:

The dispatchCount.

getResponseCount

int getResponseCount()

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

int32 response_count = 8;

Returns:

The responseCount.

hasFirstAttempt

boolean hasFirstAttempt()

 Output only. The status of the task's first attempt.
 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set.
 The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.
 

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

Returns:

Whether the firstAttempt field is set.

getFirstAttempt

Attempt getFirstAttempt()

 Output only. The status of the task's first attempt.
 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set.
 The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.
 

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

Returns:

The firstAttempt.

getFirstAttemptOrBuilder

AttemptOrBuilder getFirstAttemptOrBuilder()

 Output only. The status of the task's first attempt.
 Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be set.
 The other [Attempt][google.cloud.tasks.v2.Attempt] information is not retained by Cloud Tasks.
 

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

hasLastAttempt

boolean hasLastAttempt()

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

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

Returns:

Whether the lastAttempt field is set.

getLastAttempt

Attempt getLastAttempt()

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

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

Returns:

The lastAttempt.

getLastAttemptOrBuilder

AttemptOrBuilder getLastAttemptOrBuilder()

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

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

getViewValue

int getViewValue()

 Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has
 been returned.
 

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

Returns:

The enum numeric value on the wire for view.

getView

Task.View getView()

 Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2.Task] has
 been returned.
 

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

Returns:

The view.

getMessageTypeCase

Task.MessageTypeCase getMessageTypeCase()