Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudtasks
  5. cloudtasks/v2beta3
  6. Task

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudtasks/v2beta3.Task

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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)
public Task(String name, TaskArgs args)
public Task(String name, TaskArgs args, CustomResourceOptions options)

type: google-native:cloudtasks/v2beta3:Task
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
var exampletaskResourceResourceFromCloudtasksv2beta3 = new com.pulumi.googlenative.cloudtasks_v2beta3.Task("exampletaskResourceResourceFromCloudtasksv2beta3", com.pulumi.googlenative.cloudtasks_v2beta3.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());
Copy
exampletask_resource_resource_from_cloudtasksv2beta3 = google_native.cloudtasks.v2beta3.Task("exampletaskResourceResourceFromCloudtasksv2beta3",
    queue_id="string",
    app_engine_http_request={
        "app_engine_routing": {
            "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={
        "url": "string",
        "body": "string",
        "headers": {
            "string": "string",
        },
        "http_method": google_native.cloudtasks.v2beta3.HttpRequestHttpMethod.HTTP_METHOD_UNSPECIFIED,
        "oauth_token": {
            "scope": "string",
            "service_account_email": "string",
        },
        "oidc_token": {
            "audience": "string",
            "service_account_email": "string",
        },
    },
    location="string",
    name="string",
    project="string",
    pull_message={
        "payload": "string",
        "tag": "string",
    },
    response_view=google_native.cloudtasks.v2beta3.TaskResponseView.VIEW_UNSPECIFIED,
    schedule_time="string")
Copy
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",
});
Copy
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
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Task resource accepts the following input properties:

QueueId
This property is required.
Changes to this property will trigger replacement.
string
AppEngineHttpRequest Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.AppEngineHttpRequest
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
DispatchDeadline 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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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.
HttpRequest Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.HttpRequest
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
PullMessage Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.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.
ResponseView Pulumi.GoogleNative.CloudTasks.V2Beta3.TaskResponseView
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.
ScheduleTime 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.
QueueId
This property is required.
Changes to this property will trigger replacement.
string
AppEngineHttpRequest AppEngineHttpRequestArgs
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
DispatchDeadline 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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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.
HttpRequest HttpRequestArgs
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
PullMessage PullMessageArgs
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.
ResponseView TaskResponseView
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.
ScheduleTime 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.
queueId
This property is required.
Changes to this property will trigger replacement.
String
appEngineHttpRequest AppEngineHttpRequest
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
dispatchDeadline 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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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.
httpRequest HttpRequest
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
pullMessage 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.
responseView TaskResponseView
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.
scheduleTime 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.
queueId
This property is required.
Changes to this property will trigger replacement.
string
appEngineHttpRequest AppEngineHttpRequest
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
dispatchDeadline 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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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.
httpRequest HttpRequest
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
pullMessage 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.
responseView TaskResponseView
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.
scheduleTime 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
This property is required.
Changes to this property will trigger replacement.
str
app_engine_http_request AppEngineHttpRequestArgs
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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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 HttpRequestArgs
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
pull_message PullMessageArgs
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 TaskResponseView
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.
queueId
This property is required.
Changes to this property will trigger replacement.
String
appEngineHttpRequest Property Map
HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
dispatchDeadline 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's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_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 by s (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.
httpRequest Property Map
HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
pullMessage 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.
responseView "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.
scheduleTime 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:

CreateTime string
The time that the task was created. create_time will be truncated to the nearest second.
DispatchCount int
The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
FirstAttempt Pulumi.GoogleNative.CloudTasks.V2Beta3.Outputs.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.
LastAttempt Pulumi.GoogleNative.CloudTasks.V2Beta3.Outputs.AttemptResponse
The status of the task's last attempt.
ResponseCount int
The number of attempts which have received a response.
View string
The view specifies which subset of the Task has been returned.
CreateTime string
The time that the task was created. create_time will be truncated to the nearest second.
DispatchCount int
The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
FirstAttempt 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.
LastAttempt AttemptResponse
The status of the task's last attempt.
ResponseCount int
The number of attempts which have received a response.
View string
The view specifies which subset of the Task has been returned.
createTime String
The time that the task was created. create_time will be truncated to the nearest second.
dispatchCount Integer
The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
firstAttempt 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.
lastAttempt AttemptResponse
The status of the task's last attempt.
responseCount Integer
The number of attempts which have received a response.
view String
The view specifies which subset of the Task has been returned.
createTime string
The time that the task was created. create_time will be truncated to the nearest second.
dispatchCount number
The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
firstAttempt 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.
lastAttempt AttemptResponse
The status of the task's last attempt.
responseCount 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.
createTime String
The time that the task was created. create_time will be truncated to the nearest second.
dispatchCount Number
The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
firstAttempt 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.
lastAttempt Property Map
The status of the task's last attempt.
responseCount 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

AppEngineRouting Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.AppEngineRouting
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
HttpMethod Pulumi.GoogleNative.CloudTasks.V2Beta3.AppEngineHttpRequestHttpMethod
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.
RelativeUri 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 AppEngineRouting
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
HttpMethod AppEngineHttpRequestHttpMethod
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.
RelativeUri 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 AppEngineRouting
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod AppEngineHttpRequestHttpMethod
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.
relativeUri 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 AppEngineRouting
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod AppEngineHttpRequestHttpMethod
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.
relativeUri 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_routing AppEngineRouting
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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 AppEngineHttpRequestHttpMethod
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.
appEngineRouting Property Map
Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
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 modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod "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.
relativeUri 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

HttpMethodUnspecified
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
AppEngineHttpRequestHttpMethodHttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
AppEngineHttpRequestHttpMethodPost
POSTHTTP POST
AppEngineHttpRequestHttpMethodGet
GETHTTP GET
AppEngineHttpRequestHttpMethodHead
HEADHTTP HEAD
AppEngineHttpRequestHttpMethodPut
PUTHTTP PUT
AppEngineHttpRequestHttpMethodDelete
DELETEHTTP DELETE
AppEngineHttpRequestHttpMethodPatch
PATCHHTTP PATCH
AppEngineHttpRequestHttpMethodOptions
OPTIONSHTTP OPTIONS
HttpMethodUnspecified
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
HttpMethodUnspecified
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

AppEngineRouting This property is required. Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.AppEngineRoutingResponse
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 This property is required. 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 This property is required. Dictionary<string, string>
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
HttpMethod This property is required. string
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
RelativeUri This property is required. 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 This property is required. AppEngineRoutingResponse
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 This property is required. 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 This property is required. map[string]string
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
HttpMethod This property is required. string
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
RelativeUri This property is required. 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 This property is required. AppEngineRoutingResponse
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 This property is required. 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 This property is required. Map<String,String>
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod This property is required. String
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
relativeUri This property is required. 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 This property is required. AppEngineRoutingResponse
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 This property is required. 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 This property is required. {[key: string]: string}
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod This property is required. string
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
relativeUri This property is required. 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_routing This property is required. AppEngineRoutingResponse
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 This property is required. 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 This property is required. Mapping[str, str]
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-Type to a particular media type when the task is created. For example, Content-Type can be set to "application/json". * Content-Length: This is computed by Cloud Tasks. This value is output only. It cannot be changed. The headers below cannot be set or overridden: * Host * X-Google-* * X-AppEngine-* In addition, Cloud Tasks sets some headers when the task is dispatched, such as headers containing information about the task; see request headers. These headers are set only when the task is dispatched, so they are not visible when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the Task. For more information, see the CreateTask documentation.
http_method This property is required. str
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
relative_uri This property is required. 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.
appEngineRouting This property is required. Property Map
Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
body This property is required. 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 This property is required. Map<String>
HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can contain commas. Cloud Tasks sets some headers to default values: * User-Agent: By default, this header is "AppEngine-Google; (+http://code.google.com/appengine)". This header can be modified, but Cloud Tasks will append "AppEngine-Google; (+http://code.google.com/appengine)" to the modified User-Agent. If the task has a body, Cloud Tasks sets the following headers: * Content-Type: By default, the Content-Type header is set to "application/octet-stream". The default can be overridden by explicitly setting Content-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.
httpMethod This property is required. String
The HTTP method to use for the request. The default is POST. The app's request handler for the task's target URL must be able to handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See Writing a push task request handler and the App Engine documentation for your runtime on How Requests are Handled.
relativeUri This property is required. 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 This property is required. 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 This property is required. string
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
Service This property is required. string
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
Version This property is required. string
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
Host This property is required. string
The host that the task is sent to. 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 This property is required. string
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
Service This property is required. string
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
Version This property is required. string
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
host This property is required. String
The host that the task is sent to. 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 This property is required. String
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
service This property is required. String
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
version This property is required. String
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
host This property is required. string
The host that the task is sent to. 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 This property is required. string
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
service This property is required. string
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
version This property is required. string
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
host This property is required. str
The host that the task is sent to. 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 This property is required. str
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
service This property is required. str
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
version This property is required. str
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
host This property is required. String
The host that the task is sent to. 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 This property is required. String
App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if manual scaling is used in App Engine Standard. App Engine Flex does not support instances. For more information, see App Engine Standard request routing and App Engine Flex request routing.
service This property is required. String
App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
version This property is required. String
App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.

AttemptResponse
, AttemptResponseArgs

DispatchTime This property is required. string
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
ResponseStatus This property is required. Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.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 the response_status field is meaningless.
ResponseTime This property is required. string
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
ScheduleTime This property is required. string
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
DispatchTime This property is required. string
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
ResponseStatus This property is required. 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 the response_status field is meaningless.
ResponseTime This property is required. string
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
ScheduleTime This property is required. string
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
dispatchTime This property is required. String
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
responseStatus This property is required. 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 the response_status field is meaningless.
responseTime This property is required. String
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
scheduleTime This property is required. String
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
dispatchTime This property is required. string
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
responseStatus This property is required. 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 the response_status field is meaningless.
responseTime This property is required. string
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
scheduleTime This property is required. string
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
dispatch_time This property is required. str
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
response_status This property is required. StatusResponse
The response from the worker for this attempt. If response_time is unset, then the task has not been attempted or is currently running and the response_status field is meaningless.
response_time This property is required. str
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
schedule_time This property is required. str
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.
dispatchTime This property is required. String
The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.
responseStatus This property is required. 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 the response_status field is meaningless.
responseTime This property is required. String
The time that this attempt response was received. response_time will be truncated to the nearest microsecond.
scheduleTime This property is required. String
The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.

HttpRequest
, HttpRequestArgs

Url This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
HttpMethod Pulumi.GoogleNative.CloudTasks.V2Beta3.HttpRequestHttpMethod
The HTTP method to use for the request. The default is POST.
OauthToken Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.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.
OidcToken Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.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 This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
HttpMethod HttpRequestHttpMethod
The HTTP method to use for the request. The default is POST.
OauthToken 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.
OidcToken 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 This property is required. String
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod HttpRequestHttpMethod
The HTTP method to use for the request. The default is POST.
oauthToken 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.
oidcToken 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 This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod HttpRequestHttpMethod
The HTTP method to use for the request. The default is POST.
oauthToken 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.
oidcToken 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 This property is required. str
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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 HttpRequestHttpMethod
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 This property is required. String
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod "HTTP_METHOD_UNSPECIFIED" | "POST" | "GET" | "HEAD" | "PUT" | "DELETE" | "PATCH" | "OPTIONS"
The HTTP method to use for the request. The default is POST.
oauthToken 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.
oidcToken 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

HttpMethodUnspecified
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
HttpRequestHttpMethodHttpMethodUnspecified
HTTP_METHOD_UNSPECIFIEDHTTP method unspecified
HttpRequestHttpMethodPost
POSTHTTP POST
HttpRequestHttpMethodGet
GETHTTP GET
HttpRequestHttpMethodHead
HEADHTTP HEAD
HttpRequestHttpMethodPut
PUTHTTP PUT
HttpRequestHttpMethodDelete
DELETEHTTP DELETE
HttpRequestHttpMethodPatch
PATCHHTTP PATCH
HttpRequestHttpMethodOptions
OPTIONSHTTP OPTIONS
HttpMethodUnspecified
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
HttpMethodUnspecified
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 This property is required. string
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
Headers This property is required. Dictionary<string, string>
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
HttpMethod This property is required. string
The HTTP method to use for the request. The default is POST.
OauthToken This property is required. Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.OAuthTokenResponse
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.
OidcToken This property is required. Pulumi.GoogleNative.CloudTasks.V2Beta3.Inputs.OidcTokenResponse
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
Url This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.
Body This property is required. string
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
Headers This property is required. map[string]string
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
HttpMethod This property is required. string
The HTTP method to use for the request. The default is POST.
OauthToken This property is required. OAuthTokenResponse
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.
OidcToken This property is required. OidcTokenResponse
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
Url This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.
body This property is required. String
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
headers This property is required. Map<String,String>
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod This property is required. String
The HTTP method to use for the request. The default is POST.
oauthToken This property is required. OAuthTokenResponse
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.
oidcToken This property is required. OidcTokenResponse
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
url This property is required. String
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.
body This property is required. string
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
headers This property is required. {[key: string]: string}
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod This property is required. string
The HTTP method to use for the request. The default is POST.
oauthToken This property is required. OAuthTokenResponse
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.
oidcToken This property is required. OidcTokenResponse
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
url This property is required. string
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.
body This property is required. str
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
headers This property is required. Mapping[str, str]
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
http_method This property is required. str
The HTTP method to use for the request. The default is POST.
oauth_token This property is required. OAuthTokenResponse
If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
oidc_token This property is required. OidcTokenResponse
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
url This property is required. str
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location header response from a redirect response [300 - 399] may be followed. The redirect is not counted as a separate attempt.
body This property is required. String
HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.
headers This property is required. Map<String>
HTTP request headers. This map contains the header field names and values. Headers can be set when 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 set Content-Type to a media type when the task is created. For example, Content-Type can be set to "application/octet-stream" or "application/json". 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.
httpMethod This property is required. String
The HTTP method to use for the request. The default is POST.
oauthToken This property is required. Property Map
If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
oidcToken This property is required. Property Map
If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
url This property is required. String
The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: http://acme.com and https://acme.com/sales:8080. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The Location 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.
ServiceAccountEmail string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
Scope string
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
ServiceAccountEmail string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope String
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail String
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope string
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope str
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
service_account_email str
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope String
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail String
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

OAuthTokenResponse
, OAuthTokenResponseArgs

Scope This property is required. string
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
ServiceAccountEmail This property is required. string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
Scope This property is required. string
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
ServiceAccountEmail This property is required. string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope This property is required. String
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail This property is required. String
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope This property is required. string
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail This property is required. string
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope This property is required. str
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
service_account_email This property is required. str
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
scope This property is required. String
OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
serviceAccountEmail This property is required. String
Service account email to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

OidcToken
, OidcTokenArgs

Audience string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
ServiceAccountEmail string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
Audience string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
ServiceAccountEmail string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience String
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail String
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience str
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
service_account_email str
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience String
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail String
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

OidcTokenResponse
, OidcTokenResponseArgs

Audience This property is required. string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
ServiceAccountEmail This property is required. string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
Audience This property is required. string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
ServiceAccountEmail This property is required. string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience This property is required. String
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail This property is required. String
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience This property is required. string
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail This property is required. string
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience This property is required. str
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
service_account_email This property is required. str
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.
audience This property is required. String
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
serviceAccountEmail This property is required. String
Service account email to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.

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 This property is required. string
A data payload consumed by the worker to execute the task.
Tag This property is required. 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 This property is required. string
A data payload consumed by the worker to execute the task.
Tag This property is required. 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 This property is required. String
A data payload consumed by the worker to execute the task.
tag This property is required. 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 This property is required. string
A data payload consumed by the worker to execute the task.
tag This property is required. 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 This property is required. str
A data payload consumed by the worker to execute the task.
tag This property is required. 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 This property is required. String
A data payload consumed by the worker to execute the task.
tag This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. List<ImmutableDictionary<string, string>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []map[string]string
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String,String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[key: string]: string}[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. string
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. Sequence[Mapping[str, str]]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. str
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
code This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. List<Map<String>>
A list of messages that carry the error details. There is a common set of message types for APIs to use.
message This property is required. String
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TaskResponseView
, TaskResponseViewArgs

ViewUnspecified
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.
TaskResponseViewViewUnspecified
VIEW_UNSPECIFIEDUnspecified. Defaults to BASIC.
TaskResponseViewBasic
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.
TaskResponseViewFull
FULLAll information is returned. Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Queue resource.
ViewUnspecified
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.
ViewUnspecified
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.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native