GoogleApi.CloudScheduler.V1.Model.Job (google_api_cloud_scheduler v0.7.2) View Source

Configuration for a job. The maximum allowed size for a job is 100KB.


  • appEngineHttpTarget (type: GoogleApi.CloudScheduler.V1.Model.AppEngineHttpTarget.t, default: nil) - App Engine HTTP target.
  • attemptDeadline (type: String.t, default: nil) - 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 allowed duration for this deadline is: For HTTP targets, between 15 seconds and 30 minutes. For App Engine HTTP targets, between 15 seconds and 24 hours.
  • description (type: String.t, default: nil) - Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
  • httpTarget (type: GoogleApi.CloudScheduler.V1.Model.HttpTarget.t, default: nil) - HTTP target.
  • lastAttemptTime (type: DateTime.t, default: nil) - Output only. The time the last job attempt started.
  • name (type: String.t, default: nil) - 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 * JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
  • pubsubTarget (type: GoogleApi.CloudScheduler.V1.Model.PubsubTarget.t, default: nil) - Pub/Sub target.
  • retryConfig (type: GoogleApi.CloudScheduler.V1.Model.RetryConfig.t, default: nil) - Settings that determine the retry behavior.
  • schedule (type: String.t, default: nil) - 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.
  • scheduleTime (type: DateTime.t, default: nil) - Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
  • state (type: String.t, default: nil) - Output only. State of the job.
  • status (type: GoogleApi.CloudScheduler.V1.Model.Status.t, default: nil) - Output only. The response from the target for the last attempted execution.
  • timeZone (type: String.t, default: nil) - 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).
  • userUpdateTime (type: DateTime.t, default: nil) - Output only. The creation time of the job.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.CloudScheduler.V1.Model.Job{
    GoogleApi.CloudScheduler.V1.Model.AppEngineHttpTarget.t() | nil,
  attemptDeadline: String.t() | nil,
  description: String.t() | nil,
  httpTarget: GoogleApi.CloudScheduler.V1.Model.HttpTarget.t() | nil,
  lastAttemptTime: DateTime.t() | nil,
  name: String.t() | nil,
  pubsubTarget: GoogleApi.CloudScheduler.V1.Model.PubsubTarget.t() | nil,
  retryConfig: GoogleApi.CloudScheduler.V1.Model.RetryConfig.t() | nil,
  schedule: String.t() | nil,
  scheduleTime: DateTime.t() | nil,
  state: String.t() | nil,
  status: GoogleApi.CloudScheduler.V1.Model.Status.t() | nil,
  timeZone: String.t() | nil,
  userUpdateTime: DateTime.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.