Package com.google.cloud.tasks.v2beta2
Class Task
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.tasks.v2beta2.Task
- All Implemented Interfaces:
TaskOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Task
extends com.google.protobuf.GeneratedMessage
implements TaskOrBuilder
A unit of scheduled work.Protobuf type
google.cloud.tasks.v2beta2.Task- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA unit of scheduled work.static enumstatic enumThe view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanApp Engine HTTP request that is sent to the task's target.App Engine HTTP request that is sent to the task's target.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static Taskstatic final com.google.protobuf.Descriptors.DescriptorHTTP request that is sent to the task's target.HTTP request that is sent to the task's target.getName()Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].com.google.protobuf.ByteStringOptionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].com.google.protobuf.Parser<Task>[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.com.google.protobuf.TimestampThe time when the task is scheduled to be attempted.com.google.protobuf.TimestampOrBuilderThe time when the task is scheduled to be attempted.intOutput only.Output only.getView()Output only.intOutput only.booleanApp Engine HTTP request that is sent to the task's target.booleanOutput only.inthashCode()booleanHTTP request that is sent to the task's target.boolean[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.booleanThe time when the task is scheduled to be attempted.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Task.Builderstatic Task.BuildernewBuilder(Task prototype) protected Task.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static TaskparseDelimitedFrom(InputStream input) static TaskparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TaskparseFrom(byte[] data) static TaskparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TaskparseFrom(com.google.protobuf.ByteString data) static TaskparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TaskparseFrom(com.google.protobuf.CodedInputStream input) static TaskparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TaskparseFrom(InputStream input) static TaskparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TaskparseFrom(ByteBuffer data) static TaskparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Task>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER- See Also:
-
PULL_MESSAGE_FIELD_NUMBER
public static final int PULL_MESSAGE_FIELD_NUMBER- See Also:
-
HTTP_REQUEST_FIELD_NUMBER
public static final int HTTP_REQUEST_FIELD_NUMBER- See Also:
-
SCHEDULE_TIME_FIELD_NUMBER
public static final int SCHEDULE_TIME_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER- See Also:
-
VIEW_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getPayloadTypeCase
- Specified by:
getPayloadTypeCasein interfaceTaskOrBuilder
-
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:
getNamein interfaceTaskOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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:
getNameBytesin interfaceTaskOrBuilder- 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:
hasAppEngineHttpRequestin interfaceTaskOrBuilder- Returns:
- Whether the appEngineHttpRequest field is set.
-
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:
getAppEngineHttpRequestin interfaceTaskOrBuilder- Returns:
- The appEngineHttpRequest.
-
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:
getAppEngineHttpRequestOrBuilderin interfaceTaskOrBuilder
-
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:
hasPullMessagein interfaceTaskOrBuilder- Returns:
- Whether the pullMessage field is set.
-
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:
getPullMessagein interfaceTaskOrBuilder- Returns:
- The pullMessage.
-
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:
getPullMessageOrBuilderin interfaceTaskOrBuilder
-
hasHttpRequest
public boolean hasHttpRequest()HTTP request that is sent to the task's target. An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;- Specified by:
hasHttpRequestin interfaceTaskOrBuilder- Returns:
- Whether the httpRequest field is set.
-
getHttpRequest
HTTP request that is sent to the task's target. An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;- Specified by:
getHttpRequestin interfaceTaskOrBuilder- Returns:
- The httpRequest.
-
getHttpRequestOrBuilder
HTTP request that is sent to the task's target. An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
.google.cloud.tasks.v2beta2.HttpRequest http_request = 13;- Specified by:
getHttpRequestOrBuilderin interfaceTaskOrBuilder
-
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:
hasScheduleTimein interfaceTaskOrBuilder- Returns:
- Whether the scheduleTime field is set.
-
getScheduleTime
public com.google.protobuf.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:
getScheduleTimein interfaceTaskOrBuilder- Returns:
- The scheduleTime.
-
getScheduleTimeOrBuilder
public com.google.protobuf.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:
getScheduleTimeOrBuilderin interfaceTaskOrBuilder
-
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:
hasCreateTimein interfaceTaskOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.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:
getCreateTimein interfaceTaskOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.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:
getCreateTimeOrBuilderin interfaceTaskOrBuilder
-
hasStatus
public boolean hasStatus()Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;- Specified by:
hasStatusin interfaceTaskOrBuilder- Returns:
- Whether the status field is set.
-
getStatus
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;- Specified by:
getStatusin interfaceTaskOrBuilder- Returns:
- The status.
-
getStatusOrBuilder
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;- Specified by:
getStatusOrBuilderin interfaceTaskOrBuilder
-
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:
getViewValuein interfaceTaskOrBuilder- Returns:
- The enum numeric value on the wire for 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:
getViewin interfaceTaskOrBuilder- Returns:
- The view.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Task parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Task parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Task parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Task parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Task parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Task parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Task parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Task parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
- Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-