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/v2beta2.getTask
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 task.
Using getTask
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 getTask(args: GetTaskArgs, opts?: InvokeOptions): Promise<GetTaskResult>
function getTaskOutput(args: GetTaskOutputArgs, opts?: InvokeOptions): Output<GetTaskResult>
def get_task(location: Optional[str] = None,
project: Optional[str] = None,
queue_id: Optional[str] = None,
response_view: Optional[str] = None,
task_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTaskResult
def get_task_output(location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
queue_id: Optional[pulumi.Input[str]] = None,
response_view: Optional[pulumi.Input[str]] = None,
task_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTaskResult]
func LookupTask(ctx *Context, args *LookupTaskArgs, opts ...InvokeOption) (*LookupTaskResult, error)
func LookupTaskOutput(ctx *Context, args *LookupTaskOutputArgs, opts ...InvokeOption) LookupTaskResultOutput
> Note: This function is named LookupTask
in the Go SDK.
public static class GetTask
{
public static Task<GetTaskResult> InvokeAsync(GetTaskArgs args, InvokeOptions? opts = null)
public static Output<GetTaskResult> Invoke(GetTaskInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTaskResult> getTask(GetTaskArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:cloudtasks/v2beta2:getTask
arguments:
# arguments dictionary
The following arguments are supported:
- Location
This property is required. string - Queue
Id This property is required. string - Task
Id This property is required. string - Project string
- Response
View string
- Location
This property is required. string - Queue
Id This property is required. string - Task
Id This property is required. string - Project string
- Response
View string
- location
This property is required. String - queue
Id This property is required. String - task
Id This property is required. String - project String
- response
View String
- location
This property is required. string - queue
Id This property is required. string - task
Id This property is required. string - project string
- response
View string
- location
This property is required. str - queue_
id This property is required. str - task_
id This property is required. str - project str
- response_
view str
- location
This property is required. String - queue
Id This property is required. String - task
Id This property is required. String - project String
- response
View String
getTask Result
The following output properties are available:
- App
Engine Pulumi.Http Request Google Native. Cloud Tasks. V2Beta2. Outputs. App Engine Http Request Response - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- Create
Time string - The time that the task was created.
create_time
will be truncated to the nearest second. - Http
Request Pulumi.Google Native. Cloud Tasks. V2Beta2. Outputs. Http Request Response - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- Name string
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - Pull
Message Pulumi.Google Native. Cloud Tasks. V2Beta2. Outputs. Pull Message Response - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- Schedule
Time string - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - Status
Pulumi.
Google Native. Cloud Tasks. V2Beta2. Outputs. Task Status Response - The task status.
- View string
- The view specifies which subset of the Task has been returned.
- App
Engine AppHttp Request Engine Http Request Response - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- Create
Time string - The time that the task was created.
create_time
will be truncated to the nearest second. - Http
Request HttpRequest Response - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- Name string
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - Pull
Message PullMessage Response - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- Schedule
Time string - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - Status
Task
Status Response - The task status.
- View string
- The view specifies which subset of the Task has been returned.
- app
Engine AppHttp Request Engine Http Request Response - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- create
Time String - The time that the task was created.
create_time
will be truncated to the nearest second. - http
Request HttpRequest Response - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- name String
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - pull
Message PullMessage Response - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- schedule
Time String - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - status
Task
Status Response - The task status.
- view String
- The view specifies which subset of the Task has been returned.
- app
Engine AppHttp Request Engine Http Request Response - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- create
Time string - The time that the task was created.
create_time
will be truncated to the nearest second. - http
Request HttpRequest Response - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- name string
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - pull
Message PullMessage Response - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- schedule
Time string - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - status
Task
Status Response - The task status.
- view string
- The view specifies which subset of the Task has been returned.
- app_
engine_ Apphttp_ request Engine Http Request Response - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- create_
time str - The time that the task was created.
create_time
will be truncated to the nearest second. - http_
request HttpRequest Response - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- name str
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - pull_
message PullMessage Response - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- schedule_
time str - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - status
Task
Status Response - The task status.
- view str
- The view specifies which subset of the Task has been returned.
- app
Engine Property MapHttp Request - App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
- create
Time String - The time that the task was created.
create_time
will be truncated to the nearest second. - http
Request Property Map - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- name String
- Optionally caller-specified in CreateTask. The task name. The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_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 task'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. *TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. - pull
Message Property Map - LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.
- schedule
Time String - The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond. - status Property Map
- The task status.
- view String
- The view specifies which subset of the Task has been returned.
Supporting Types
AppEngineHttpRequestResponse
- App
Engine Routing This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. Inputs. App Engine Routing Response - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- Headers
This property is required. Dictionary<string, string> - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - Http
Method This property is required. string - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- Payload
This property is required. string - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- Relative
Url This property is required. string - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- App
Engine Routing This property is required. AppEngine Routing Response - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- Headers
This property is required. map[string]string - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - Http
Method This property is required. string - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- Payload
This property is required. string - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- Relative
Url This property is required. string - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Routing This property is required. AppEngine Routing Response - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- headers
This property is required. Map<String,String> - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - http
Method This property is required. String - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- payload
This property is required. String - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- relative
Url This property is required. String - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Routing This property is required. AppEngine Routing Response - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- headers
This property is required. {[key: string]: string} - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - http
Method This property is required. string - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- payload
This property is required. string - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- relative
Url This property is required. string - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app_
engine_ routing This property is required. AppEngine Routing Response - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- headers
This property is required. Mapping[str, str] - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - http_
method This property is required. str - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- payload
This property is required. str - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- relative_
url This property is required. str - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Routing This property is required. Property Map - Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- headers
This property is required. Map<String> - HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: *
User-Agent
: By default, this header is"AppEngine-Google; (+http://code.google.com/appengine)"
. This header can be modified, but Cloud Tasks will append"AppEngine-Google; (+http://code.google.com/appengine)"
to the modifiedUser-Agent
. If the task has a payload, Cloud Tasks sets the following headers: *Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-Type
to a particular media type when the task is created. For example,Content-Type
can be set to"application/json"
. *Content-Length
: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: *Host
*X-Google-*
*X-AppEngine-*
In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation. - http
Method This property is required. String - The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
- payload
This property is required. String - Payload. The payload will be sent as the HTTP message body. A message body, and thus a payload, is allowed only if the HTTP method is POST or PUT. It is an error to set a data payload on a task with an incompatible HttpMethod.
- relative
Url This property is required. String - The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
AppEngineRoutingResponse
- Host
This property is required. string - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - Instance
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. string - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - Instance
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. String - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - instance
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. string - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - instance
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. str - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - instance
This property is required. 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
This property is required. 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
This property is required. 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
This property is required. String - The host that the task is sent to. For more information, see How Requests are Routed. The host is constructed as: *
host = [application_domain_name]
| [service] + '.' + [application_domain_name]
| [version] + '.' + [application_domain_name]
| [version_dot_service]+ '.' + [application_domain_name]
| [instance] + '.' + [application_domain_name]
| [instance_dot_service] + '.' + [application_domain_name]
| [instance_dot_version] + '.' + [application_domain_name]
| [instance_dot_version_dot_service] + '.' + [application_domain_name]
*application_domain_name
= The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. *service =
service *version =
version *version_dot_service =
version+ '.' +
service *instance =
instance *instance_dot_service =
instance+ '.' +
service *instance_dot_version =
instance+ '.' +
version *instance_dot_version_dot_service =
instance+ '.' +
version+ '.' +
service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted. - instance
This property is required. 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
This property is required. 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
This property is required. 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.
AttemptStatusResponse
- Dispatch
Time This property is required. string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - Response
Status This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. Inputs. Status Response - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- Response
Time This property is required. string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - Schedule
Time This property is required. string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- Dispatch
Time This property is required. string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - Response
Status This property is required. StatusResponse - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- Response
Time This property is required. string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - Schedule
Time This property is required. string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time This property is required. String - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status This property is required. StatusResponse - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- response
Time This property is required. String - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time This property is required. String - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time This property is required. string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status This property is required. StatusResponse - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- response
Time This property is required. string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time This property is required. string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch_
time This property is required. str - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response_
status This property is required. StatusResponse - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- response_
time This property is required. str - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule_
time This property is required. str - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time This property is required. String - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status This property is required. Property Map - The response from the target for this attempt. If the task has not been attempted or the task is currently running then the response status is unset.
- response
Time This property is required. String - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time This property is required. String - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
HttpRequestResponse
- Body
This property is required. string - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- Headers
This property is required. Dictionary<string, string> - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - Http
Method This property is required. string - The HTTP method to use for the request. The default is POST.
- Oauth
Token This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. Inputs. OAuth Token Response - If specified, an OAuth token will be generated and attached as an
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 This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. 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. - Url
This property is required. string - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
- Body
This property is required. string - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- Headers
This property is required. map[string]string - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - Http
Method This property is required. string - The HTTP method to use for the request. The default is POST.
- Oauth
Token This property is required. OAuthToken Response - If specified, an OAuth token will be generated and attached as an
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 This property is required. 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. - Url
This property is required. string - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
- body
This property is required. String - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- headers
This property is required. Map<String,String> - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - http
Method This property is required. String - The HTTP method to use for the request. The default is POST.
- oauth
Token This property is required. OAuthToken Response - If specified, an OAuth token will be generated and attached as an
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 This property is required. 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. - url
This property is required. String - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
- body
This property is required. string - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- headers
This property is required. {[key: string]: string} - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - http
Method This property is required. string - The HTTP method to use for the request. The default is POST.
- oauth
Token This property is required. OAuthToken Response - If specified, an OAuth token will be generated and attached as an
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 This property is required. 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. - url
This property is required. string - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
- body
This property is required. str - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- headers
This property is required. Mapping[str, str] - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - http_
method This property is required. str - The HTTP method to use for the request. The default is POST.
- oauth_
token This property is required. OAuthToken Response - If specified, an OAuth token will be generated and attached as an
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 This property is required. 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. - url
This property is required. str - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
- body
This property is required. String - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
- headers
This property is required. Map<String> - HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to
"Google-Cloud-Tasks"
. *X-Google-*
: Google use only. *X-AppEngine-*
: Google use only.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"
. 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. - http
Method This property is required. String - The HTTP method to use for the request. The default is POST.
- oauth
Token This property is required. Property Map - If specified, an OAuth token will be generated and attached as an
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 This property is required. 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. - url
This property is required. String - The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are:
http://acme.com
andhttps://acme.com/sales:8080
. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. TheLocation
header response from a redirect response [300
-399
] may be followed. The redirect is not counted as a separate attempt.
OAuthTokenResponse
- Scope
This property is required. 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 Email This property is required. string - 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
This property is required. 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 Email This property is required. string - 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
This property is required. 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 Email This property is required. String - 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
This property is required. 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 Email This property is required. string - 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
This property is required. 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_ email This property is required. str - 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
This property is required. 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 Email This property is required. String - 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
This property is required. string - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account Email This property is required. string - 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
This property is required. string - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account Email This property is required. string - 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
This property is required. String - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account Email This property is required. String - 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
This property is required. string - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account Email This property is required. string - 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
This property is required. str - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ email This property is required. str - 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
This property is required. String - Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account Email This property is required. String - 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.
PullMessageResponse
- Payload
This property is required. string - A data payload consumed by the worker to execute the task.
- Tag
This property is required. string - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
- Payload
This property is required. string - A data payload consumed by the worker to execute the task.
- Tag
This property is required. string - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
- payload
This property is required. String - A data payload consumed by the worker to execute the task.
- tag
This property is required. String - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
- payload
This property is required. string - A data payload consumed by the worker to execute the task.
- tag
This property is required. string - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
- payload
This property is required. str - A data payload consumed by the worker to execute the task.
- tag
This property is required. str - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
- payload
This property is required. String - A data payload consumed by the worker to execute the task.
- tag
This property is required. String - The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 characters. SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 encoded, the tag will be empty when the task is returned by Cloud Tasks.
StatusResponse
- Code
This property is required. int - The status code, which should be an enum value of google.rpc.Code.
- Details
This property is required. List<ImmutableDictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
This property is required. string - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code
This property is required. int - The status code, which should be an enum value of google.rpc.Code.
- Details
This property is required. []map[string]string - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message
This property is required. string - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
This property is required. Integer - The status code, which should be an enum value of google.rpc.Code.
- details
This property is required. List<Map<String,String>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
This property is required. String - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
This property is required. number - The status code, which should be an enum value of google.rpc.Code.
- details
This property is required. {[key: string]: string}[] - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
This property is required. string - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
This property is required. int - The status code, which should be an enum value of google.rpc.Code.
- details
This property is required. Sequence[Mapping[str, str]] - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
This property is required. str - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code
This property is required. Number - The status code, which should be an enum value of google.rpc.Code.
- details
This property is required. List<Map<String>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message
This property is required. String - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
TaskStatusResponse
- Attempt
Dispatch Count This property is required. int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- Attempt
Response Count This property is required. int - The number of attempts which have received a response. This field is not calculated for pull tasks.
- First
Attempt Status This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. Inputs. Attempt Status Response - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- Last
Attempt Status This property is required. Pulumi.Google Native. Cloud Tasks. V2Beta2. Inputs. Attempt Status Response - The status of the task's last attempt. This field is not calculated for pull tasks.
- Attempt
Dispatch Count This property is required. int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- Attempt
Response Count This property is required. int - The number of attempts which have received a response. This field is not calculated for pull tasks.
- First
Attempt Status This property is required. AttemptStatus Response - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- Last
Attempt Status This property is required. AttemptStatus Response - The status of the task's last attempt. This field is not calculated for pull tasks.
- attempt
Dispatch Count This property is required. Integer - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- attempt
Response Count This property is required. Integer - The number of attempts which have received a response. This field is not calculated for pull tasks.
- first
Attempt Status This property is required. AttemptStatus Response - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- last
Attempt Status This property is required. AttemptStatus Response - The status of the task's last attempt. This field is not calculated for pull tasks.
- attempt
Dispatch Count This property is required. number - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- attempt
Response Count This property is required. number - The number of attempts which have received a response. This field is not calculated for pull tasks.
- first
Attempt Status This property is required. AttemptStatus Response - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- last
Attempt Status This property is required. AttemptStatus Response - The status of the task's last attempt. This field is not calculated for pull tasks.
- attempt_
dispatch_ count This property is required. int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- attempt_
response_ count This property is required. int - The number of attempts which have received a response. This field is not calculated for pull tasks.
- first_
attempt_ status This property is required. AttemptStatus Response - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- last_
attempt_ status This property is required. AttemptStatus Response - The status of the task's last attempt. This field is not calculated for pull tasks.
- attempt
Dispatch Count This property is required. Number - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- attempt
Response Count This property is required. Number - The number of attempts which have received a response. This field is not calculated for pull tasks.
- first
Attempt Status This property is required. Property Map - The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
- last
Attempt Status This property is required. Property Map - The status of the task's last attempt. This field is not calculated for pull tasks.
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