Interface QueueOrBuilder (2.21.0)

public interface QueueOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineHttpQueue()

public abstract AppEngineHttpQueue getAppEngineHttpQueue()

AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto.

.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;

Returns
Type	Description
`AppEngineHttpQueue`	The appEngineHttpQueue.

getAppEngineHttpQueueOrBuilder()

public abstract AppEngineHttpQueueOrBuilder getAppEngineHttpQueueOrBuilder()

AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto.

.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;

Returns
Type	Description
`AppEngineHttpQueueOrBuilder`

getName()

public abstract String getName()

Caller-specified and required in 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
LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling 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
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Caller-specified and required in 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
LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling 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
Type	Description
`ByteString`	The bytes for name.

getPurgeTime()

public abstract Timestamp getPurgeTime()

Output only. The last time this queue was purged.

All tasks that were created before this time were purged.

A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.

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
Type	Description
`Timestamp`	The purgeTime.

getPurgeTimeOrBuilder()

public abstract TimestampOrBuilder getPurgeTimeOrBuilder()

Output only. The last time this queue was purged.

All tasks that were created before this time were purged.

A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.

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
Type	Description
`TimestampOrBuilder`

getQueueTypeCase()

public abstract Queue.QueueTypeCase getQueueTypeCase()

Returns
Type	Description
`Queue.QueueTypeCase`

getRateLimits()

public abstract RateLimits getRateLimits()

Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's 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
Type	Description
`RateLimits`	The rateLimits.

getRateLimitsOrBuilder()

public abstract RateLimitsOrBuilder getRateLimitsOrBuilder()

Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's 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
Type	Description
`RateLimitsOrBuilder`

getRetryConfig()

public abstract 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.

.google.cloud.tasks.v2beta3.RetryConfig retry_config = 5;

Returns
Type	Description
`RetryConfig`	The retryConfig.

getRetryConfigOrBuilder()

public abstract 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.

.google.cloud.tasks.v2beta3.RetryConfig retry_config = 5;

Returns
Type	Description
`RetryConfigOrBuilder`

getStackdriverLoggingConfig()

public abstract StackdriverLoggingConfig getStackdriverLoggingConfig()

Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;

Returns
Type	Description
`StackdriverLoggingConfig`	The stackdriverLoggingConfig.

getStackdriverLoggingConfigOrBuilder()

public abstract StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()

Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;

Returns
Type	Description
`StackdriverLoggingConfigOrBuilder`

getState()

public abstract Queue.State getState()

Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

.google.cloud.tasks.v2beta3.Queue.State state = 6;

Returns
Type	Description
`Queue.State`	The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

.google.cloud.tasks.v2beta3.Queue.State state = 6;

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getStats()

public abstract 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
Type	Description
`QueueStats`	The stats.

getStatsOrBuilder()

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

Returns
Type	Description
`QueueStatsOrBuilder`

getTaskTtl()

public abstract 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 for these queues. To view the maximum valid duration, see the documentation for Duration.

.google.protobuf.Duration task_ttl = 8;

Returns
Type	Description
`Duration`	The taskTtl.

getTaskTtlOrBuilder()

public abstract 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.

.google.protobuf.Duration task_ttl = 8;

Returns
Type	Description
`DurationOrBuilder`

getTombstoneTtl()

public abstract 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.

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

.google.protobuf.Duration tombstone_ttl = 9;

Returns
Type	Description
`Duration`	The tombstoneTtl.

getTombstoneTtlOrBuilder()

public abstract DurationOrBuilder getTombstoneTtlOrBuilder()

The task tombstone time to live (TTL).

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

.google.protobuf.Duration tombstone_ttl = 9;

Returns
Type	Description
`DurationOrBuilder`

getType()

public abstract 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
Type	Description
`Queue.Type`	The type.

getTypeValue()

public abstract 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
Type	Description
`int`	The enum numeric value on the wire for type.

hasAppEngineHttpQueue()

public abstract boolean hasAppEngineHttpQueue()

AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto.

.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;

Returns
Type	Description
`boolean`	Whether the appEngineHttpQueue field is set.

hasPurgeTime()

public abstract boolean hasPurgeTime()

Output only. The last time this queue was purged.

All tasks that were created before this time were purged.

A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.

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
Type	Description
`boolean`	Whether the purgeTime field is set.

hasRateLimits()

public abstract boolean hasRateLimits()

Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:

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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's 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
Type	Description
`boolean`	Whether the rateLimits field is set.

hasRetryConfig()

public abstract 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.

.google.cloud.tasks.v2beta3.RetryConfig retry_config = 5;

Returns
Type	Description
`boolean`	Whether the retryConfig field is set.

hasStackdriverLoggingConfig()

public abstract boolean hasStackdriverLoggingConfig()

Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;

Returns
Type	Description
`boolean`	Whether the stackdriverLoggingConfig field is set.

hasStats()

public abstract 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
Type	Description
`boolean`	Whether the stats field is set.

hasTaskTtl()

public abstract 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.

.google.protobuf.Duration task_ttl = 8;

Returns
Type	Description
`boolean`	Whether the taskTtl field is set.

hasTombstoneTtl()

public abstract boolean hasTombstoneTtl()

The task tombstone time to live (TTL).

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

.google.protobuf.Duration tombstone_ttl = 9;

Returns
Type	Description
`boolean`	Whether the tombstoneTtl field is set.