com.google.cloud.tasks.v2beta2

Class Task

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.tasks.v2beta2.Task

All Implemented Interfaces:

TaskOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Task
extends GeneratedMessageV3
implements TaskOrBuilder

 A unit of scheduled work.
 

Protobuf type google.cloud.tasks.v2beta2.Task

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Builder A unit of scheduled work.
static class	Task.PayloadTypeCase
static class	Task.View The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PULL_MESSAGE_FIELD_NUMBER
static int	SCHEDULE_TIME_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	VIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static Task	getDefaultInstance()
Task	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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].
Parser<Task>	getParserForType()
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.
int	getSerializedSize()
TaskStatus	getStatus() Output only.
TaskStatusOrBuilder	getStatusOrBuilder() Output only.
UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
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.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Task.Builder	newBuilder()
static Task.Builder	newBuilder(Task prototype)
Task.Builder	newBuilderForType()
protected Task.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Task	parseDelimitedFrom(InputStream input)
static Task	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Task	parseFrom(byte[] data)
static Task	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Task	parseFrom(ByteBuffer data)
static Task	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Task	parseFrom(ByteString data)
static Task	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Task	parseFrom(CodedInputStream input)
static Task	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Task	parseFrom(InputStream input)
static Task	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Task>	parser()
Task.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

See Also:

Constant Field Values

PULL_MESSAGE_FIELD_NUMBER

public static final int PULL_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getPayloadTypeCase

public Task.PayloadTypeCase getPayloadTypeCase()

Specified by:

getPayloadTypeCase in interface TaskOrBuilder

getName

public 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;

Specified by:

getName in interface TaskOrBuilder

Returns:

The name.

getNameBytes

public 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;

Specified by:

getNameBytes in interface TaskOrBuilder

Returns:

The bytes for name.

hasAppEngineHttpRequest

public 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;

Specified by:

hasAppEngineHttpRequest in interface TaskOrBuilder

Returns:

Whether the appEngineHttpRequest field is set.

getAppEngineHttpRequest

public 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;

Specified by:

getAppEngineHttpRequest in interface TaskOrBuilder

Returns:

The appEngineHttpRequest.

getAppEngineHttpRequestOrBuilder

public 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;

Specified by:

getAppEngineHttpRequestOrBuilder in interface TaskOrBuilder

hasPullMessage

public 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;

Specified by:

hasPullMessage in interface TaskOrBuilder

Returns:

Whether the pullMessage field is set.

getPullMessage

public 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;

Specified by:

getPullMessage in interface TaskOrBuilder

Returns:

The pullMessage.

getPullMessageOrBuilder

public 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;

Specified by:

getPullMessageOrBuilder in interface TaskOrBuilder

hasScheduleTime

public 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;

Specified by:

hasScheduleTime in interface TaskOrBuilder

Returns:

Whether the scheduleTime field is set.

getScheduleTime

public 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;

Specified by:

getScheduleTime in interface TaskOrBuilder

Returns:

The scheduleTime.

getScheduleTimeOrBuilder

public 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;

Specified by:

getScheduleTimeOrBuilder in interface TaskOrBuilder

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

Specified by:

hasCreateTime in interface TaskOrBuilder

Returns:

Whether the createTime field is set.

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

Specified by:

getCreateTime in interface TaskOrBuilder

Returns:

The createTime.

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

Specified by:

getCreateTimeOrBuilder in interface TaskOrBuilder

hasStatus

public boolean hasStatus()

 Output only. The task status.
 

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

Specified by:

hasStatus in interface TaskOrBuilder

Returns:

Whether the status field is set.

getStatus

public TaskStatus getStatus()

 Output only. The task status.
 

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

Specified by:

getStatus in interface TaskOrBuilder

Returns:

The status.

getStatusOrBuilder

public TaskStatusOrBuilder getStatusOrBuilder()

 Output only. The task status.
 

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

Specified by:

getStatusOrBuilder in interface TaskOrBuilder

getViewValue

public 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;

Specified by:

getViewValue in interface TaskOrBuilder

Returns:

The enum numeric value on the wire for view.

getView

public 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;

Specified by:

getView in interface TaskOrBuilder

Returns:

The view.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Task parseFrom(ByteBuffer data)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(ByteBuffer data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(ByteString data)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(ByteString data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(byte[] data)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(byte[] data,
                             ExtensionRegistryLite extensionRegistry)
                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Task parseFrom(InputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Task parseFrom(InputStream input,
                             ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Task parseDelimitedFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Task parseDelimitedFrom(InputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseFrom

public static Task parseFrom(CodedInputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Task parseFrom(CodedInputStream input,
                             ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

newBuilderForType

public Task.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Task.Builder newBuilder()

newBuilder

public static Task.Builder newBuilder(Task prototype)

toBuilder

public Task.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Task getDefaultInstance()

parser

public static Parser<Task> parser()

getParserForType

public Parser<Task> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Task getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder