TaskArgs

data class TaskArgs(val appEngineHttpRequest: Output<AppEngineHttpRequestArgs>? = null, val dispatchDeadline: Output<String>? = null, val httpRequest: Output<HttpRequestArgs>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val pullMessage: Output<PullMessageArgs>? = null, val queueId: Output<String>? = null, val responseView: Output<TaskResponseView>? = null, val scheduleTime: Output<String>? = null) : ConvertibleToJava<TaskArgs>

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.

Constructors

Link copied to clipboard
fun TaskArgs(appEngineHttpRequest: Output<AppEngineHttpRequestArgs>? = null, dispatchDeadline: Output<String>? = null, httpRequest: Output<HttpRequestArgs>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, pullMessage: Output<PullMessageArgs>? = null, queueId: Output<String>? = null, responseView: Output<TaskResponseView>? = null, scheduleTime: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TaskArgs

Properties

Link copied to clipboard

HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.

Link copied to clipboard
val dispatchDeadline: Output<String>? = null

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. dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

Link copied to clipboard
val httpRequest: Output<HttpRequestArgs>? = null

HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val pullMessage: Output<PullMessageArgs>? = null

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.

Link copied to clipboard
val queueId: Output<String>? = null
Link copied to clipboard
val responseView: Output<TaskResponseView>? = null

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.

Link copied to clipboard
val scheduleTime: Output<String>? = null

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.