Package com.google.cloud.tasks.v2beta3
Class Queue
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.tasks.v2beta3.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, queue types, and others.
Protobuf typegoogle.cloud.tasks.v2beta3.Queue- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classQueue.BuilderA queue is a container of related tasks.static classQueue.QueueTypeCasestatic classQueue.StateState of the queue.static classQueue.TypeThe type of the queue.-
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 intAPP_ENGINE_HTTP_QUEUE_FIELD_NUMBERstatic intHTTP_TARGET_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intPURGE_TIME_FIELD_NUMBERstatic intRATE_LIMITS_FIELD_NUMBERstatic intRETRY_CONFIG_FIELD_NUMBERstatic intSTACKDRIVER_LOGGING_CONFIG_FIELD_NUMBERstatic intSTATE_FIELD_NUMBERstatic intSTATS_FIELD_NUMBERstatic intTASK_TTL_FIELD_NUMBERstatic intTOMBSTONE_TTL_FIELD_NUMBERstatic intTYPE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)AppEngineHttpQueuegetAppEngineHttpQueue()[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.AppEngineHttpQueueOrBuildergetAppEngineHttpQueueOrBuilder()[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.static QueuegetDefaultInstance()QueuegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()HttpTargetgetHttpTarget()Modifies HTTP target for HTTP tasks.HttpTargetOrBuildergetHttpTargetOrBuilder()Modifies HTTP target for HTTP tasks.StringgetName()Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], after which it becomes output only.com.google.protobuf.ByteStringgetNameBytes()Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], after which it becomes output only.com.google.protobuf.Parser<Queue>getParserForType()com.google.protobuf.TimestampgetPurgeTime()Output only.com.google.protobuf.TimestampOrBuildergetPurgeTimeOrBuilder()Output only.Queue.QueueTypeCasegetQueueTypeCase()RateLimitsgetRateLimits()Rate limits for task dispatches.RateLimitsOrBuildergetRateLimitsOrBuilder()Rate limits for task dispatches.RetryConfiggetRetryConfig()Settings that determine the retry behavior.RetryConfigOrBuildergetRetryConfigOrBuilder()Settings that determine the retry behavior.intgetSerializedSize()StackdriverLoggingConfiggetStackdriverLoggingConfig()Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).StackdriverLoggingConfigOrBuildergetStackdriverLoggingConfigOrBuilder()Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).Queue.StategetState()Output only.intgetStateValue()Output only.QueueStatsgetStats()Output only.QueueStatsOrBuildergetStatsOrBuilder()Output only.com.google.protobuf.DurationgetTaskTtl()The maximum amount of time that a task will be retained in this queue.com.google.protobuf.DurationOrBuildergetTaskTtlOrBuilder()The maximum amount of time that a task will be retained in this queue.com.google.protobuf.DurationgetTombstoneTtl()The task tombstone time to live (TTL).com.google.protobuf.DurationOrBuildergetTombstoneTtlOrBuilder()The task tombstone time to live (TTL).Queue.TypegetType()Immutable.intgetTypeValue()Immutable.booleanhasAppEngineHttpQueue()[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.inthashCode()booleanhasHttpTarget()Modifies HTTP target for HTTP tasks.booleanhasPurgeTime()Output only.booleanhasRateLimits()Rate limits for task dispatches.booleanhasRetryConfig()Settings that determine the retry behavior.booleanhasStackdriverLoggingConfig()Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).booleanhasStats()Output only.booleanhasTaskTtl()The maximum amount of time that a task will be retained in this queue.booleanhasTombstoneTtl()The task tombstone time to live (TTL).protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static Queue.BuildernewBuilder()static Queue.BuildernewBuilder(Queue prototype)Queue.BuildernewBuilderForType()protected Queue.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static QueueparseDelimitedFrom(InputStream input)static QueueparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static QueueparseFrom(byte[] data)static QueueparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static QueueparseFrom(com.google.protobuf.ByteString data)static QueueparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static QueueparseFrom(com.google.protobuf.CodedInputStream input)static QueueparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static QueueparseFrom(InputStream input)static QueueparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static QueueparseFrom(ByteBuffer data)static QueueparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Queue>parser()Queue.BuildertoBuilder()voidwriteTo(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_QUEUE_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_QUEUE_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
-
STACKDRIVER_LOGGING_CONFIG_FIELD_NUMBER
public static final int STACKDRIVER_LOGGING_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPE_FIELD_NUMBER
public static final int TYPE_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:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getQueueTypeCase
public Queue.QueueTypeCase getQueueTypeCase()
- Specified by:
getQueueTypeCasein interfaceQueueOrBuilder
-
getName
public String getName()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.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:
getNamein interfaceQueueOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.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:
getNameBytesin interfaceQueueOrBuilder- Returns:
- The bytes for name.
-
hasAppEngineHttpQueue
public boolean hasAppEngineHttpQueue()
[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;- Specified by:
hasAppEngineHttpQueuein interfaceQueueOrBuilder- Returns:
- Whether the appEngineHttpQueue field is set.
-
getAppEngineHttpQueue
public AppEngineHttpQueue getAppEngineHttpQueue()
[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;- Specified by:
getAppEngineHttpQueuein interfaceQueueOrBuilder- Returns:
- The appEngineHttpQueue.
-
getAppEngineHttpQueueOrBuilder
public AppEngineHttpQueueOrBuilder getAppEngineHttpQueueOrBuilder()
[AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;- Specified by:
getAppEngineHttpQueueOrBuilderin interfaceQueueOrBuilder
-
hasHttpTarget
public boolean hasHttpTarget()
Modifies HTTP target for HTTP tasks.
.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;- Specified by:
hasHttpTargetin interfaceQueueOrBuilder- Returns:
- Whether the httpTarget field is set.
-
getHttpTarget
public HttpTarget getHttpTarget()
Modifies HTTP target for HTTP tasks.
.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;- Specified by:
getHttpTargetin interfaceQueueOrBuilder- Returns:
- The httpTarget.
-
getHttpTargetOrBuilder
public HttpTargetOrBuilder getHttpTargetOrBuilder()
Modifies HTTP target for HTTP tasks.
.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;- Specified by:
getHttpTargetOrBuilderin interfaceQueueOrBuilder
-
hasRateLimits
public boolean hasRateLimits()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related because they both control task attempts. However they control task attempts in different ways: * [rate_limits][google.cloud.tasks.v2beta3.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.v2beta3.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits], [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;- Specified by:
hasRateLimitsin interfaceQueueOrBuilder- Returns:
- Whether the rateLimits field is set.
-
getRateLimits
public RateLimits getRateLimits()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related because they both control task attempts. However they control task attempts in different ways: * [rate_limits][google.cloud.tasks.v2beta3.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.v2beta3.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits], [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;- Specified by:
getRateLimitsin interfaceQueueOrBuilder- Returns:
- The rateLimits.
-
getRateLimitsOrBuilder
public RateLimitsOrBuilder getRateLimitsOrBuilder()
Rate limits for task dispatches. [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related because they both control task attempts. However they control task attempts in different ways: * [rate_limits][google.cloud.tasks.v2beta3.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.v2beta3.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the second attempt, third attempt, etc). The queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits], [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. * System throttling due to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;- Specified by:
getRateLimitsOrBuilderin 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.v2beta3.RetryConfig retry_config = 5;- Specified by:
hasRetryConfigin 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.v2beta3.RetryConfig retry_config = 5;- Specified by:
getRetryConfigin 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.v2beta3.RetryConfig retry_config = 5;- Specified by:
getRetryConfigOrBuilderin interfaceQueueOrBuilder
-
getStateValue
public int getStateValue()
Output only. The state of the queue. `state` can only be changed by called [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change `state`.
.google.cloud.tasks.v2beta3.Queue.State state = 6;- Specified by:
getStateValuein 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.v2beta3.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change `state`.
.google.cloud.tasks.v2beta3.Queue.State state = 6;- Specified by:
getStatein 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.v2beta3.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.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 = 7;- Specified by:
hasPurgeTimein 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.v2beta3.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.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 = 7;- Specified by:
getPurgeTimein 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.v2beta3.Task.create_time] before this time were purged. A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.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 = 7;- Specified by:
getPurgeTimeOrBuilderin 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 = 8;- Specified by:
hasTaskTtlin 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 = 8;- Specified by:
getTaskTtlin 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 = 8;- Specified by:
getTaskTtlOrBuilderin interfaceQueueOrBuilder
-
hasTombstoneTtl
public boolean hasTombstoneTtl()
The task tombstone time to live (TTL). After a task is deleted or executed, 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.v2beta3.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 9;- Specified by:
hasTombstoneTtlin 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 executed, 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.v2beta3.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 9;- Specified by:
getTombstoneTtlin interfaceQueueOrBuilder- Returns:
- The tombstoneTtl.
-
getTombstoneTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTombstoneTtlOrBuilder()
The task tombstone time to live (TTL). After a task is deleted or executed, 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.v2beta3.CreateTaskRequest.task]. Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
.google.protobuf.Duration tombstone_ttl = 9;- Specified by:
getTombstoneTtlOrBuilderin interfaceQueueOrBuilder
-
hasStackdriverLoggingConfig
public boolean hasStackdriverLoggingConfig()
Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;- Specified by:
hasStackdriverLoggingConfigin interfaceQueueOrBuilder- Returns:
- Whether the stackdriverLoggingConfig field is set.
-
getStackdriverLoggingConfig
public StackdriverLoggingConfig getStackdriverLoggingConfig()
Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;- Specified by:
getStackdriverLoggingConfigin interfaceQueueOrBuilder- Returns:
- The stackdriverLoggingConfig.
-
getStackdriverLoggingConfigOrBuilder
public StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()
Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;- Specified by:
getStackdriverLoggingConfigOrBuilderin interfaceQueueOrBuilder
-
getTypeValue
public int getTypeValue()
Immutable. The type of a queue (push or pull). `Queue.type` is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of `PUSH` is selected.
.google.cloud.tasks.v2beta3.Queue.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypeValuein interfaceQueueOrBuilder- Returns:
- The enum numeric value on the wire for type.
-
getType
public Queue.Type getType()
Immutable. The type of a queue (push or pull). `Queue.type` is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of `PUSH` is selected.
.google.cloud.tasks.v2beta3.Queue.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypein interfaceQueueOrBuilder- Returns:
- The type.
-
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.v2beta3.QueueStats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasStatsin 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.v2beta3.QueueStats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatsin 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.v2beta3.QueueStats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatsOrBuilderin interfaceQueueOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- 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 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:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein 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:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Queue.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein 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:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Queue getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-