JobArgs

data class JobArgs(val appEngineHttpTarget: Output<AppEngineHttpTargetArgs>? = null, val attemptDeadline: Output<String>? = null, val description: Output<String>? = null, val httpTarget: Output<HttpTargetArgs>? = null, val legacyAppEngineCron: Output<Boolean>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val pubsubTarget: Output<PubsubTargetArgs>? = null, val retryConfig: Output<RetryConfigArgs>? = null, val schedule: Output<String>? = null, val timeZone: Output<String>? = null) : ConvertibleToJava<JobArgs>

Creates a job.

Constructors

Link copied to clipboard
fun JobArgs(appEngineHttpTarget: Output<AppEngineHttpTargetArgs>? = null, attemptDeadline: Output<String>? = null, description: Output<String>? = null, httpTarget: Output<HttpTargetArgs>? = null, legacyAppEngineCron: Output<Boolean>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, pubsubTarget: Output<PubsubTargetArgs>? = null, retryConfig: Output<RetryConfigArgs>? = null, schedule: Output<String>? = null, timeZone: Output<String>? = null)

Functions

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

Properties

Link copied to clipboard

App Engine HTTP target.

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

The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval 15 seconds, 30 minutes. * For App Engine HTTP targets, 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. * For Pub/Sub targets, this field is ignored.

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

Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.

Link copied to clipboard
val httpTarget: Output<HttpTargetArgs>? = null

HTTP target.

Link copied to clipboard
val legacyAppEngineCron: Output<Boolean>? = null

Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.

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

Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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 job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * JOB_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 pubsubTarget: Output<PubsubTargetArgs>? = null

Pub/Sub target.

Link copied to clipboard
val retryConfig: Output<RetryConfigArgs>? = null

Settings that determine the retry behavior.

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

Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * Crontab * English-like schedule As a general rule, execution n + 1 of a job will not begin until execution n has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the n+1th execution is scheduled to run at 16:00 but the nth execution takes until 16:15, the n+1th execution will not start until 16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.

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

Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).