Package com.google.cloud.tasks.v2

Class 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 type google.cloud.tasks.v2.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.

      • 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

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • APP_ENGINE_ROUTING_OVERRIDE_FIELD_NUMBER

        public static final int APP_ENGINE_ROUTING_OVERRIDE_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

      • PURGE_TIME_FIELD_NUMBER

        public static final int PURGE_TIME_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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.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 com.google.protobuf.ByteString getNameBytes()
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.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.

      • hasAppEngineRoutingOverride

        public boolean hasAppEngineRoutingOverride()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        hasAppEngineRoutingOverride in interface QueueOrBuilder
        Returns:
        Whether the appEngineRoutingOverride field is set.

      • getAppEngineRoutingOverride

        public AppEngineRouting getAppEngineRoutingOverride()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        getAppEngineRoutingOverride in interface QueueOrBuilder
        Returns:
        The appEngineRoutingOverride.

      • getAppEngineRoutingOverrideOrBuilder

        public AppEngineRoutingOrBuilder getAppEngineRoutingOverrideOrBuilder()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        getAppEngineRoutingOverrideOrBuilder in interface QueueOrBuilder

      • hasRateLimits

        public boolean hasRateLimits()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.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.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.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.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.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.v2.RateLimits rate_limits = 3;
        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.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.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.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.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.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.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.v2.RateLimits rate_limits = 3;
        Specified by:
        getRateLimits in interface QueueOrBuilder
        Returns:
        The rateLimits.

      • getRateLimitsOrBuilder

        public RateLimitsOrBuilder getRateLimitsOrBuilder()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.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.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.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.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.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.v2.RateLimits rate_limits = 3;
        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.v2.RetryConfig retry_config = 4;
        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.v2.RetryConfig retry_config = 4;
        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.v2.RetryConfig retry_config = 4;
        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.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        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.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        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.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.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 = 6;
        Specified by:
        hasPurgeTime in interface QueueOrBuilder
        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.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.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 = 6;
        Specified by:
        getPurgeTime in interface QueueOrBuilder
        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.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.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 = 6;
        Specified by:
        getPurgeTimeOrBuilder 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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        Specified by:
        getStackdriverLoggingConfigOrBuilder in interface QueueOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Queue.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Queue.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Queue.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.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 interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Queue getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder