Interface QueueOrBuilder (2.18.0)

Version 2.18.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.12
• 2.2.0
• 2.1.11

public interface QueueOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppEngineRoutingOverride()

public abstract AppEngineRouting getAppEngineRoutingOverride()

Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

Returns
Type	Description
AppEngineRouting	The appEngineRoutingOverride.

getAppEngineRoutingOverrideOrBuilder()

public abstract AppEngineRoutingOrBuilder getAppEngineRoutingOverrideOrBuilder()

Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

Returns
Type	Description
AppEngineRoutingOrBuilder

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

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

Returns
Type	Description
TimestampOrBuilder

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.v2.RateLimits rate_limits = 3;

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.v2.RateLimits rate_limits = 3;

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.v2.RetryConfig retry_config = 4;

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.v2.RetryConfig retry_config = 4;

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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

Returns
Type	Description
StackdriverLoggingConfigOrBuilder

getState()

public abstract Queue.State getState()

Output only. The state of the queue. state can only be changed by called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

.google.cloud.tasks.v2.Queue.State state = 5;

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 called PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

.google.cloud.tasks.v2.Queue.State state = 5;

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

hasAppEngineRoutingOverride()

public abstract boolean hasAppEngineRoutingOverride()

Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, app_engine_routing_override is used for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.

.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

Returns
Type	Description
boolean	Whether the appEngineRoutingOverride 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 = 6;

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.v2.RateLimits rate_limits = 3;

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.v2.RetryConfig retry_config = 4;

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.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

Returns
Type	Description
boolean	Whether the stackdriverLoggingConfig field is set.