Queue (Google Cloud Tasks Parent 2.3.12 API)

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, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Queue
extends 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 type google.cloud.tasks.v2beta3.Queue

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Queue.Builder` A queue is a container of related tasks.
`static class`	`Queue.QueueTypeCase`
`static class`	`Queue.State` State of the queue.
`static class`	`Queue.Type` The type of the queue.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`APP_ENGINE_HTTP_QUEUE_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`PURGE_TIME_FIELD_NUMBER`
`static int`	`RATE_LIMITS_FIELD_NUMBER`
`static int`	`RETRY_CONFIG_FIELD_NUMBER`
`static int`	`STACKDRIVER_LOGGING_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`
`static int`	`TYPE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`AppEngineHttpQueue`	`getAppEngineHttpQueue()` [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
`AppEngineHttpQueueOrBuilder`	`getAppEngineHttpQueueOrBuilder()` [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
`static Queue`	`getDefaultInstance()`
`Queue`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`String`	`getName()` Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], after which it becomes output only.
`ByteString`	`getNameBytes()` Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], after which it becomes output only.
`Parser<Queue>`	`getParserForType()`
`Timestamp`	`getPurgeTime()` Output only.
`TimestampOrBuilder`	`getPurgeTimeOrBuilder()` Output only.
`Queue.QueueTypeCase`	`getQueueTypeCase()`
`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()`
`StackdriverLoggingConfig`	`getStackdriverLoggingConfig()` Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).
`StackdriverLoggingConfigOrBuilder`	`getStackdriverLoggingConfigOrBuilder()` Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).
`Queue.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`QueueStats`	`getStats()` Output only.
`QueueStatsOrBuilder`	`getStatsOrBuilder()` Output only.
`Duration`	`getTaskTtl()` The maximum amount of time that a task will be retained in this queue.
`DurationOrBuilder`	`getTaskTtlOrBuilder()` The maximum amount of time that a task will be retained in this queue.
`Duration`	`getTombstoneTtl()` The task tombstone time to live (TTL).
`DurationOrBuilder`	`getTombstoneTtlOrBuilder()` The task tombstone time to live (TTL).
`Queue.Type`	`getType()` Immutable.
`int`	`getTypeValue()` Immutable.
`UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasAppEngineHttpQueue()` [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
`int`	`hashCode()`
`boolean`	`hasPurgeTime()` Output only.
`boolean`	`hasRateLimits()` Rate limits for task dispatches.
`boolean`	`hasRetryConfig()` Settings that determine the retry behavior.
`boolean`	`hasStackdriverLoggingConfig()` Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/).
`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 GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Queue.Builder`	`newBuilder()`
`static Queue.Builder`	`newBuilder(Queue prototype)`
`Queue.Builder`	`newBuilderForType()`
`protected Queue.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Queue`	`parseDelimitedFrom(InputStream input)`
`static Queue`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Queue`	`parseFrom(byte[] data)`
`static Queue`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Queue`	`parseFrom(ByteBuffer data)`
`static Queue`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Queue`	`parseFrom(ByteString data)`
`static Queue`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Queue`	`parseFrom(CodedInputStream input)`
`static Queue`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Queue`	`parseFrom(InputStream input)`
`static Queue`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Queue>`	`parser()`
`Queue.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

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

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- APP_ENGINE_HTTP_QUEUE_FIELD_NUMBER
```
public static final int APP_ENGINE_HTTP_QUEUE_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(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getQueueTypeCase
```
public Queue.QueueTypeCase getQueueTypeCase()
```
Specified by:

getQueueTypeCase in interface QueueOrBuilder

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:: getName in interface QueueOrBuilder
Returns:: The name.

getNameBytes

public 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:: getNameBytes in interface QueueOrBuilder
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:: hasAppEngineHttpQueue in interface QueueOrBuilder
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:: getAppEngineHttpQueue in interface QueueOrBuilder
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:: getAppEngineHttpQueueOrBuilder in interface QueueOrBuilder

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:: hasRateLimits in interface QueueOrBuilder
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:: getRateLimits in interface QueueOrBuilder
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:: getRateLimitsOrBuilder in interface QueueOrBuilder

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:: hasRetryConfig in interface QueueOrBuilder
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:: getRetryConfig in interface QueueOrBuilder
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:: getRetryConfigOrBuilder in interface QueueOrBuilder

getStateValue

public int getStateValue()

 Output only. The state of the queue.
 `state` can only be changed by calling
 [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:: getStateValue in interface QueueOrBuilder
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 calling
 [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:: getState in interface QueueOrBuilder
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:: hasPurgeTime in interface QueueOrBuilder
Returns:: Whether the purgeTime field is set.

getPurgeTime

public 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:: getPurgeTime in interface QueueOrBuilder
Returns:: The purgeTime.

getPurgeTimeOrBuilder

public 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:: getPurgeTimeOrBuilder in interface QueueOrBuilder

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:: hasTaskTtl in interface QueueOrBuilder
Returns:: Whether the taskTtl field is set.

getTaskTtl

public 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:: getTaskTtl in interface QueueOrBuilder
Returns:: The taskTtl.

getTaskTtlOrBuilder

public 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:: getTaskTtlOrBuilder in interface QueueOrBuilder

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:: hasTombstoneTtl in interface QueueOrBuilder
Returns:: Whether the tombstoneTtl field is set.

getTombstoneTtl

public 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:: getTombstoneTtl in interface QueueOrBuilder
Returns:: The tombstoneTtl.

getTombstoneTtlOrBuilder

public 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:: getTombstoneTtlOrBuilder in interface QueueOrBuilder

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:

hasStackdriverLoggingConfig in interface QueueOrBuilder

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:: getStackdriverLoggingConfig in interface QueueOrBuilder
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:: getStackdriverLoggingConfigOrBuilder in interface QueueOrBuilder

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:: getTypeValue in interface QueueOrBuilder
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:: getType in interface QueueOrBuilder
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:: hasStats in interface QueueOrBuilder
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:: getStats in interface QueueOrBuilder
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:: getStatsOrBuilder in interface QueueOrBuilder

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo
```
public void writeTo(CodedOutputStream output)
             throws IOException
```
Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Queue parseFrom(ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

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

Throws:: InvalidProtocolBufferException

parseFrom

public static Queue parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

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

Throws:: InvalidProtocolBufferException

parseFrom

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

Throws:: InvalidProtocolBufferException

parseFrom

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

Throws:: InvalidProtocolBufferException

parseFrom

public static Queue parseFrom(InputStream input)
                       throws IOException

Throws:: IOException

parseFrom

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

Throws:: IOException

parseDelimitedFrom

public static Queue parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:: IOException

parseDelimitedFrom

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

Throws:: IOException

parseFrom

public static Queue parseFrom(CodedInputStream input)
                       throws IOException

Throws:: IOException

parseFrom

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

Throws:: IOException

newBuilderForType
```
public Queue.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Queue.Builder newBuilder()

newBuilder

public static Queue.Builder newBuilder(Queue prototype)

toBuilder
```
public Queue.Builder toBuilder()
```
Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Queue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Queue getDefaultInstance()

parser
```
public static Parser<Queue> parser()
```

getParserForType
```
public Parser<Queue> getParserForType()
```
Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType
```
public Queue getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

Class Queue

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

NAME_FIELD_NUMBER

APP_ENGINE_HTTP_QUEUE_FIELD_NUMBER

RATE_LIMITS_FIELD_NUMBER

RETRY_CONFIG_FIELD_NUMBER

STATE_FIELD_NUMBER

PURGE_TIME_FIELD_NUMBER

TASK_TTL_FIELD_NUMBER

TOMBSTONE_TTL_FIELD_NUMBER

STACKDRIVER_LOGGING_CONFIG_FIELD_NUMBER

TYPE_FIELD_NUMBER

STATS_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getQueueTypeCase

getName

getNameBytes

hasAppEngineHttpQueue

getAppEngineHttpQueue

getAppEngineHttpQueueOrBuilder

hasRateLimits

getRateLimits

getRateLimitsOrBuilder

hasRetryConfig

getRetryConfig

getRetryConfigOrBuilder

getStateValue

getState

hasPurgeTime

getPurgeTime

getPurgeTimeOrBuilder

hasTaskTtl

getTaskTtl

getTaskTtlOrBuilder

hasTombstoneTtl

getTombstoneTtl

getTombstoneTtlOrBuilder

hasStackdriverLoggingConfig

getStackdriverLoggingConfig

getStackdriverLoggingConfigOrBuilder

getTypeValue

getType

hasStats

getStats

getStatsOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom