gcp_cloudtasks_queue

ancestors

Type: UNORDERED_LIST_STRING

app_engine_routing_override

Type: STRUCT
Provider name: appEngineRoutingOverride
Description: 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.

• host
  Type: STRING
  Provider name: host
  Description: Output only. 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
  Type: STRING
  Provider name: instance
  Description: 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
  Type: STRING
  Provider name: service
  Description: 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
  Type: STRING
  Provider name: version
  Description: 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.
  

http_target

Type: STRUCT
Provider name: httpTarget
Description: Modifies HTTP target for HTTP tasks.

• header_overrides
  Type: UNORDERED_LIST_STRUCT
  Provider name: headerOverrides
  Description: 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 set Content-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. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.
  
  • header
    Type: STRUCT
    Provider name: header
    Description: Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the Service Specific Terms.
    
    • key
      Type: STRING
      Provider name: key
      Description: The Key of the header.
      
    • value
      Type: STRING
      Provider name: value
      Description: The Value of the header.
      
• http_method
  Type: STRING
  Provider name: httpMethod
  Description: 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.
  Possible values:
  
  • HTTP_METHOD_UNSPECIFIED - HTTP method unspecified
    
  • POST - HTTP POST
    
  • GET - HTTP GET
    
  • HEAD - HTTP HEAD
    
  • PUT - HTTP PUT
    
  • DELETE - HTTP DELETE
    
  • PATCH - HTTP PATCH
    
  • OPTIONS - HTTP OPTIONS
    
• oauth_token
  Type: STRUCT
  Provider name: oauthToken
  Description: If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.
  
  • scope
    Type: STRING
    Provider name: scope
    Description: 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_email
    Type: STRING
    Provider name: serviceAccountEmail
    Description: 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.
    
• oidc_token
  Type: STRUCT
  Provider name: oidcToken
  Description: If specified, an OIDC token is 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. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.
  
  • audience
    Type: STRING
    Provider name: audience
    Description: Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
    
  • service_account_email
    Type: STRING
    Provider name: serviceAccountEmail
    Description: 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.
    
• uri_override
  Type: STRUCT
  Provider name: uriOverride
  Description: URI override. When specified, overrides the execution URI for all the tasks in the queue.
  
  • host
    Type: STRING
    Provider name: host
    Description: 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
    Type: STRUCT
    Provider name: pathOverride
    Description: 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.
    
    • path
      Type: STRING
      Provider name: path
      Description: The URI path (e.g., /users/1234). Default is an empty string.
      
  • port
    Type: INT64
    Provider name: port
    Description: 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
    Type: STRUCT
    Provider name: queryOverride
    Description: 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.
    
    • query_params
      Type: STRING
      Provider name: queryParams
      Description: The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
      
  • scheme
    Type: STRING
    Provider name: scheme
    Description: Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
    Possible values:
    
    • SCHEME_UNSPECIFIED - Scheme unspecified. Defaults to HTTPS.
      
    • HTTP - Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.
      
    • HTTPS - Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca.
      
  • uri_override_enforce_mode
    Type: STRING
    Provider name: uriOverrideEnforceMode
    Description: URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
    Possible values:
    
    • URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED - UriOverrideEnforceMode Unspecified. Defaults to ALWAYS.
      
    • IF_NOT_EXISTS - In the IF_NOT_EXISTS mode, queue-level configuration is only applied where task-level configuration does not exist.
      
    • ALWAYS - In the ALWAYS mode, queue-level configuration overrides all task-level configuration
      

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: 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.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

purge_time

Type: TIMESTAMP
Provider name: purgeTime
Description: 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.

rate_limits

Type: STRUCT
Provider name: rateLimits
Description: 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.

• max_burst_size
  Type: INT32
  Provider name: maxBurstSize
  Description: Output only. 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 of max_burst_size based on the value of max_dispatches_per_second. For queues that were created or updated using queue.yaml/xml, max_burst_size is equal to bucket_size. Since max_burst_size is output only, if UpdateQueue is called on a queue created by queue.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_dispatches
  Type: INT32
  Provider name: maxConcurrentDispatches
  Description: 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_per_second
  Type: DOUBLE
  Provider name: maxDispatchesPerSecond
  Description: 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.
  

resource_name

Type: STRING

retry_config

Type: STRUCT
Provider name: retryConfig
Description: 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.

• max_attempts
  Type: INT32
  Provider name: maxAttempts
  Description: Number of attempts per task. Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_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. Note: Cloud Tasks stops retrying only when max_attempts and max_retry_duration are both satisfied. When the task has been attempted max_attempts times and when the max_retry_duration time has passed, no further attempts are made, and the task is deleted. If you want your task to retry infinitely, you must set max_attempts to -1 and max_retry_duration to 0.
  
• max_backoff
  Type: STRING
  Provider name: maxBackoff
  Description: 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
  Type: INT32
  Provider name: maxDoublings
  Description: The time between retries will double max_doublings times. A task’s retry interval starts at min_backoff, then doubles max_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, and max_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_duration
  Type: STRING
  Provider name: maxRetryDuration
  Description: If positive, max_retry_duration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once max_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 by s (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
  Type: STRING
  Provider name: minBackoff
  Description: 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.
  

stackdriver_logging_config

Type: STRUCT
Provider name: stackdriverLoggingConfig
Description: Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

• sampling_ratio
  Type: DOUBLE
  Provider name: samplingRatio
  Description: 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.
  

state

Type: STRING
Provider name: state
Description: Output only. The state of the queue. state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.
Possible values:

• STATE_UNSPECIFIED - Unspecified state.
  
• RUNNING - The queue is running. Tasks can be dispatched. If the queue was created using Cloud Tasks and the queue has had no activity (method calls or task dispatches) for 30 days, the queue may take a few minutes to re-activate. Some method calls may return NOT_FOUND and tasks may not be dispatched for a few minutes until the queue has been re-activated.
  
• PAUSED - Tasks are paused by the user. If the queue is paused then Cloud Tasks will stop delivering tasks from it, but more tasks can still be added to it by the user.
  
• DISABLED - The queue is disabled. A queue becomes DISABLED when queue.yaml or queue.xml is uploaded which does not contain the queue. You cannot directly disable a queue. When a queue is disabled, tasks can still be added to a queue but the tasks are not dispatched. To permanently delete this queue and all of its tasks, call DeleteQueue.
  

tags

Type: UNORDERED_LIST_STRING