Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.cloudtasks/v2.getQueue
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a queue.
Using getQueue
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getQueue(args: GetQueueArgs, opts?: InvokeOptions): Promise<GetQueueResult>
function getQueueOutput(args: GetQueueOutputArgs, opts?: InvokeOptions): Output<GetQueueResult>
def get_queue(location: Optional[str] = None,
project: Optional[str] = None,
queue_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetQueueResult
def get_queue_output(location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
queue_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetQueueResult]
func LookupQueue(ctx *Context, args *LookupQueueArgs, opts ...InvokeOption) (*LookupQueueResult, error)
func LookupQueueOutput(ctx *Context, args *LookupQueueOutputArgs, opts ...InvokeOption) LookupQueueResultOutput
> Note: This function is named LookupQueue
in the Go SDK.
public static class GetQueue
{
public static Task<GetQueueResult> InvokeAsync(GetQueueArgs args, InvokeOptions? opts = null)
public static Output<GetQueueResult> Invoke(GetQueueInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetQueueResult> getQueue(GetQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:cloudtasks/v2:getQueue
arguments:
# arguments dictionary
The following arguments are supported:
getQueue Result
The following output properties are available:
- App
Engine Pulumi.Routing Override Google Native. Cloud Tasks. V2. Outputs. App Engine Routing Response - 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. - Http
Target Pulumi.Google Native. Cloud Tasks. V2. Outputs. Http Target Response - Modifies HTTP target for HTTP tasks.
- Name string
- 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. - Purge
Time string - 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.
- Rate
Limits Pulumi.Google Native. Cloud Tasks. V2. Outputs. Rate Limits Response - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - Retry
Config Pulumi.Google Native. Cloud Tasks. V2. Outputs. Retry Config Response - 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.
- Stackdriver
Logging Pulumi.Config Google Native. Cloud Tasks. V2. Outputs. Stackdriver Logging Config Response - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- State string
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
- App
Engine AppRouting Override Engine Routing Response - 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. - Http
Target HttpTarget Response - Modifies HTTP target for HTTP tasks.
- Name string
- 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. - Purge
Time string - 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.
- Rate
Limits RateLimits Response - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - Retry
Config RetryConfig Response - 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.
- Stackdriver
Logging StackdriverConfig Logging Config Response - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- State string
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
- app
Engine AppRouting Override Engine Routing Response - 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. - http
Target HttpTarget Response - Modifies HTTP target for HTTP tasks.
- name String
- 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. - purge
Time String - 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.
- rate
Limits RateLimits Response - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - retry
Config RetryConfig Response - 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.
- stackdriver
Logging StackdriverConfig Logging Config Response - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- state String
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
- app
Engine AppRouting Override Engine Routing Response - 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. - http
Target HttpTarget Response - Modifies HTTP target for HTTP tasks.
- name string
- 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. - purge
Time string - 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.
- rate
Limits RateLimits Response - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - retry
Config RetryConfig Response - 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.
- stackdriver
Logging StackdriverConfig Logging Config Response - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- state string
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
- app_
engine_ Approuting_ override Engine Routing Response - 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. - http_
target HttpTarget Response - Modifies HTTP target for HTTP tasks.
- name str
- 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. - purge_
time str - 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.
- rate_
limits RateLimits Response - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - retry_
config RetryConfig Response - 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.
- stackdriver_
logging_ Stackdriverconfig Logging Config Response - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- state str
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
- app
Engine Property MapRouting Override - 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. - http
Target Property Map - Modifies HTTP target for HTTP tasks.
- name String
- 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. - purge
Time String - 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.
- rate
Limits Property Map - 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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. - retry
Config Property Map - 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.
- stackdriver
Logging Property MapConfig - Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
- state String
- The state of the queue.
state
can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to changestate
.
Supporting Types
AppEngineRoutingResponse
- Host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host String
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host str
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance str
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service str
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version str
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host String
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
HeaderOverrideResponse
- Header
Pulumi.
Google Native. Cloud Tasks. V2. Inputs. Header Response - header embodying a key and a value.
- Header
Header
Response - header embodying a key and a value.
- header
Header
Response - header embodying a key and a value.
- header
Header
Response - header embodying a key and a value.
- header
Header
Response - header embodying a key and a value.
- header Property Map
- header embodying a key and a value.
HeaderResponse
HttpTargetResponse
- Header
Overrides List<Pulumi.Google Native. Cloud Tasks. V2. Inputs. Header Override Response> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - Http
Method string - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- Oauth
Token Pulumi.Google Native. Cloud Tasks. V2. Inputs. OAuth Token Response - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token Pulumi.Google Native. Cloud Tasks. V2. Inputs. Oidc Token Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - Uri
Override Pulumi.Google Native. Cloud Tasks. V2. Inputs. Uri Override Response - URI override. When specified, overrides the execution URI for all the tasks in the queue.
- Header
Overrides []HeaderOverride Response - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - Http
Method string - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- Oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - Oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - Uri
Override UriOverride Response - URI override. When specified, overrides the execution URI for all the tasks in the queue.
- header
Overrides List<HeaderOverride Response> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - http
Method String - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri
Override UriOverride Response - URI override. When specified, overrides the execution URI for all the tasks in the queue.
- header
Overrides HeaderOverride Response[] - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - http
Method string - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- oauth
Token OAuthToken Response - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri
Override UriOverride Response - URI override. When specified, overrides the execution URI for all the tasks in the queue.
- header_
overrides Sequence[HeaderOverride Response] - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - http_
method str - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- oauth_
token OAuthToken Response - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc_
token OidcToken Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri_
override UriOverride Response - URI override. When specified, overrides the execution URI for all the tasks in the queue.
- header
Overrides List<Property Map> - HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks.
Content-Type
won't be set by Cloud Tasks. You can explicitly setContent-Type
to a media type when the task is created. For example,Content-Type
can be set to"application/octet-stream"
or"application/json"
. The default value is set to "application/json". * User-Agent: This will be set to
"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. - http
Method String - The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.
- oauth
Token Property Map - If specified, an OAuth token will be generated and attached as the
Authorization
header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. - oidc
Token Property Map - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - uri
Override Property Map - URI override. When specified, overrides the execution URI for all the tasks in the queue.
OAuthTokenResponse
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope str
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service_
account_ stremail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
OidcTokenResponse
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience str
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ stremail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
PathOverrideResponse
- Path string
- The URI path (e.g., /users/1234). Default is an empty string.
- Path string
- The URI path (e.g., /users/1234). Default is an empty string.
- path String
- The URI path (e.g., /users/1234). Default is an empty string.
- path string
- The URI path (e.g., /users/1234). Default is an empty string.
- path str
- The URI path (e.g., /users/1234). Default is an empty string.
- path String
- The URI path (e.g., /users/1234). Default is an empty string.
QueryOverrideResponse
- Query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- Query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params String - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params string - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query_
params str - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
- query
Params String - The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
RateLimitsResponse
- Max
Burst intSize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - Max
Concurrent intDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- Max
Dispatches doublePer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
- Max
Burst intSize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - Max
Concurrent intDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- Max
Dispatches float64Per Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
- max
Burst IntegerSize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - max
Concurrent IntegerDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- max
Dispatches DoublePer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
- max
Burst numberSize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - max
Concurrent numberDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- max
Dispatches numberPer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
- max_
burst_ intsize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - max_
concurrent_ intdispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- max_
dispatches_ floatper_ second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
- max
Burst NumberSize - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The token bucket algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by
max_burst_size
. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value ofmax_burst_size
based on the value of max_dispatches_per_second. For queues that were created or updated usingqueue.yaml/xml
,max_burst_size
is equal to bucket_size. Sincemax_burst_size
is output only, if UpdateQueue is called on a queue created byqueue.yaml/xml
,max_burst_size
will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated. - max
Concurrent NumberDispatches - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as max_concurrent_requests in queue.yaml/xml.
- max
Dispatches NumberPer Second - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This field has the same meaning as rate in queue.yaml/xml.
RetryConfigResponse
- Max
Attempts int - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - Max
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - Max
Doublings int - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - Max
Retry stringDuration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - Min
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
- Max
Attempts int - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - Max
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - Max
Doublings int - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - Max
Retry stringDuration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - Min
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
- max
Attempts Integer - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - max
Backoff String - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - max
Doublings Integer - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - max
Retry StringDuration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - min
Backoff String - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
- max
Attempts number - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - max
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - max
Doublings number - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - max
Retry stringDuration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - min
Backoff string - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
- max_
attempts int - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - max_
backoff str - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - max_
doublings int - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - max_
retry_ strduration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - min_
backoff str - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
- max
Attempts Number - Number of attempts per task. Cloud Tasks will attempt the task
max_attempts
times (that is, if the first attempt fails, then there will bemax_attempts - 1
retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as task_retry_limit in queue.yaml/xml. - max
Backoff String - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.max_backoff
will be truncated to the nearest second. This field has the same meaning as max_backoff_seconds in queue.yaml/xml. - max
Doublings Number - The time between retries will double
max_doublings
times. A task's retry interval starts at min_backoff, then doublesmax_doublings
times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, andmax_doublings
is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as max_doublings in queue.yaml/xml. - max
Retry StringDuration - If positive,
max_retry_duration
specifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_duration
time has passed and the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For the maximum possible value or the format, see the documentation for Duration.max_retry_duration
will be truncated to the nearest second. This field has the same meaning as task_age_limit in queue.yaml/xml. - min
Backoff String - A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by
s
(for "seconds"). For more information on the format, see the documentation for Duration.min_backoff
will be truncated to the nearest second. This field has the same meaning as min_backoff_seconds in queue.yaml/xml.
StackdriverLoggingConfigResponse
- Sampling
Ratio double - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- Sampling
Ratio float64 - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio Double - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio number - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling_
ratio float - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
- sampling
Ratio Number - Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
UriOverrideResponse
- Host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- Path
Override Pulumi.Google Native. Cloud Tasks. V2. Inputs. Path Override Response - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- Port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- Query
Override Pulumi.Google Native. Cloud Tasks. V2. Inputs. Query Override Response - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- Scheme string
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- Uri
Override stringEnforce Mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
- Host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- Path
Override PathOverride Response - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- Port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- Query
Override QueryOverride Response - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- Scheme string
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- Uri
Override stringEnforce Mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
- host String
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override PathOverride Response - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- port String
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override QueryOverride Response - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- scheme String
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- uri
Override StringEnforce Mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
- host string
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override PathOverride Response - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- port string
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override QueryOverride Response - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- scheme string
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- uri
Override stringEnforce Mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
- host str
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- path_
override PathOverride Response - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- port str
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query_
override QueryOverride Response - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- scheme str
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- uri_
override_ strenforce_ mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
- host String
- Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
- path
Override Property Map - URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
- port String
- Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
- query
Override Property Map - URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
- scheme String
- Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
- uri
Override StringEnforce Mode - URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi