com.google.cloud.tasks.v2beta2

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() App Engine HTTP request that is sent to the task's target.
AppEngineHttpRequestOrBuilder	getAppEngineHttpRequestOrBuilder() App Engine HTTP request that is sent to the task's target.
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getName() Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
ByteString	getNameBytes() Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
Task.PayloadTypeCase	getPayloadTypeCase()
PullMessage	getPullMessage() [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
PullMessageOrBuilder	getPullMessageOrBuilder() [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
Timestamp	getScheduleTime() The time when the task is scheduled to be attempted.
TimestampOrBuilder	getScheduleTimeOrBuilder() The time when the task is scheduled to be attempted.
TaskStatus	getStatus() Output only.
TaskStatusOrBuilder	getStatusOrBuilder() Output only.
Task.View	getView() Output only.
int	getViewValue() Output only.
boolean	hasAppEngineHttpRequest() App Engine HTTP request that is sent to the task's target.
boolean	hasCreateTime() Output only.
boolean	hasPullMessage() [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
boolean	hasScheduleTime() The time when the task is scheduled to be attempted.
boolean	hasStatus() Output only.

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.v2beta2.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.v2beta2.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()

 App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set
 on the queue.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.
 

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

Returns:

Whether the appEngineHttpRequest field is set.

getAppEngineHttpRequest

AppEngineHttpRequest getAppEngineHttpRequest()

 App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set
 on the queue.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.
 

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

Returns:

The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder

AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()

 App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set
 on the queue.
 An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set.
 

.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

hasPullMessage

boolean hasPullMessage()

 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be
 set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
 A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
 

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns:

Whether the pullMessage field is set.

getPullMessage

PullMessage getPullMessage()

 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be
 set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
 A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
 

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

Returns:

The pullMessage.

getPullMessageOrBuilder

PullMessageOrBuilder getPullMessageOrBuilder()

 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be
 set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
 A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
 

.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

hasScheduleTime

boolean hasScheduleTime()

 The time when the task is scheduled to be attempted.
 For App Engine queues, this is when the task will be attempted or retried.
 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
 `schedule_time` will be truncated to the nearest microsecond.
 

.google.protobuf.Timestamp schedule_time = 5;

Returns:

Whether the scheduleTime field is set.

getScheduleTime

Timestamp getScheduleTime()

 The time when the task is scheduled to be attempted.
 For App Engine queues, this is when the task will be attempted or retried.
 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
 `schedule_time` will be truncated to the nearest microsecond.
 

.google.protobuf.Timestamp schedule_time = 5;

Returns:

The scheduleTime.

getScheduleTimeOrBuilder

TimestampOrBuilder getScheduleTimeOrBuilder()

 The time when the task is scheduled to be attempted.
 For App Engine queues, this is when the task will be attempted or retried.
 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
 `schedule_time` will be truncated to the nearest microsecond.
 

.google.protobuf.Timestamp schedule_time = 5;

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

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

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

hasStatus

boolean hasStatus()

 Output only. The task status.
 

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

Returns:

Whether the status field is set.

getStatus

TaskStatus getStatus()

 Output only. The task status.
 

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

Returns:

The status.

getStatusOrBuilder

TaskStatusOrBuilder getStatusOrBuilder()

 Output only. The task status.
 

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

getViewValue

int getViewValue()

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

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

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.v2beta2.Task] has
 been returned.
 

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

Returns:

The view.

getPayloadTypeCase

Task.PayloadTypeCase getPayloadTypeCase()