Package com.google.cloud.tasks.v2beta3

Interface QueueOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Queue, Queue.Builder
@Generated public interface QueueOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasAppEngineHttpQueue

      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;
      Returns:
      Whether the appEngineHttpQueue field is set.

    • getAppEngineHttpQueue

      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;
      Returns:
      The appEngineHttpQueue.

    • getAppEngineHttpQueueOrBuilder

      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;

    • hasHttpTarget

      boolean hasHttpTarget()
       Modifies HTTP target for HTTP tasks.
      .google.cloud.tasks.v2beta3.HttpTarget http_target = 13;
      Returns:
      Whether the httpTarget field is set.

    • getHttpTarget

      HttpTarget getHttpTarget()
       Modifies HTTP target for HTTP tasks.
      .google.cloud.tasks.v2beta3.HttpTarget http_target = 13;
      Returns:
      The httpTarget.

    • getHttpTargetOrBuilder

      HttpTargetOrBuilder getHttpTargetOrBuilder()
       Modifies HTTP target for HTTP tasks.
      .google.cloud.tasks.v2beta3.HttpTarget http_target = 13;

    • hasRateLimits

      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;
      Returns:
      Whether the rateLimits field is set.

    • getRateLimits

      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;
      Returns:
      The rateLimits.

    • getRateLimitsOrBuilder

      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;

    • hasRetryConfig

      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;
      Returns:
      Whether the retryConfig field is set.

    • getRetryConfig

      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;
      Returns:
      The retryConfig.

    • getRetryConfigOrBuilder

      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;

    • getStateValue

      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;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      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;
      Returns:
      The state.

    • hasPurgeTime

      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;
      Returns:
      Whether the purgeTime field is set.

    • getPurgeTime

      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;
      Returns:
      The purgeTime.

    • getPurgeTimeOrBuilder

      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;

    • hasTaskTtl

      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;
      Returns:
      Whether the taskTtl field is set.

    • getTaskTtl

      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;
      Returns:
      The taskTtl.

    • getTaskTtlOrBuilder

      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;

    • hasTombstoneTtl

      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;
      Returns:
      Whether the tombstoneTtl field is set.

    • getTombstoneTtl

      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;
      Returns:
      The tombstoneTtl.

    • getTombstoneTtlOrBuilder

      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;

    • hasStackdriverLoggingConfig

      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;
      Returns:
      Whether the stackdriverLoggingConfig field is set.

    • getStackdriverLoggingConfig

      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;
      Returns:
      The stackdriverLoggingConfig.

    • getStackdriverLoggingConfigOrBuilder

      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;

    • getTypeValue

      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];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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];
      Returns:
      The type.

    • hasStats

      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];
      Returns:
      Whether the stats field is set.

    • getStats

      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];
      Returns:
      The stats.

    • getStatsOrBuilder

      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];

    • getQueueTypeCase

      Queue.QueueTypeCase getQueueTypeCase()