Updates a job. If successful, the updated Job is returned. If the job does not exist, NOT_FOUND is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: cloudscheduler1-beta1 --scope <scope> projects locations-jobs-patch ...

Required Scalar Argument

  • <name> (string)
    • 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.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Job:
  app-engine-http-target:
    app-engine-routing:
      host: string
      instance: string
      service: string
      version: string
    body: string
    headers: { string: string }
    http-method: string
    relative-uri: string
  attempt-deadline: string
  description: string
  http-target:
    body: string
    headers: { string: string }
    http-method: string
    oauth-token:
      scope: string
      service-account-email: string
    oidc-token:
      audience: string
      service-account-email: string
    uri: string
  last-attempt-time: string
  legacy-app-engine-cron: boolean
  name: string
  pubsub-target:
    attributes: { string: string }
    data: string
    topic-name: string
  retry-config:
    max-backoff-duration: string
    max-doublings: integer
    max-retry-duration: string
    min-backoff-duration: string
    retry-count: integer
  schedule: string
  schedule-time: string
  state: string
  status:
    code: integer
    message: string
  time-zone: string
  user-update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .app-engine-http-target.app-engine-routing host=eos
    • Output only. The host that the job is sent to. For more information about how App Engine requests are routed, see here. The host is constructed as: * host = [application_domain_name] | [service] + &#39;.&#39; + [application_domain_name] | [version] + &#39;.&#39; + [application_domain_name] | [version_dot_service]+ &#39;.&#39; + [application_domain_name] | [instance] + &#39;.&#39; + [application_domain_name] | [instance_dot_service] + &#39;.&#39; + [application_domain_name] | [instance_dot_version] + &#39;.&#39; + [application_domain_name] | [instance_dot_version_dot_service] + &#39;.&#39; + [application_domain_name] * application_domain_name = The domain name of the app, for example .appspot.com, which is associated with the job's project ID. * service = service * version = version * version_dot_service = version + &#39;.&#39; + service * instance = instance * instance_dot_service = instance + &#39;.&#39; + service * instance_dot_version = instance + &#39;.&#39; + version * instance_dot_version_dot_service = instance + &#39;.&#39; + version + &#39;.&#39; + service If service is empty, then the job will be sent to the service which is the default service when the job is attempted. If version is empty, then the job will be sent to the version which is the default version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is invalid, then the job will be sent to the default version of the default service when the job is attempted.
  • instance=labore
  • service=sed
    • App service. By default, the job is sent to the service which is the default service when the job is attempted.

  • version=duo

    • App version. By default, the job is sent to the version which is the default version when the job is attempted.

  • .. body=sed

    • Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod.
  • headers=key=no
    • HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * User-Agent: By default, this header is &#34;AppEngine-Google; (+http://code.google.com/appengine)&#34;. This header can be modified, but Cloud Scheduler will append &#34;AppEngine-Google; (+http://code.google.com/appengine)&#34; to the modified User-Agent. * X-CloudScheduler: This header will be set to true. * X-CloudScheduler-JobName: This header will contain the job name. * X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * Content-Type: This will be set to &#34;application/octet-stream&#34;. You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to &#34;application/json&#34;. The headers below are output only. They cannot be set or overridden: * Content-Length: This is computed by Cloud Scheduler. * X-Google-*: For Google internal use only. * X-AppEngine-*: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
    • the value will be associated with the given key
  • http-method=stet
    • The HTTP method to use for the request. PATCH and OPTIONS are not permitted.

  • relative-uri=kasd

    • The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.

  • .. attempt-deadline=et

    • 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.
  • description=sed
    • Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
  • http-target body=et
    • 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 job with an incompatible HttpMethod.
  • headers=key=et
    • HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * Content-Length: This will be computed by Cloud Scheduler. * User-Agent: This will be set to &#34;Google-Cloud-Scheduler&#34;. * X-Google-*: Google internal use only. * X-AppEngine-*: Google internal use only. * X-CloudScheduler: This header will be set to true. * X-CloudScheduler-JobName: This header will contain the job name. * X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * Content-Type: This will be set to &#34;application/octet-stream&#34;. You can override this default by explicitly setting Content-Type to a particular media type when creating the job. For example, you can set Content-Type to &#34;application/json&#34;. The total size of headers must be less than 80KB.
    • the value will be associated with the given key
  • http-method=vero
    • Which HTTP method to use for the request.
  • oauth-token scope=erat
    • 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=sed

    • Service account email to be used for generating OAuth token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

  • ..oidc-token audience=duo

    • Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

  • service-account-email=dolore

    • Service account email to be used for generating OIDC token. The service account must be within the same project as the job. The caller must have iam.serviceAccounts.actAs permission for the service account.

  • .. uri=et

    • Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: http://acme.com and https://acme.com/sales:8080. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.

  • .. last-attempt-time=voluptua.

    • Output only. The time the last job attempt started.
  • legacy-app-engine-cron=false
    • 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.
  • name=diam
    • 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.
  • pubsub-target attributes=key=dolor
    • Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
    • the value will be associated with the given key
  • data=et
    • The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

  • topic-name=et

    • Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID. The topic must be in the same project as the Cloud Scheduler job.

  • ..retry-config max-backoff-duration=sadipscing

    • The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
  • max-doublings=86
    • The time between retries will double max_doublings times. A job's retry interval starts at min_backoff_duration, then doubles max_doublings times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and max_doublings is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
  • max-retry-duration=dolor
    • The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
  • min-backoff-duration=duo
    • The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.

  • retry-count=25

    • The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed.

  • .. schedule=vero

    • 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. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
  • schedule-time=invidunt
    • 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=stet
    • Output only. State of the job.
  • status code=25
    • The status code, which should be an enum value of google.rpc.Code.

  • message=elitr

    • 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.

  • .. time-zone=lorem

    • 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).
  • user-update-time=diam
    • Output only. The creation time of the job.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • A mask used to specify which fields of the job are being updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").