public final class Task extends com.google.protobuf.GeneratedMessageV3 implements TaskOrBuilder
A unit of scheduled work.Protobuf type
google.cloud.tasks.v2beta2.Task| 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.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
HTTP_REQUEST_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 |
| 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.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Task |
getDefaultInstance() |
Task |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
HttpRequest |
getHttpRequest()
HTTP request that is sent to the task's target.
|
HttpRequestOrBuilder |
getHttpRequestOrBuilder()
HTTP request that is sent to the task's target.
|
String |
getName()
Optionally caller-specified in
[CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
|
com.google.protobuf.ByteString |
getNameBytes()
Optionally caller-specified in
[CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
|
com.google.protobuf.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.
|
com.google.protobuf.Timestamp |
getScheduleTime()
The time when the task is scheduled to be attempted.
|
com.google.protobuf.TimestampOrBuilder |
getScheduleTimeOrBuilder()
The time when the task is scheduled to be attempted.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
boolean |
hasHttpRequest()
HTTP request that is sent to the task's target.
|
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 com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Task.Builder |
newBuilder() |
static Task.Builder |
newBuilder(Task prototype) |
Task.Builder |
newBuilderForType() |
protected Task.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Task |
parseDelimitedFrom(InputStream input) |
static Task |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Task |
parseFrom(byte[] data) |
static Task |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Task |
parseFrom(ByteBuffer data) |
static Task |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Task |
parseFrom(com.google.protobuf.ByteString data) |
static Task |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Task |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Task |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Task |
parseFrom(InputStream input) |
static Task |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Task> |
parser() |
Task.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_REQUEST_FIELD_NUMBER
public static final int PULL_MESSAGE_FIELD_NUMBER
public static final int HTTP_REQUEST_FIELD_NUMBER
public static final int SCHEDULE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
public static final int VIEW_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Task.PayloadTypeCase getPayloadTypeCase()
getPayloadTypeCase in interface TaskOrBuilderpublic 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;getName in interface TaskOrBuilderpublic 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;getNameBytes in interface TaskOrBuilderpublic 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;hasAppEngineHttpRequest in interface TaskOrBuilderpublic 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;getAppEngineHttpRequest in interface TaskOrBuilderpublic 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;getAppEngineHttpRequestOrBuilder in interface TaskOrBuilderpublic 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;hasPullMessage in interface TaskOrBuilderpublic 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;getPullMessage in interface TaskOrBuilderpublic 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;getPullMessageOrBuilder in interface TaskOrBuilderpublic 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;hasHttpRequest in interface TaskOrBuilderpublic HttpRequest 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;getHttpRequest in interface TaskOrBuilderpublic HttpRequestOrBuilder 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;getHttpRequestOrBuilder in interface TaskOrBuilderpublic 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;hasScheduleTime in interface TaskOrBuilderpublic 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;getScheduleTime in interface TaskOrBuilderpublic 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;getScheduleTimeOrBuilder in interface TaskOrBuilderpublic 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;hasCreateTime in interface TaskOrBuilderpublic 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;getCreateTime in interface TaskOrBuilderpublic 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;getCreateTimeOrBuilder in interface TaskOrBuilderpublic boolean hasStatus()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;hasStatus in interface TaskOrBuilderpublic TaskStatus getStatus()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;getStatus in interface TaskOrBuilderpublic TaskStatusOrBuilder getStatusOrBuilder()
Output only. The task status.
.google.cloud.tasks.v2beta2.TaskStatus status = 7;getStatusOrBuilder in interface TaskOrBuilderpublic 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;getViewValue in interface TaskOrBuilderpublic 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;getView in interface TaskOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Task parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Task parseFrom(InputStream input) throws IOException
IOExceptionpublic static Task parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Task parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Task parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Task parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Task parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Task.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Task.Builder newBuilder()
public static Task.Builder newBuilder(Task prototype)
public Task.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Task.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Task getDefaultInstance()
public static com.google.protobuf.Parser<Task> parser()
public com.google.protobuf.Parser<Task> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Task getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.