Class Queue (2.54.0)

publicfinalclass QueueextendsGeneratedMessageV3implementsQueueOrBuilder

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.v2beta3.Queue

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Queue

Implements

QueueOrBuilder

Inherited Members

publicstaticfinalintAPP_ENGINE_HTTP_QUEUE_FIELD_NUMBER

publicstaticfinalintHTTP_TARGET_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintPURGE_TIME_FIELD_NUMBER

publicstaticfinalintRATE_LIMITS_FIELD_NUMBER

publicstaticfinalintRETRY_CONFIG_FIELD_NUMBER

publicstaticfinalintSTACKDRIVER_LOGGING_CONFIG_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER

publicstaticfinalintSTATS_FIELD_NUMBER

publicstaticfinalintTASK_TTL_FIELD_NUMBER

publicstaticfinalintTOMBSTONE_TTL_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER

publicstaticQueuegetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticQueue.BuildernewBuilder()

publicstaticQueue.BuildernewBuilder(Queueprototype)

publicstaticQueueparseDelimitedFrom(InputStreaminput)

publicstaticQueueparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticQueueparseFrom(byte[]data)

publicstaticQueueparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticQueueparseFrom(ByteStringdata)

publicstaticQueueparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticQueueparseFrom(CodedInputStreaminput)

publicstaticQueueparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticQueueparseFrom(InputStreaminput)

publicstaticQueueparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticQueueparseFrom(ByteBufferdata)

publicstaticQueueparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Queue>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicAppEngineHttpQueuegetAppEngineHttpQueue()

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;

publicAppEngineHttpQueueOrBuildergetAppEngineHttpQueueOrBuilder()

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;

publicQueuegetDefaultInstanceForType()

publicHttpTargetgetHttpTarget()

Modifies HTTP target for HTTP tasks.

.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;

publicHttpTargetOrBuildergetHttpTargetOrBuilder()

Modifies HTTP target for HTTP tasks.

.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;

publicStringgetName()

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;

publicByteStringgetNameBytes()

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;

publicParser<Queue>getParserForType()

GeneratedMessageV3.getParserForType()

publicTimestampgetPurgeTime()

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;

publicTimestampOrBuildergetPurgeTimeOrBuilder()

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;

publicQueue.QueueTypeCasegetQueueTypeCase()

publicRateLimitsgetRateLimits()

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;

publicRateLimitsOrBuildergetRateLimitsOrBuilder()

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;

publicRetryConfiggetRetryConfig()

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;

publicRetryConfigOrBuildergetRetryConfigOrBuilder()

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;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStackdriverLoggingConfiggetStackdriverLoggingConfig()

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;

publicStackdriverLoggingConfigOrBuildergetStackdriverLoggingConfigOrBuilder()

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;

publicQueue.StategetState()

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.v2beta3.Queue.State state = 6;

publicintgetStateValue()

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.v2beta3.Queue.State state = 6;

publicQueueStatsgetStats()

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

publicQueueStatsOrBuildergetStatsOrBuilder()

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

publicDurationgetTaskTtl()

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;

publicDurationOrBuildergetTaskTtlOrBuilder()

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;

publicDurationgetTombstoneTtl()

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;

publicDurationOrBuildergetTombstoneTtlOrBuilder()

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;

publicQueue.TypegetType()

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

publicintgetTypeValue()

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

publicbooleanhasAppEngineHttpQueue()

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;

publicbooleanhasHttpTarget()

Modifies HTTP target for HTTP tasks.

.google.cloud.tasks.v2beta3.HttpTarget http_target = 13;

publicbooleanhasPurgeTime()

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;

publicbooleanhasRateLimits()

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;

publicbooleanhasRetryConfig()

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;

publicbooleanhasStackdriverLoggingConfig()

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;

publicbooleanhasStats()

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

publicbooleanhasTaskTtl()

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;

publicbooleanhasTombstoneTtl()

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;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicQueue.BuildernewBuilderForType()

protectedQueue.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicQueue.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)