com.google.cloud.tasks.v2beta2

Interface QueueOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Queue, Queue.Builder

public interface QueueOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AppEngineHttpTarget	getAppEngineHttpTarget() App Engine HTTP target.
AppEngineHttpTargetOrBuilder	getAppEngineHttpTargetOrBuilder() App Engine HTTP target.
String	getName() Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only.
ByteString	getNameBytes() Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after which it becomes output only.
PullTarget	getPullTarget() Pull target.
PullTargetOrBuilder	getPullTargetOrBuilder() Pull target.
Timestamp	getPurgeTime() Output only.
TimestampOrBuilder	getPurgeTimeOrBuilder() Output only.
RateLimits	getRateLimits() Rate limits for task dispatches.
RateLimitsOrBuilder	getRateLimitsOrBuilder() Rate limits for task dispatches.
RetryConfig	getRetryConfig() Settings that determine the retry behavior.
RetryConfigOrBuilder	getRetryConfigOrBuilder() Settings that determine the retry behavior.
Queue.State	getState() Output only.
int	getStateValue() Output only.
QueueStats	getStats() Output only.
QueueStatsOrBuilder	getStatsOrBuilder() Output only.
Queue.TargetTypeCase	getTargetTypeCase()
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).
boolean	hasAppEngineHttpTarget() App Engine HTTP target.
boolean	hasPullTarget() Pull target.
boolean	hasPurgeTime() Output only.
boolean	hasRateLimits() Rate limits for task dispatches.
boolean	hasRetryConfig() Settings that determine the retry behavior.
boolean	hasStats() Output only.
boolean	hasTaskTtl() The maximum amount of time that a task will be retained in this queue.
boolean	hasTombstoneTtl() The task tombstone time to live (TTL).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue],
 after which it becomes output only.
 The queue name.
 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
 

string name = 1;

Returns:

The name.

getNameBytes

ByteString getNameBytes()

 Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue],
 after which it becomes output only.
 The queue name.
 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
 

string name = 1;

Returns:

The bytes for name.

hasAppEngineHttpTarget

boolean hasAppEngineHttpTarget()

 App Engine HTTP target.
 An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
 

.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;

Returns:

Whether the appEngineHttpTarget field is set.

getAppEngineHttpTarget

AppEngineHttpTarget getAppEngineHttpTarget()

 App Engine HTTP target.
 An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
 

.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;

Returns:

The appEngineHttpTarget.

getAppEngineHttpTargetOrBuilder

AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()

 App Engine HTTP target.
 An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
 

.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;

hasPullTarget

boolean hasPullTarget()

 Pull target.
 A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
 

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

Returns:

Whether the pullTarget field is set.

getPullTarget

PullTarget getPullTarget()

 Pull target.
 A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
 

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

Returns:

The pullTarget.

getPullTargetOrBuilder

PullTargetOrBuilder getPullTargetOrBuilder()

 Pull target.
 A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget].
 

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

hasRateLimits

boolean hasRateLimits()

 Rate limits for task dispatches.
 [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both
 control task attempts however they control how tasks are
 attempted in different ways:
 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the
   second attempt, third attempt, etc).
 

.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;

Returns:

Whether the rateLimits field is set.

getRateLimits

RateLimits getRateLimits()

 Rate limits for task dispatches.
 [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both
 control task attempts however they control how tasks are
 attempted in different ways:
 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the
   second attempt, third attempt, etc).
 

.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;

Returns:

The rateLimits.

getRateLimitsOrBuilder

RateLimitsOrBuilder getRateLimitsOrBuilder()

 Rate limits for task dispatches.
 [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both
 control task attempts however they control how tasks are
 attempted in different ways:
 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the
   second attempt, third attempt, etc).
 

.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;

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.v2beta2.RetryConfig retry_config = 6;

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.v2beta2.RetryConfig retry_config = 6;

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.v2beta2.RetryConfig retry_config = 6;

getStateValue

int getStateValue()

 Output only. The state of the queue.
 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
 

.google.cloud.tasks.v2beta2.Queue.State state = 7;

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 calling
 [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`.
 

.google.cloud.tasks.v2beta2.Queue.State state = 7;

Returns:

The state.

hasPurgeTime

boolean hasPurgeTime()

 Output only. The last time this queue was purged.
 All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time
 were purged.
 A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the
 [App Engine Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
 

.google.protobuf.Timestamp purge_time = 8;

Returns:

Whether the purgeTime field is set.

getPurgeTime

Timestamp getPurgeTime()

 Output only. The last time this queue was purged.
 All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time
 were purged.
 A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the
 [App Engine Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
 

.google.protobuf.Timestamp purge_time = 8;

Returns:

The purgeTime.

getPurgeTimeOrBuilder

TimestampOrBuilder getPurgeTimeOrBuilder()

 Output only. The last time this queue was purged.
 All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time
 were purged.
 A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the
 [App Engine Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
 

.google.protobuf.Timestamp purge_time = 8;

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 = 9;

Returns:

Whether the taskTtl field is set.

getTaskTtl

Duration getTaskTtl()

 The maximum amount of time that a task will be retained in
 this queue.
 Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
 After a task has lived for `task_ttl`, the task will be deleted
 regardless of whether it was dispatched or not.
 The `task_ttl` for queues created via queue.yaml/xml is equal to the
 maximum duration because there is a
 [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
 these queues. To view the maximum valid duration, see the documentation for
 [Duration][google.protobuf.Duration].
 

.google.protobuf.Duration task_ttl = 9;

Returns:

The taskTtl.

getTaskTtlOrBuilder

DurationOrBuilder getTaskTtlOrBuilder()

 The maximum amount of time that a task will be retained in
 this queue.
 Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
 After a task has lived for `task_ttl`, the task will be deleted
 regardless of whether it was dispatched or not.
 The `task_ttl` for queues created via queue.yaml/xml is equal to the
 maximum duration because there is a
 [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
 these queues. To view the maximum valid duration, see the documentation for
 [Duration][google.protobuf.Duration].
 

.google.protobuf.Duration task_ttl = 9;

hasTombstoneTtl

boolean hasTombstoneTtl()

 The task tombstone time to live (TTL).
 After a task is deleted or completed, the task's tombstone is
 retained for the length of time specified by `tombstone_ttl`.
 The tombstone is used by task de-duplication; another task with the same
 name can't be created until the tombstone has expired. For more information
 about task de-duplication, see the documentation for
 [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
 Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
 

.google.protobuf.Duration tombstone_ttl = 10;

Returns:

Whether the tombstoneTtl field is set.

getTombstoneTtl

Duration getTombstoneTtl()

 The task tombstone time to live (TTL).
 After a task is deleted or completed, the task's tombstone is
 retained for the length of time specified by `tombstone_ttl`.
 The tombstone is used by task de-duplication; another task with the same
 name can't be created until the tombstone has expired. For more information
 about task de-duplication, see the documentation for
 [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
 Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
 

.google.protobuf.Duration tombstone_ttl = 10;

Returns:

The tombstoneTtl.

getTombstoneTtlOrBuilder

DurationOrBuilder getTombstoneTtlOrBuilder()

 The task tombstone time to live (TTL).
 After a task is deleted or completed, the task's tombstone is
 retained for the length of time specified by `tombstone_ttl`.
 The tombstone is used by task de-duplication; another task with the same
 name can't be created until the tombstone has expired. For more information
 about task de-duplication, see the documentation for
 [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
 Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
 

.google.protobuf.Duration tombstone_ttl = 10;

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.v2beta2.QueueStats stats = 16 [(.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.v2beta2.QueueStats stats = 16 [(.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.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

getTargetTypeCase

Queue.TargetTypeCase getTargetTypeCase()