Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.cloudtasks/v2beta3.Task
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB.
Create Task Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Task(name: string, args: TaskArgs, opts?: CustomResourceOptions);
@overload
def Task(resource_name: str,
args: TaskArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Task(resource_name: str,
opts: Optional[ResourceOptions] = None,
queue_id: Optional[str] = None,
app_engine_http_request: Optional[AppEngineHttpRequestArgs] = None,
dispatch_deadline: Optional[str] = None,
http_request: Optional[HttpRequestArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
pull_message: Optional[PullMessageArgs] = None,
response_view: Optional[TaskResponseView] = None,
schedule_time: Optional[str] = None)
func NewTask(ctx *Context, name string, args TaskArgs, opts ...ResourceOption) (*Task, error)
public Task(string name, TaskArgs args, CustomResourceOptions? opts = null)
type: google-native:cloudtasks/v2beta3:Task
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TaskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TaskArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TaskArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TaskArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TaskArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampletaskResourceResourceFromCloudtasksv2beta3 = new GoogleNative.CloudTasks.V2Beta3.Task("exampletaskResourceResourceFromCloudtasksv2beta3", new()
{
QueueId = "string",
AppEngineHttpRequest = new GoogleNative.CloudTasks.V2Beta3.Inputs.AppEngineHttpRequestArgs
{
AppEngineRouting = new GoogleNative.CloudTasks.V2Beta3.Inputs.AppEngineRoutingArgs
{
Instance = "string",
Service = "string",
Version = "string",
},
Body = "string",
Headers =
{
{ "string", "string" },
},
HttpMethod = GoogleNative.CloudTasks.V2Beta3.AppEngineHttpRequestHttpMethod.HttpMethodUnspecified,
RelativeUri = "string",
},
DispatchDeadline = "string",
HttpRequest = new GoogleNative.CloudTasks.V2Beta3.Inputs.HttpRequestArgs
{
Url = "string",
Body = "string",
Headers =
{
{ "string", "string" },
},
HttpMethod = GoogleNative.CloudTasks.V2Beta3.HttpRequestHttpMethod.HttpMethodUnspecified,
OauthToken = new GoogleNative.CloudTasks.V2Beta3.Inputs.OAuthTokenArgs
{
Scope = "string",
ServiceAccountEmail = "string",
},
OidcToken = new GoogleNative.CloudTasks.V2Beta3.Inputs.OidcTokenArgs
{
Audience = "string",
ServiceAccountEmail = "string",
},
},
Location = "string",
Name = "string",
Project = "string",
PullMessage = new GoogleNative.CloudTasks.V2Beta3.Inputs.PullMessageArgs
{
Payload = "string",
Tag = "string",
},
ResponseView = GoogleNative.CloudTasks.V2Beta3.TaskResponseView.ViewUnspecified,
ScheduleTime = "string",
});
example, err := cloudtasksv2beta3.NewTask(ctx, "exampletaskResourceResourceFromCloudtasksv2beta3", &cloudtasksv2beta3.TaskArgs{
QueueId: pulumi.String("string"),
AppEngineHttpRequest: &cloudtasks.AppEngineHttpRequestArgs{
AppEngineRouting: &cloudtasks.AppEngineRoutingArgs{
Instance: pulumi.String("string"),
Service: pulumi.String("string"),
Version: pulumi.String("string"),
},
Body: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpMethod: cloudtasksv2beta3.AppEngineHttpRequestHttpMethodHttpMethodUnspecified,
RelativeUri: pulumi.String("string"),
},
DispatchDeadline: pulumi.String("string"),
HttpRequest: &cloudtasks.HttpRequestArgs{
Url: pulumi.String("string"),
Body: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
HttpMethod: cloudtasksv2beta3.HttpRequestHttpMethodHttpMethodUnspecified,
OauthToken: &cloudtasks.OAuthTokenArgs{
Scope: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
OidcToken: &cloudtasks.OidcTokenArgs{
Audience: pulumi.String("string"),
ServiceAccountEmail: pulumi.String("string"),
},
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
PullMessage: &cloudtasks.PullMessageArgs{
Payload: pulumi.String("string"),
Tag: pulumi.String("string"),
},
ResponseView: cloudtasksv2beta3.TaskResponseViewViewUnspecified,
ScheduleTime: pulumi.String("string"),
})
var exampletaskResourceResourceFromCloudtasksv2beta3 = new Task("exampletaskResourceResourceFromCloudtasksv2beta3", TaskArgs.builder()
.queueId("string")
.appEngineHttpRequest(AppEngineHttpRequestArgs.builder()
.appEngineRouting(AppEngineRoutingArgs.builder()
.instance("string")
.service("string")
.version("string")
.build())
.body("string")
.headers(Map.of("string", "string"))
.httpMethod("HTTP_METHOD_UNSPECIFIED")
.relativeUri("string")
.build())
.dispatchDeadline("string")
.httpRequest(HttpRequestArgs.builder()
.url("string")
.body("string")
.headers(Map.of("string", "string"))
.httpMethod("HTTP_METHOD_UNSPECIFIED")
.oauthToken(OAuthTokenArgs.builder()
.scope("string")
.serviceAccountEmail("string")
.build())
.oidcToken(OidcTokenArgs.builder()
.audience("string")
.serviceAccountEmail("string")
.build())
.build())
.location("string")
.name("string")
.project("string")
.pullMessage(PullMessageArgs.builder()
.payload("string")
.tag("string")
.build())
.responseView("VIEW_UNSPECIFIED")
.scheduleTime("string")
.build());
exampletask_resource_resource_from_cloudtasksv2beta3 = google_native.cloudtasks.v2beta3.Task("exampletaskResourceResourceFromCloudtasksv2beta3",
queue_id="string",
app_engine_http_request=google_native.cloudtasks.v2beta3.AppEngineHttpRequestArgs(
app_engine_routing=google_native.cloudtasks.v2beta3.AppEngineRoutingArgs(
instance="string",
service="string",
version="string",
),
body="string",
headers={
"string": "string",
},
http_method=google_native.cloudtasks.v2beta3.AppEngineHttpRequestHttpMethod.HTTP_METHOD_UNSPECIFIED,
relative_uri="string",
),
dispatch_deadline="string",
http_request=google_native.cloudtasks.v2beta3.HttpRequestArgs(
url="string",
body="string",
headers={
"string": "string",
},
http_method=google_native.cloudtasks.v2beta3.HttpRequestHttpMethod.HTTP_METHOD_UNSPECIFIED,
oauth_token=google_native.cloudtasks.v2beta3.OAuthTokenArgs(
scope="string",
service_account_email="string",
),
oidc_token=google_native.cloudtasks.v2beta3.OidcTokenArgs(
audience="string",
service_account_email="string",
),
),
location="string",
name="string",
project="string",
pull_message=google_native.cloudtasks.v2beta3.PullMessageArgs(
payload="string",
tag="string",
),
response_view=google_native.cloudtasks.v2beta3.TaskResponseView.VIEW_UNSPECIFIED,
schedule_time="string")
const exampletaskResourceResourceFromCloudtasksv2beta3 = new google_native.cloudtasks.v2beta3.Task("exampletaskResourceResourceFromCloudtasksv2beta3", {
queueId: "string",
appEngineHttpRequest: {
appEngineRouting: {
instance: "string",
service: "string",
version: "string",
},
body: "string",
headers: {
string: "string",
},
httpMethod: google_native.cloudtasks.v2beta3.AppEngineHttpRequestHttpMethod.HttpMethodUnspecified,
relativeUri: "string",
},
dispatchDeadline: "string",
httpRequest: {
url: "string",
body: "string",
headers: {
string: "string",
},
httpMethod: google_native.cloudtasks.v2beta3.HttpRequestHttpMethod.HttpMethodUnspecified,
oauthToken: {
scope: "string",
serviceAccountEmail: "string",
},
oidcToken: {
audience: "string",
serviceAccountEmail: "string",
},
},
location: "string",
name: "string",
project: "string",
pullMessage: {
payload: "string",
tag: "string",
},
responseView: google_native.cloudtasks.v2beta3.TaskResponseView.ViewUnspecified,
scheduleTime: "string",
});
type: google-native:cloudtasks/v2beta3:Task
properties:
appEngineHttpRequest:
appEngineRouting:
instance: string
service: string
version: string
body: string
headers:
string: string
httpMethod: HTTP_METHOD_UNSPECIFIED
relativeUri: string
dispatchDeadline: string
httpRequest:
body: string
headers:
string: string
httpMethod: HTTP_METHOD_UNSPECIFIED
oauthToken:
scope: string
serviceAccountEmail: string
oidcToken:
audience: string
serviceAccountEmail: string
url: string
location: string
name: string
project: string
pullMessage:
payload: string
tag: string
queueId: string
responseView: VIEW_UNSPECIFIED
scheduleTime: string
Task Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Task resource accepts the following input properties:
- Queue
Id string - App
Engine Pulumi.Http Request Google Native. Cloud Tasks. V2Beta3. Inputs. App Engine Http Request - HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
- 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. - Http
Request Pulumi.Google Native. Cloud Tasks. V2Beta3. Inputs. Http Request - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- Location string
- 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. - Project string
- Pull
Message Pulumi.Google Native. Cloud Tasks. V2Beta3. Inputs. Pull Message - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- Response
View Pulumi.Google Native. Cloud Tasks. V2Beta3. Task Response View - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
- Queue
Id string - App
Engine AppHttp Request Engine Http Request Args - HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
- 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. - Http
Request HttpRequest Args - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- Location string
- 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. - Project string
- Pull
Message PullMessage Args - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- Response
View TaskResponse View - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
- queue
Id String - app
Engine AppHttp Request Engine Http Request - HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
- 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. - http
Request HttpRequest - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- location String
- 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. - project String
- pull
Message PullMessage - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- response
View TaskResponse View - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
- queue
Id string - app
Engine AppHttp Request Engine Http Request - HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
- 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. - http
Request HttpRequest - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- location string
- 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. - project string
- pull
Message PullMessage - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- response
View TaskResponse View - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
- queue_
id str - app_
engine_ Apphttp_ request Engine Http Request Args - HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
- 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. - http_
request HttpRequest Args - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- location str
- 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. - project str
- pull_
message PullMessage Args - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- response_
view TaskResponse View - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
- queue
Id String - 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.
- 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. - http
Request Property Map - HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
- location String
- 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. - project String
- pull
Message Property Map - Pull Message contained in a task in a PULL queue type. This payload type cannot be explicitly set through Cloud Tasks API. Its purpose, currently is to provide backward compatibility with App Engine Task Queue pull queues to provide a way to inspect contents of pull tasks through the CloudTasks.GetTask.
- response
View "VIEW_UNSPECIFIED" | "BASIC" | "FULL" - The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Task resource. - 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.
schedule_time
will be truncated to the nearest microsecond.
Outputs
All input properties are implicitly available as output properties. Additionally, the Task resource produces the following output properties:
- 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.
- First
Attempt Pulumi.Google Native. Cloud Tasks. V2Beta3. 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Attempt Pulumi.Google Native. Cloud Tasks. V2Beta3. Outputs. Attempt Response - The status of the task's last attempt.
- Response
Count int - The number of attempts which have received a response.
- View string
- The view specifies which subset of the Task has been returned.
- 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.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Attempt AttemptResponse - The status of the task's last attempt.
- Response
Count int - The number of attempts which have received a response.
- View string
- The view specifies which subset of the Task has been returned.
- 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.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Attempt AttemptResponse - The status of the task's last attempt.
- response
Count Integer - The number of attempts which have received a response.
- view String
- The view specifies which subset of the Task has been returned.
- 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.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Attempt AttemptResponse - The status of the task's last attempt.
- response
Count number - The number of attempts which have received a response.
- view string
- The view specifies which subset of the Task has been returned.
- 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.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
attempt AttemptResponse - The status of the task's last attempt.
- response_
count int - The number of attempts which have received a response.
- view str
- The view specifies which subset of the Task has been returned.
- 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.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Attempt Property Map - The status of the task's last attempt.
- response
Count Number - The number of attempts which have received a response.
- view String
- The view specifies which subset of the Task has been returned.
Supporting Types
AppEngineHttpRequest, AppEngineHttpRequestArgs
- App
Engine Pulumi.Routing Google Native. Cloud Tasks. V2Beta3. Inputs. App Engine Routing - 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.
- 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 Pulumi.Google Native. Cloud Tasks. V2Beta3. App Engine Http Request Http Method - 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 - 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.
- 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 AppEngine Http Request Http Method - 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 - 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.
- 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 AppEngine Http Request Http Method - 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 - 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.
- 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 AppEngine Http Request Http Method - 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 - 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.
- 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 AppEngine Http Request Http Method - 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 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.
- 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 "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" - 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.
AppEngineHttpRequestHttpMethod, AppEngineHttpRequestHttpMethodArgs
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- App
Engine Http Request Http Method Http Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- App
Engine Http Request Http Method Post - POSTHTTP POST
- App
Engine Http Request Http Method Get - GETHTTP GET
- App
Engine Http Request Http Method Head - HEADHTTP HEAD
- App
Engine Http Request Http Method Put - PUTHTTP PUT
- App
Engine Http Request Http Method Delete - DELETEHTTP DELETE
- App
Engine Http Request Http Method Patch - PATCHHTTP PATCH
- App
Engine Http Request Http Method Options - OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- HTTP_METHOD_UNSPECIFIED
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- POST
- POSTHTTP POST
- GET
- GETHTTP GET
- HEAD
- HEADHTTP HEAD
- PUT
- PUTHTTP PUT
- DELETE
- DELETEHTTP DELETE
- PATCH
- PATCHHTTP PATCH
- OPTIONS
- OPTIONSHTTP OPTIONS
- "HTTP_METHOD_UNSPECIFIED"
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- "POST"
- POSTHTTP POST
- "GET"
- GETHTTP GET
- "HEAD"
- HEADHTTP HEAD
- "PUT"
- PUTHTTP PUT
- "DELETE"
- DELETEHTTP DELETE
- "PATCH"
- PATCHHTTP PATCH
- "OPTIONS"
- OPTIONSHTTP OPTIONS
AppEngineHttpRequestResponse, AppEngineHttpRequestResponseArgs
- App
Engine Pulumi.Routing Google Native. Cloud Tasks. V2Beta3. 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.
- 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 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.
- 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 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.
- 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 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.
- 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 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.
- 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 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.
- 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.
AppEngineRouting, AppEngineRoutingArgs
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
AppEngineRoutingResponse, AppEngineRoutingResponseArgs
- 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, AttemptResponseArgs
- 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. V2Beta3. 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.
HttpRequest, HttpRequestArgs
- 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 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: * 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 Pulumi.Google Native. Cloud Tasks. V2Beta3. Http Request Http Method - The HTTP method to use for the request. The default is POST.
- Oauth
Token Pulumi.Google Native. Cloud Tasks. V2Beta3. Inputs. OAuth Token - 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. V2Beta3. Inputs. Oidc Token - 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: * 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 HttpRequest Http Method - The HTTP method to use for the request. The default is POST.
- Oauth
Token OAuthToken - 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 - 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: * 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 HttpRequest Http Method - The HTTP method to use for the request. The default is POST.
- oauth
Token OAuthToken - 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 - 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: * 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 HttpRequest Http Method - The HTTP method to use for the request. The default is POST.
- oauth
Token OAuthToken - 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 - 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 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: * 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 HttpRequest Http Method - The HTTP method to use for the request. The default is POST.
- oauth_
token OAuthToken - 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 - 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>
- 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: * 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 "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS" - 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.
HttpRequestHttpMethod, HttpRequestHttpMethodArgs
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Request Http Method Http Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Http
Request Http Method Post - POSTHTTP POST
- Http
Request Http Method Get - GETHTTP GET
- Http
Request Http Method Head - HEADHTTP HEAD
- Http
Request Http Method Put - PUTHTTP PUT
- Http
Request Http Method Delete - DELETEHTTP DELETE
- Http
Request Http Method Patch - PATCHHTTP PATCH
- Http
Request Http Method Options - OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- Http
Method Unspecified - HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- Post
- POSTHTTP POST
- Get
- GETHTTP GET
- Head
- HEADHTTP HEAD
- Put
- PUTHTTP PUT
- Delete
- DELETEHTTP DELETE
- Patch
- PATCHHTTP PATCH
- Options
- OPTIONSHTTP OPTIONS
- HTTP_METHOD_UNSPECIFIED
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- POST
- POSTHTTP POST
- GET
- GETHTTP GET
- HEAD
- HEADHTTP HEAD
- PUT
- PUTHTTP PUT
- DELETE
- DELETEHTTP DELETE
- PATCH
- PATCHHTTP PATCH
- OPTIONS
- OPTIONSHTTP OPTIONS
- "HTTP_METHOD_UNSPECIFIED"
- HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
- "POST"
- POSTHTTP POST
- "GET"
- GETHTTP GET
- "HEAD"
- HEADHTTP HEAD
- "PUT"
- PUTHTTP PUT
- "DELETE"
- DELETEHTTP DELETE
- "PATCH"
- PATCHHTTP PATCH
- "OPTIONS"
- OPTIONSHTTP OPTIONS
HttpRequestResponse, HttpRequestResponseArgs
- 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: * 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 string - The HTTP method to use for the request. The default is POST.
- Oauth
Token Pulumi.Google Native. Cloud Tasks. V2Beta3. 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. V2Beta3. 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: * 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 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: * 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 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: * 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 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: * 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 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: * 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 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.
OAuthToken, OAuthTokenArgs
- 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.
OAuthTokenResponse, OAuthTokenResponseArgs
- 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.
OidcToken, OidcTokenArgs
- 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.
OidcTokenResponse, OidcTokenResponseArgs
- 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.
PullMessage, PullMessageArgs
- Payload string
- A data payload consumed by the worker to execute the task.
- Tag string
- The tasks's tag. The tag is 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 string
- A data payload consumed by the worker to execute the task.
- Tag string
- The tasks's tag. The tag is 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 String
- A data payload consumed by the worker to execute the task.
- tag String
- The tasks's tag. The tag is 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 string
- A data payload consumed by the worker to execute the task.
- tag string
- The tasks's tag. The tag is 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 str
- A data payload consumed by the worker to execute the task.
- tag str
- The tasks's tag. The tag is 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 String
- A data payload consumed by the worker to execute the task.
- tag String
- The tasks's tag. The tag is 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.
PullMessageResponse, PullMessageResponseArgs
- Payload string
- A data payload consumed by the worker to execute the task.
- Tag string
- The tasks's tag. The tag is 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 string
- A data payload consumed by the worker to execute the task.
- Tag string
- The tasks's tag. The tag is 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 String
- A data payload consumed by the worker to execute the task.
- tag String
- The tasks's tag. The tag is 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 string
- A data payload consumed by the worker to execute the task.
- tag string
- The tasks's tag. The tag is 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 str
- A data payload consumed by the worker to execute the task.
- tag str
- The tasks's tag. The tag is 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 String
- A data payload consumed by the worker to execute the task.
- tag String
- The tasks's tag. The tag is 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, StatusResponseArgs
- 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.
TaskResponseView, TaskResponseViewArgs
- View
Unspecified - VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- Basic
- BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- Full
- FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
- Task
Response View View Unspecified - VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- Task
Response View Basic - BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- Task
Response View Full - FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
- View
Unspecified - VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- Basic
- BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- Full
- FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
- View
Unspecified - VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- Basic
- BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- Full
- FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
- VIEW_UNSPECIFIED
- VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- BASIC
- BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- FULL
- FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
- "VIEW_UNSPECIFIED"
- VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
- "BASIC"
- BASICThe basic view omits fields which can be large or can contain sensitive data. This view does not include the body in AppEngineHttpRequest. Bodies are desirable to return only when needed, because they can be large and because of the sensitivity of the data that you choose to store in it.
- "FULL"
- FULLAll information is returned. Authorization for FULL requires
cloudtasks.tasks.fullView
Google IAM permission on the Queue resource.
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.