Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.cloudtasks/v2.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/v2:getTask
arguments:
# arguments dictionary
The following arguments are supported:
- Location string
- Queue
Id string - Task
Id string - Project string
- Response
View string
- Location string
- Queue
Id string - Task
Id string - Project string
- Response
View string
- location String
- queue
Id String - task
Id String - project String
- response
View String
- location string
- queue
Id string - task
Id string - project string
- response
View string
- location str
- queue_
id str - task_
id str - project str
- response_
view str
- location String
- queue
Id String - task
Id String - project String
- response
View String
getTask Result
The following output properties are available:
- App
Engine Pulumi.Http Request Google Native. Cloud Tasks. V2. Outputs. App Engine Http Request Response - HTTP request that is sent to the App Engine app handler. 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. - Dispatch
Count int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- Dispatch
Deadline string - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - First
Attempt Pulumi.Google Native. Cloud Tasks. V2. Outputs. Attempt Response - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- Http
Request Pulumi.Google Native. Cloud Tasks. V2. Outputs. Http Request Response - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- Last
Attempt Pulumi.Google Native. Cloud Tasks. V2. Outputs. Attempt Response - The status of the task's last attempt.
- 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. - Response
Count int - The number of attempts which have received a response.
- Schedule
Time string - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - View string
- The view specifies which subset of the Task has been returned.
- App
Engine AppHttp Request Engine Http Request Response - HTTP request that is sent to the App Engine app handler. 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. - Dispatch
Count int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- Dispatch
Deadline string - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - First
Attempt AttemptResponse - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- Http
Request HttpRequest Response - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- Last
Attempt AttemptResponse - The status of the task's last attempt.
- 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. - Response
Count int - The number of attempts which have received a response.
- Schedule
Time string - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - View string
- The view specifies which subset of the Task has been returned.
- app
Engine AppHttp Request Engine Http Request Response - HTTP request that is sent to the App Engine app handler. 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. - dispatch
Count Integer - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- dispatch
Deadline String - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - first
Attempt AttemptResponse - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- http
Request HttpRequest Response - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- last
Attempt AttemptResponse - The status of the task's last attempt.
- 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. - response
Count Integer - The number of attempts which have received a response.
- schedule
Time String - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - view String
- The view specifies which subset of the Task has been returned.
- app
Engine AppHttp Request Engine Http Request Response - HTTP request that is sent to the App Engine app handler. 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. - dispatch
Count number - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- dispatch
Deadline string - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - first
Attempt AttemptResponse - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- http
Request HttpRequest Response - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- last
Attempt AttemptResponse - The status of the task's last attempt.
- 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. - response
Count number - The number of attempts which have received a response.
- schedule
Time string - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - view string
- The view specifies which subset of the Task has been returned.
- app_
engine_ Apphttp_ request Engine Http Request Response - HTTP request that is sent to the App Engine app handler. 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. - dispatch_
count int - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- dispatch_
deadline str - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - first_
attempt AttemptResponse - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- http_
request HttpRequest Response - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- last_
attempt AttemptResponse - The status of the task's last attempt.
- 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. - response_
count int - The number of attempts which have received a response.
- schedule_
time str - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - view str
- The view specifies which subset of the Task has been returned.
- app
Engine Property MapHttp Request - HTTP request that is sent to the App Engine app handler. 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. - dispatch
Count Number - The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
- dispatch
Deadline String - The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED
failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task'sdispatch_deadline
, the app handler will not run for longer than than the service's timeout. We recommend setting thedispatch_deadline
to at most a few seconds more than the app handler's timeout. For more information see Timeouts. The value must be given as a string that indicates the length of time (in seconds) followed bys
(for "seconds"). For more information on the format, see the documentation for Duration.dispatch_deadline
will be truncated to the nearest millisecond. The deadline is an approximate deadline. - first
Attempt Property Map - The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
- http
Request Property Map - HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.
- last
Attempt Property Map - The status of the task's last attempt.
- 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. - response
Count Number - The number of attempts which have received a response.
- schedule
Time String - The time when the task is scheduled to be attempted or retried.
schedule_time
will be truncated to the nearest microsecond. - view String
- The view specifies which subset of the Task has been returned.
Supporting Types
AppEngineHttpRequestResponse
- App
Engine Pulumi.Routing Google Native. Cloud Tasks. V2. Inputs. App Engine Routing Response - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- Headers 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 body, 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 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.
- Relative
Uri string - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- App
Engine AppRouting Engine Routing Response - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- Body string
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- Headers 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 body, 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 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.
- Relative
Uri string - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing Response - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- body String
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- headers 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 body, 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 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.
- relative
Uri String - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine AppRouting Engine Routing Response - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- body string
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- headers {[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 body, 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 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.
- relative
Uri string - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app_
engine_ Approuting Engine Routing Response - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- body str
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- headers 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 body, 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 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.
- relative_
uri str - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
- app
Engine Property MapRouting - Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
- body String
- HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod.
- headers 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 body, 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 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.
- relative
Uri String - The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
AppEngineRoutingResponse
- Host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- Instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- Service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- Version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host String
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host string
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance string
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service string
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version string
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host str
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance str
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service str
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version str
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- host String
- The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see How Requests are Routed.
- instance String
- App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
- service String
- App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
- version String
- App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
AttemptResponse
- Dispatch
Time string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - Response
Status Pulumi.Google Native. Cloud Tasks. V2. Inputs. Status Response - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - Response
Time string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - Schedule
Time string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- Dispatch
Time string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - Response
Status StatusResponse - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - Response
Time string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - Schedule
Time string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time String - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status StatusResponse - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - response
Time String - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time String - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time string - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status StatusResponse - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - response
Time string - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time string - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch_
time str - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response_
status StatusResponse - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - response_
time str - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule_
time str - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
- dispatch
Time String - The time that this attempt was dispatched.
dispatch_time
will be truncated to the nearest microsecond. - response
Status Property Map - The response from the worker for this attempt. If
response_time
is unset, then the task has not been attempted or is currently running and theresponse_status
field is meaningless. - response
Time String - The time that this attempt response was received.
response_time
will be truncated to the nearest microsecond. - schedule
Time String - The time that this attempt was scheduled.
schedule_time
will be truncated to the nearest microsecond.
HttpRequestResponse
- Body 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 Dictionary<string, string>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 string - The HTTP method to use for the request. The default is POST.
- Oauth
Token Pulumi.Google Native. Cloud Tasks. V2. 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 Pulumi.Google Native. Cloud Tasks. V2. Inputs. Oidc Token Response - If specified, an OIDC token will be generated and attached as an
Authorization
header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. - Url 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 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 map[string]string
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 string - The HTTP method to use for the request. The default is POST.
- Oauth
Token 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 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 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 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 Map<String,String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 String - The HTTP method to use for the request. The default is POST.
- oauth
Token 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 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 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 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 {[key: string]: string}
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 string - The HTTP method to use for the request. The default is POST.
- oauth
Token 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 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 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 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 Mapping[str, str]
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 str - The HTTP method to use for the request. The default is POST.
- oauth_
token 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 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 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 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 Map<String>
- HTTP request headers. This map contains the header field names and values. Headers can be set when the 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: * 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 String - The HTTP method to use for the request. The default is POST.
- oauth
Token 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 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 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 string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- Service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope string
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account stringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope str
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service_
account_ stremail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- scope String
- OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
- service
Account StringEmail - Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
OidcTokenResponse
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- Audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- Service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience string
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account stringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience str
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service_
account_ stremail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
- audience String
- Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
- service
Account StringEmail - Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
StatusResponse
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message 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 int
- The status code, which should be an enum value of google.rpc.Code.
- Details []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 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 Integer
- The status code, which should be an enum value of google.rpc.Code.
- details 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 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 number
- The status code, which should be an enum value of google.rpc.Code.
- details {[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 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 int
- The status code, which should be an enum value of google.rpc.Code.
- details 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 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 Number
- The status code, which should be an enum value of google.rpc.Code.
- details 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 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.
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