Package com.google.cloud.tasks.v2beta2
Class Queue
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.tasks.v2beta2.Queue
-
- All Implemented Interfaces:
QueueOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class Queue extends com.google.protobuf.GeneratedMessageV3 implements QueueOrBuilder
A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.
Protobuf typegoogle.cloud.tasks.v2beta2.Queue
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Queue.Builder
A queue is a container of related tasks.static class
Queue.State
State of the queue.static class
Queue.TargetTypeCase
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
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
-
-
Field Summary
Fields Modifier and Type Field Description static int
APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
static int
HTTP_TARGET_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
PULL_TARGET_FIELD_NUMBER
static int
PURGE_TIME_FIELD_NUMBER
static int
RATE_LIMITS_FIELD_NUMBER
static int
RETRY_CONFIG_FIELD_NUMBER
static int
STATE_FIELD_NUMBER
static int
STATS_FIELD_NUMBER
static int
TASK_TTL_FIELD_NUMBER
static int
TOMBSTONE_TTL_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
AppEngineHttpTarget
getAppEngineHttpTarget()
App Engine HTTP target.AppEngineHttpTargetOrBuilder
getAppEngineHttpTargetOrBuilder()
App Engine HTTP target.static Queue
getDefaultInstance()
Queue
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
HttpTarget
getHttpTarget()
An http_target is used to override the target values for HTTP tasks.HttpTargetOrBuilder
getHttpTargetOrBuilder()
An http_target is used to override the target values for HTTP tasks.String
getName()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only.com.google.protobuf.ByteString
getNameBytes()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only.com.google.protobuf.Parser<Queue>
getParserForType()
PullTarget
getPullTarget()
Pull target.PullTargetOrBuilder
getPullTargetOrBuilder()
Pull target.com.google.protobuf.Timestamp
getPurgeTime()
Output only.com.google.protobuf.TimestampOrBuilder
getPurgeTimeOrBuilder()
Output only.RateLimits
getRateLimits()
Rate limits for task dispatches.RateLimitsOrBuilder
getRateLimitsOrBuilder()
Rate limits for task dispatches.RetryConfig
getRetryConfig()
Settings that determine the retry behavior.RetryConfigOrBuilder
getRetryConfigOrBuilder()
Settings that determine the retry behavior.int
getSerializedSize()
Queue.State
getState()
Output only.int
getStateValue()
Output only.QueueStats
getStats()
Output only.QueueStatsOrBuilder
getStatsOrBuilder()
Output only.Queue.TargetTypeCase
getTargetTypeCase()
com.google.protobuf.Duration
getTaskTtl()
The maximum amount of time that a task will be retained in this queue.com.google.protobuf.DurationOrBuilder
getTaskTtlOrBuilder()
The maximum amount of time that a task will be retained in this queue.com.google.protobuf.Duration
getTombstoneTtl()
The task tombstone time to live (TTL).com.google.protobuf.DurationOrBuilder
getTombstoneTtlOrBuilder()
The task tombstone time to live (TTL).boolean
hasAppEngineHttpTarget()
App Engine HTTP target.int
hashCode()
boolean
hasHttpTarget()
An http_target is used to override the target values for HTTP tasks.boolean
hasPullTarget()
Pull target.boolean
hasPurgeTime()
Output only.boolean
hasRateLimits()
Rate limits for task dispatches.boolean
hasRetryConfig()
Settings that determine the retry behavior.boolean
hasStats()
Output only.boolean
hasTaskTtl()
The maximum amount of time that a task will be retained in this queue.boolean
hasTombstoneTtl()
The task tombstone time to live (TTL).protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Queue.Builder
newBuilder()
static Queue.Builder
newBuilder(Queue prototype)
Queue.Builder
newBuilderForType()
protected Queue.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Queue
parseDelimitedFrom(InputStream input)
static Queue
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Queue
parseFrom(byte[] data)
static Queue
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Queue
parseFrom(com.google.protobuf.ByteString data)
static Queue
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Queue
parseFrom(com.google.protobuf.CodedInputStream input)
static Queue
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Queue
parseFrom(InputStream input)
static Queue
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Queue
parseFrom(ByteBuffer data)
static Queue
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Queue>
parser()
Queue.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, 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
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PULL_TARGET_FIELD_NUMBER
public static final int PULL_TARGET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
HTTP_TARGET_FIELD_NUMBER
public static final int HTTP_TARGET_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RATE_LIMITS_FIELD_NUMBER
public static final int RATE_LIMITS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RETRY_CONFIG_FIELD_NUMBER
public static final int RETRY_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PURGE_TIME_FIELD_NUMBER
public static final int PURGE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TASK_TTL_FIELD_NUMBER
public static final int TASK_TTL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TOMBSTONE_TTL_FIELD_NUMBER
public static final int TOMBSTONE_TTL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
STATS_FIELD_NUMBER
public static final int STATS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getTargetTypeCase
public Queue.TargetTypeCase getTargetTypeCase()
- Specified by:
getTargetTypeCase
in interfaceQueueOrBuilder
-
getName
public String getName()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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 queue'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.
string name = 1;
- Specified by:
getName
in interfaceQueueOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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 queue'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.
string name = 1;
- Specified by:
getNameBytes
in interfaceQueueOrBuilder
- Returns:
- The bytes for name.
-
hasAppEngineHttpTarget
public boolean hasAppEngineHttpTarget()
App Engine HTTP target. An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
- Specified by:
hasAppEngineHttpTarget
in interfaceQueueOrBuilder
- Returns:
- Whether the appEngineHttpTarget field is set.
-
getAppEngineHttpTarget
public AppEngineHttpTarget getAppEngineHttpTarget()
App Engine HTTP target. An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
- Specified by:
getAppEngineHttpTarget
in interfaceQueueOrBuilder
- Returns:
- The appEngineHttpTarget.
-
getAppEngineHttpTargetOrBuilder
public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()
App Engine HTTP target. An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
- Specified by:
getAppEngineHttpTargetOrBuilder
in interfaceQueueOrBuilder
-
hasPullTarget
public boolean hasPullTarget()
Pull target. A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
- Specified by:
hasPullTarget
in interfaceQueueOrBuilder
- Returns:
- Whether the pullTarget field is set.
-
getPullTarget
public PullTarget getPullTarget()
Pull target. A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
- Specified by:
getPullTarget
in interfaceQueueOrBuilder
- Returns:
- The pullTarget.
-
getPullTargetOrBuilder
public PullTargetOrBuilder getPullTargetOrBuilder()
Pull target. A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
- Specified by:
getPullTargetOrBuilder
in interfaceQueueOrBuilder
-
hasHttpTarget
public boolean hasHttpTarget()
An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
- Specified by:
hasHttpTarget
in interfaceQueueOrBuilder
- Returns:
- Whether the httpTarget field is set.
-
getHttpTarget
public HttpTarget getHttpTarget()
An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
- Specified by:
getHttpTarget
in interfaceQueueOrBuilder
- Returns:
- The httpTarget.
-
getHttpTargetOrBuilder
public HttpTargetOrBuilder getHttpTargetOrBuilder()
An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
- Specified by:
getHttpTargetOrBuilder
in interfaceQueueOrBuilder
-
hasRateLimits
public boolean hasRateLimits()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both control task attempts however they control how tasks are attempted in different ways: * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the second attempt, third attempt, etc).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
- Specified by:
hasRateLimits
in interfaceQueueOrBuilder
- Returns:
- Whether the rateLimits field is set.
-
getRateLimits
public RateLimits getRateLimits()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both control task attempts however they control how tasks are attempted in different ways: * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the second attempt, third attempt, etc).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
- Specified by:
getRateLimits
in interfaceQueueOrBuilder
- Returns:
- The rateLimits.
-
getRateLimitsOrBuilder
public RateLimitsOrBuilder getRateLimitsOrBuilder()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both control task attempts however they control how tasks are attempted in different ways: * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of dispatches from a queue (i.e. all traffic dispatched from the queue, regardless of whether the dispatch is from a first attempt or a retry). * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the second attempt, third attempt, etc).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
- Specified by:
getRateLimitsOrBuilder
in interfaceQueueOrBuilder
-
hasRetryConfig
public boolean hasRetryConfig()
Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;
- Specified by:
hasRetryConfig
in interfaceQueueOrBuilder
- Returns:
- Whether the retryConfig field is set.
-
getRetryConfig
public RetryConfig getRetryConfig()
Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;
- Specified by:
getRetryConfig
in interfaceQueueOrBuilder
- Returns:
- The retryConfig.
-
getRetryConfigOrBuilder
public RetryConfigOrBuilder getRetryConfigOrBuilder()
Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Retry settings cannot be set on individual tasks. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;
- Specified by:
getRetryConfigOrBuilder
in interfaceQueueOrBuilder
-
getStateValue
public int getStateValue()
Output only. The state of the queue. `state` can only be changed by called [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
- Specified by:
getStateValue
in interfaceQueueOrBuilder
- Returns:
- The enum numeric value on the wire for state.
-
getState
public Queue.State getState()
Output only. The state of the queue. `state` can only be changed by called [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
- Specified by:
getState
in interfaceQueueOrBuilder
- Returns:
- The state.
-
hasPurgeTime
public boolean hasPurgeTime()
Output only. The last time this queue was purged. All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.
.google.protobuf.Timestamp purge_time = 8;
- Specified by:
hasPurgeTime
in interfaceQueueOrBuilder
- Returns:
- Whether the purgeTime field is set.
-
getPurgeTime
public com.google.protobuf.Timestamp getPurgeTime()
Output only. The last time this queue was purged. All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.
.google.protobuf.Timestamp purge_time = 8;
- Specified by:
getPurgeTime
in interfaceQueueOrBuilder
- Returns:
- The purgeTime.
-
getPurgeTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder()
Output only. The last time this queue was purged. All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.
.google.protobuf.Timestamp purge_time = 8;
- Specified by:
getPurgeTimeOrBuilder
in interfaceQueueOrBuilder
-
hasTaskTtl
public boolean hasTaskTtl()
The maximum amount of time that a task will be retained in this queue. Queues created by Cloud Tasks have a default `task_ttl` of 31 days. After a task has lived for `task_ttl`, the task will be deleted regardless of whether it was dispatched or not. The `task_ttl` for queues created via queue.yaml/xml is equal to the maximum duration because there is a [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for these queues. To view the maximum valid duration, see the documentation for [Duration][google.protobuf.Duration].
.google.protobuf.Duration task_ttl = 9;
- Specified by:
hasTaskTtl
in interfaceQueueOrBuilder
- Returns:
- Whether the taskTtl field is set.
-
getTaskTtl
public com.google.protobuf.Duration getTaskTtl()
The maximum amount of time that a task will be retained in this queue. Queues created by Cloud Tasks have a default `task_ttl` of 31 days. After a task has lived for `task_ttl`, the task will be deleted regardless of whether it was dispatched or not. The `task_ttl` for queues created via queue.yaml/xml is equal to the maximum duration because there is a [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for these queues. To view the maximum valid duration, see the documentation for [Duration][google.protobuf.Duration].
.google.protobuf.Duration task_ttl = 9;
- Specified by:
getTaskTtl
in interfaceQueueOrBuilder
- Returns:
- The taskTtl.
-
getTaskTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTaskTtlOrBuilder()
The maximum amount of time that a task will be retained in this queue. Queues created by Cloud Tasks have a default `task_ttl` of 31 days. After a task has lived for `task_ttl`, the task will be deleted regardless of whether it was dispatched or not. The `task_ttl` for queues created via queue.yaml/xml is equal to the maximum duration because there is a [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for these queues. To view the maximum valid duration, see the documentation for [Duration][google.protobuf.Duration].
.google.protobuf.Duration task_ttl = 9;
- Specified by:
getTaskTtlOrBuilder
in interfaceQueueOrBuilder
-
hasTombstoneTtl
public boolean hasTombstoneTtl()
The task tombstone time to live (TTL). After a task is deleted or completed, the task's tombstone is retained for the length of time specified by `tombstone_ttl`. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
- Specified by:
hasTombstoneTtl
in interfaceQueueOrBuilder
- Returns:
- Whether the tombstoneTtl field is set.
-
getTombstoneTtl
public com.google.protobuf.Duration getTombstoneTtl()
The task tombstone time to live (TTL). After a task is deleted or completed, the task's tombstone is retained for the length of time specified by `tombstone_ttl`. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
- Specified by:
getTombstoneTtl
in interfaceQueueOrBuilder
- Returns:
- The tombstoneTtl.
-
getTombstoneTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTombstoneTtlOrBuilder()
The task tombstone time to live (TTL). After a task is deleted or completed, the task's tombstone is retained for the length of time specified by `tombstone_ttl`. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
- Specified by:
getTombstoneTtlOrBuilder
in interfaceQueueOrBuilder
-
hasStats
public boolean hasStats()
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasStats
in interfaceQueueOrBuilder
- Returns:
- Whether the stats field is set.
-
getStats
public QueueStats getStats()
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStats
in interfaceQueueOrBuilder
- Returns:
- The stats.
-
getStatsOrBuilder
public QueueStatsOrBuilder getStatsOrBuilder()
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStatsOrBuilder
in interfaceQueueOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Queue parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Queue parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Queue parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Queue parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Queue parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Queue parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Queue parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Queue.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Queue.Builder newBuilder()
-
newBuilder
public static Queue.Builder newBuilder(Queue prototype)
-
toBuilder
public Queue.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Queue.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Queue getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Queue> parser()
-
getParserForType
public com.google.protobuf.Parser<Queue> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Queue getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-