TaskArgs

data class TaskArgs(val appEngineHttpRequest: Output<AppEngineHttpRequestArgs>? = 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. * For App Engine queues, the maximum task size is 100KB. * For pull queues, the maximum task size is 1MB.

Constructors

Link copied to clipboard
fun TaskArgs(appEngineHttpRequest: Output<AppEngineHttpRequestArgs>? = 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

App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.

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

LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set.

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. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. schedule_time will be truncated to the nearest microsecond.