1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudscheduler_v1.html">Cloud Scheduler API</a> . <a href="cloudscheduler_v1.projects.html">projects</a> . <a href="cloudscheduler_v1.projects.locations.html">locations</a> . <a href="cloudscheduler_v1.projects.locations.jobs.html">jobs</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a job.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a job.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets a job.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> 88<p class="firstline">Lists jobs.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates a job.</p> 95<p class="toc_element"> 96 <code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Pauses a job.</p> 98<p class="toc_element"> 99 <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Resume a job.</p> 101<p class="toc_element"> 102 <code><a href="#run">run(name, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Forces a job to run now.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 107 <pre>Creates a job. 108 109Args: 110 parent: string, Required. 111 112The location name. For example: 113`projects/PROJECT_ID/locations/LOCATION_ID`. (required) 114 body: object, The request body. (required) 115 The object takes the form of: 116 117{ # Configuration for a job. 118 # The maximum allowed size for a job is 100KB. 119 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 120 # different programming environments, including REST APIs and RPC APIs. It is 121 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 122 # three pieces of data: error code, error message, and error details. 123 # 124 # You can find out more about this error model and how to work with it in the 125 # [API Design Guide](https://cloud.google.com/apis/design/errors). 126 "message": "A String", # A developer-facing error message, which should be in English. Any 127 # user-facing error message should be localized and sent in the 128 # google.rpc.Status.details field, or localized by the client. 129 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 130 "details": [ # A list of messages that carry the error details. There is a common set of 131 # message types for APIs to use. 132 { 133 "a_key": "", # Properties of the object. Contains field @type with type URL. 134 }, 135 ], 136 }, 137 "description": "A String", # Optionally caller-specified in CreateJob or 138 # UpdateJob. 139 # 140 # A human-readable description for the job. This string must not contain 141 # more than 500 characters. 142 "name": "A String", # Optionally caller-specified in CreateJob, after 143 # which it becomes output only. 144 # 145 # The job name. For example: 146 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 147 # 148 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 149 # hyphens (-), colons (:), or periods (.). 150 # For more information, see 151 # [Identifying 152 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 153 # * `LOCATION_ID` is the canonical ID for the job's location. 154 # The list of available locations can be obtained by calling 155 # ListLocations. 156 # For more information, see https://cloud.google.com/about/locations/. 157 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 158 # hyphens (-), or underscores (_). The maximum length is 500 characters. 159 "schedule": "A String", # Required, except when used with UpdateJob. 160 # 161 # Describes the schedule on which the job will be executed. 162 # 163 # The schedule can be either of the following types: 164 # 165 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 166 # * English-like 167 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 168 # 169 # As a general rule, execution `n + 1` of a job will not begin 170 # until execution `n` has finished. Cloud Scheduler will never 171 # allow two simultaneously outstanding executions. For example, 172 # this implies that if the `n+1`th execution is scheduled to run at 173 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 174 # execution will not start until `16:15`. 175 # A scheduled start time will be delayed if the previous 176 # execution has not ended when its scheduled time occurs. 177 # 178 # If retry_count > 0 and a job attempt fails, 179 # the job will be tried a total of retry_count 180 # times, with exponential backoff, until the next scheduled start 181 # time. 182 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 183 # retry of a previously failed attempt or the next execution time 184 # according to the schedule. 185 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 186 # an HTTP request via an http_method such as HTTP 187 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 188 # response code in the range [200 - 299]. A failure to receive a response 189 # constitutes a failed execution. For a redirected request, the response 190 # returned by the redirected request is considered. 191 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 192 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 193 # incompatible HttpMethod. 194 "headers": { # The user can specify HTTP request headers to send with the job's 195 # HTTP request. This map contains the header field names and 196 # values. Repeated headers are not supported, but a header value can 197 # contain commas. These headers represent a subset of the headers 198 # that will accompany the job's HTTP request. Some HTTP request 199 # headers will be ignored or replaced. A partial list of headers that 200 # will be ignored or replaced is below: 201 # - Host: This will be computed by Cloud Scheduler and derived from 202 # uri. 203 # * `Content-Length`: This will be computed by Cloud Scheduler. 204 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 205 # * `X-Google-*`: Google internal use only. 206 # * `X-AppEngine-*`: Google internal use only. 207 # 208 # The total size of headers must be less than 80KB. 209 "a_key": "A String", 210 }, 211 "oidcToken": { # Contains information needed for generating an # If specified, an 212 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 213 # token will be generated and attached as an `Authorization` header in the 214 # HTTP request. 215 # 216 # This type of authorization can be used for many scenarios, including 217 # calling Cloud Run, or endpoints where you intend to validate the token 218 # yourself. 219 # [OpenID Connect 220 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 221 # This type of authorization can be used for many scenarios, including 222 # calling Cloud Run, or endpoints where you intend to validate the token 223 # yourself. 224 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 225 # specified in target will be used. 226 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 227 # to be used for generating OIDC token. 228 # The service account must be within the same project as the job. The caller 229 # must have iam.serviceAccounts.actAs permission for the service account. 230 }, 231 "uri": "A String", # Required. 232 # 233 # The full URI path that the request will be sent to. This string 234 # must begin with either "http://" or "https://". Some examples of 235 # valid values for uri are: 236 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 237 # encode some characters for safety and compatibility. The maximum allowed 238 # URL length is 2083 characters after encoding. 239 "oauthToken": { # Contains information needed for generating an # If specified, an 240 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 241 # will be generated and attached as an `Authorization` header in the HTTP 242 # request. 243 # 244 # This type of authorization should generally only be used when calling 245 # Google APIs hosted on *.googleapis.com. 246 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 247 # This type of authorization should generally only be used when calling Google 248 # APIs hosted on *.googleapis.com. 249 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 250 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 251 # will be used. 252 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 253 # to be used for generating OAuth token. 254 # The service account must be within the same project as the job. The caller 255 # must have iam.serviceAccounts.actAs permission for the service account. 256 }, 257 "httpMethod": "A String", # Which HTTP method to use for the request. 258 }, 259 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 260 # of an HTTP request via an http_method such 261 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 262 # HTTP response code in the range [200 - 299]. Error 503 is 263 # considered an App Engine system error instead of an application 264 # error. Requests returning error 503 will be retried regardless of 265 # retry configuration and not counted against retry counts. Any other 266 # response code, or a failure to receive a response before the 267 # deadline, constitutes a failed attempt. 268 "body": "A String", # Body. 269 # 270 # HTTP request body. A request body is allowed only if the HTTP method is 271 # POST or PUT. It will result in invalid argument error to set a body on a 272 # job with an incompatible HttpMethod. 273 "headers": { # HTTP request headers. 274 # 275 # This map contains the header field names and values. Headers can be set 276 # when the job is created. 277 # 278 # Cloud Scheduler sets some headers to default values: 279 # 280 # * `User-Agent`: By default, this header is 281 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 282 # This header can be modified, but Cloud Scheduler will append 283 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 284 # modified `User-Agent`. 285 # * `X-CloudScheduler`: This header will be set to true. 286 # 287 # If the job has an body, Cloud Scheduler sets 288 # the following headers: 289 # 290 # * `Content-Type`: By default, the `Content-Type` header is set to 291 # `"application/octet-stream"`. The default can be overridden by explictly 292 # setting `Content-Type` to a particular media type when the job is 293 # created. 294 # For example, `Content-Type` can be set to `"application/json"`. 295 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 296 # output only. It cannot be changed. 297 # 298 # The headers below are output only. They cannot be set or overridden: 299 # 300 # * `X-Google-*`: For Google internal use only. 301 # * `X-AppEngine-*`: For Google internal use only. 302 # 303 # In addition, some App Engine headers, which contain 304 # job-specific information, are also be sent to the job handler. 305 "a_key": "A String", 306 }, 307 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 308 # 309 # For more information about services, versions, and instances see 310 # [An Overview of App 311 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 312 # [Microservices Architecture on Google App 313 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 314 # [App Engine Standard request 315 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 316 # and [App Engine Flex request 317 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 318 "instance": "A String", # App instance. 319 # 320 # By default, the job is sent to an instance which is available when 321 # the job is attempted. 322 # 323 # Requests can only be sent to a specific instance if 324 # [manual scaling is used in App Engine 325 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 326 # App Engine Flex does not support instances. For more information, see 327 # [App Engine Standard request 328 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 329 # and [App Engine Flex request 330 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 331 "host": "A String", # Output only. The host that the job is sent to. 332 # 333 # For more information about how App Engine requests are routed, see 334 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 335 # 336 # The host is constructed as: 337 # 338 # 339 # * `host = [application_domain_name]`</br> 340 # `| [service] + '.' + [application_domain_name]`</br> 341 # `| [version] + '.' + [application_domain_name]`</br> 342 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 343 # `| [instance] + '.' + [application_domain_name]`</br> 344 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 345 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 346 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 347 # 348 # * `application_domain_name` = The domain name of the app, for 349 # example <app-id>.appspot.com, which is associated with the 350 # job's project ID. 351 # 352 # * `service =` service 353 # 354 # * `version =` version 355 # 356 # * `version_dot_service =` 357 # version `+ '.' +` 358 # service 359 # 360 # * `instance =` instance 361 # 362 # * `instance_dot_service =` 363 # instance `+ '.' +` 364 # service 365 # 366 # * `instance_dot_version =` 367 # instance `+ '.' +` 368 # version 369 # 370 # * `instance_dot_version_dot_service =` 371 # instance `+ '.' +` 372 # version `+ '.' +` 373 # service 374 # 375 # 376 # If service is empty, then the job will be sent 377 # to the service which is the default service when the job is attempted. 378 # 379 # If version is empty, then the job will be sent 380 # to the version which is the default version when the job is attempted. 381 # 382 # If instance is empty, then the job will be 383 # sent to an instance which is available when the job is attempted. 384 # 385 # If service, 386 # version, or 387 # instance is invalid, then the job will be sent 388 # to the default version of the default service when the job is attempted. 389 "version": "A String", # App version. 390 # 391 # By default, the job is sent to the version which is the default 392 # version when the job is attempted. 393 "service": "A String", # App service. 394 # 395 # By default, the job is sent to the service which is the default 396 # service when the job is attempted. 397 }, 398 "relativeUri": "A String", # The relative URI. 399 # 400 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 401 # It can contain a path, query string arguments, and `#` fragments. 402 # If the relative URL is empty, then the root path "/" will be used. 403 # No spaces are allowed, and the maximum length allowed is 2083 characters. 404 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 405 # permitted. 406 }, 407 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 408 "state": "A String", # Output only. State of the job. 409 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 410 # the given Pub/Sub topic. 411 "attributes": { # Attributes for PubsubMessage. 412 # 413 # Pubsub message must contain either non-empty data, or at least one 414 # attribute. 415 "a_key": "A String", 416 }, 417 "data": "A String", # The message payload for PubsubMessage. 418 # 419 # Pubsub message must contain either non-empty data, or at least one 420 # attribute. 421 "topicName": "A String", # Required. 422 # 423 # The name of the Cloud Pub/Sub topic to which messages will 424 # be published when a job is delivered. The topic name must be in the 425 # same format as required by PubSub's 426 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 427 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 428 # 429 # The topic must be in the same project as the Cloud Scheduler job. 430 }, 431 "timeZone": "A String", # Specifies the time zone to be used in interpreting 432 # schedule. The value of this field must be a time 433 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 434 # 435 # Note that some time zones include a provision for 436 # daylight savings time. The rules for daylight saving time are 437 # determined by the chosen tz. For UTC use the string "utc". If a 438 # time zone is not specified, the default will be in UTC (also known 439 # as GMT). 440 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 441 # 442 # By default, if a job does not complete successfully (meaning that 443 # an acknowledgement is not received from the handler, then it will be retried 444 # with exponential backoff according to the settings in RetryConfig. 445 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 446 # it fails. 447 # 448 # The default value of this field is 1 hour. 449 "retryCount": 42, # The number of attempts that the system will make to run a job using the 450 # exponential backoff procedure described by 451 # max_doublings. 452 # 453 # The default value of retry_count is zero. 454 # 455 # If retry_count is zero, a job attempt will *not* be retried if 456 # it fails. Instead the Cloud Scheduler system will wait for the 457 # next scheduled execution time. 458 # 459 # If retry_count is set to a non-zero number then Cloud Scheduler 460 # will retry failed attempts, using exponential backoff, 461 # retry_count times, or until the next scheduled execution time, 462 # whichever comes first. 463 # 464 # Values greater than 5 and negative values are not allowed. 465 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 466 # 467 # A job's retry interval starts at 468 # min_backoff_duration, then doubles 469 # `max_doublings` times, then increases linearly, and finally 470 # retries retries at intervals of 471 # max_backoff_duration up to 472 # retry_count times. 473 # 474 # For example, if min_backoff_duration is 475 # 10s, max_backoff_duration is 300s, and 476 # `max_doublings` is 3, then the a job will first be retried in 10s. The 477 # retry interval will double three times, and then increase linearly by 478 # 2^3 * 10s. Finally, the job will retry at intervals of 479 # max_backoff_duration until the job has 480 # been attempted retry_count times. Thus, the 481 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 482 # 483 # The default value of this field is 5. 484 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 485 # execution was first attempted. If specified with 486 # retry_count, the job will be retried until both 487 # limits are reached. 488 # 489 # The default value for max_retry_duration is zero, which means retry 490 # duration is unlimited. 491 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 492 # it fails. 493 # 494 # The default value of this field is 5 seconds. 495 }, 496 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 497 # this deadline then the request is cancelled and the attempt is marked as a 498 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 499 # execution logs. Cloud Scheduler will retry the job according 500 # to the RetryConfig. 501 # 502 # The allowed duration for this deadline is: 503 # * For HTTP targets, between 15 seconds and 30 minutes. 504 # * For App Engine HTTP targets, between 15 505 # seconds and 24 hours. 506 "userUpdateTime": "A String", # Output only. The creation time of the job. 507} 508 509 x__xgafv: string, V1 error format. 510 Allowed values 511 1 - v1 error format 512 2 - v2 error format 513 514Returns: 515 An object of the form: 516 517 { # Configuration for a job. 518 # The maximum allowed size for a job is 100KB. 519 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 520 # different programming environments, including REST APIs and RPC APIs. It is 521 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 522 # three pieces of data: error code, error message, and error details. 523 # 524 # You can find out more about this error model and how to work with it in the 525 # [API Design Guide](https://cloud.google.com/apis/design/errors). 526 "message": "A String", # A developer-facing error message, which should be in English. Any 527 # user-facing error message should be localized and sent in the 528 # google.rpc.Status.details field, or localized by the client. 529 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 530 "details": [ # A list of messages that carry the error details. There is a common set of 531 # message types for APIs to use. 532 { 533 "a_key": "", # Properties of the object. Contains field @type with type URL. 534 }, 535 ], 536 }, 537 "description": "A String", # Optionally caller-specified in CreateJob or 538 # UpdateJob. 539 # 540 # A human-readable description for the job. This string must not contain 541 # more than 500 characters. 542 "name": "A String", # Optionally caller-specified in CreateJob, after 543 # which it becomes output only. 544 # 545 # The job name. For example: 546 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 547 # 548 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 549 # hyphens (-), colons (:), or periods (.). 550 # For more information, see 551 # [Identifying 552 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 553 # * `LOCATION_ID` is the canonical ID for the job's location. 554 # The list of available locations can be obtained by calling 555 # ListLocations. 556 # For more information, see https://cloud.google.com/about/locations/. 557 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 558 # hyphens (-), or underscores (_). The maximum length is 500 characters. 559 "schedule": "A String", # Required, except when used with UpdateJob. 560 # 561 # Describes the schedule on which the job will be executed. 562 # 563 # The schedule can be either of the following types: 564 # 565 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 566 # * English-like 567 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 568 # 569 # As a general rule, execution `n + 1` of a job will not begin 570 # until execution `n` has finished. Cloud Scheduler will never 571 # allow two simultaneously outstanding executions. For example, 572 # this implies that if the `n+1`th execution is scheduled to run at 573 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 574 # execution will not start until `16:15`. 575 # A scheduled start time will be delayed if the previous 576 # execution has not ended when its scheduled time occurs. 577 # 578 # If retry_count > 0 and a job attempt fails, 579 # the job will be tried a total of retry_count 580 # times, with exponential backoff, until the next scheduled start 581 # time. 582 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 583 # retry of a previously failed attempt or the next execution time 584 # according to the schedule. 585 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 586 # an HTTP request via an http_method such as HTTP 587 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 588 # response code in the range [200 - 299]. A failure to receive a response 589 # constitutes a failed execution. For a redirected request, the response 590 # returned by the redirected request is considered. 591 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 592 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 593 # incompatible HttpMethod. 594 "headers": { # The user can specify HTTP request headers to send with the job's 595 # HTTP request. This map contains the header field names and 596 # values. Repeated headers are not supported, but a header value can 597 # contain commas. These headers represent a subset of the headers 598 # that will accompany the job's HTTP request. Some HTTP request 599 # headers will be ignored or replaced. A partial list of headers that 600 # will be ignored or replaced is below: 601 # - Host: This will be computed by Cloud Scheduler and derived from 602 # uri. 603 # * `Content-Length`: This will be computed by Cloud Scheduler. 604 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 605 # * `X-Google-*`: Google internal use only. 606 # * `X-AppEngine-*`: Google internal use only. 607 # 608 # The total size of headers must be less than 80KB. 609 "a_key": "A String", 610 }, 611 "oidcToken": { # Contains information needed for generating an # If specified, an 612 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 613 # token will be generated and attached as an `Authorization` header in the 614 # HTTP request. 615 # 616 # This type of authorization can be used for many scenarios, including 617 # calling Cloud Run, or endpoints where you intend to validate the token 618 # yourself. 619 # [OpenID Connect 620 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 621 # This type of authorization can be used for many scenarios, including 622 # calling Cloud Run, or endpoints where you intend to validate the token 623 # yourself. 624 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 625 # specified in target will be used. 626 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 627 # to be used for generating OIDC token. 628 # The service account must be within the same project as the job. The caller 629 # must have iam.serviceAccounts.actAs permission for the service account. 630 }, 631 "uri": "A String", # Required. 632 # 633 # The full URI path that the request will be sent to. This string 634 # must begin with either "http://" or "https://". Some examples of 635 # valid values for uri are: 636 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 637 # encode some characters for safety and compatibility. The maximum allowed 638 # URL length is 2083 characters after encoding. 639 "oauthToken": { # Contains information needed for generating an # If specified, an 640 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 641 # will be generated and attached as an `Authorization` header in the HTTP 642 # request. 643 # 644 # This type of authorization should generally only be used when calling 645 # Google APIs hosted on *.googleapis.com. 646 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 647 # This type of authorization should generally only be used when calling Google 648 # APIs hosted on *.googleapis.com. 649 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 650 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 651 # will be used. 652 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 653 # to be used for generating OAuth token. 654 # The service account must be within the same project as the job. The caller 655 # must have iam.serviceAccounts.actAs permission for the service account. 656 }, 657 "httpMethod": "A String", # Which HTTP method to use for the request. 658 }, 659 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 660 # of an HTTP request via an http_method such 661 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 662 # HTTP response code in the range [200 - 299]. Error 503 is 663 # considered an App Engine system error instead of an application 664 # error. Requests returning error 503 will be retried regardless of 665 # retry configuration and not counted against retry counts. Any other 666 # response code, or a failure to receive a response before the 667 # deadline, constitutes a failed attempt. 668 "body": "A String", # Body. 669 # 670 # HTTP request body. A request body is allowed only if the HTTP method is 671 # POST or PUT. It will result in invalid argument error to set a body on a 672 # job with an incompatible HttpMethod. 673 "headers": { # HTTP request headers. 674 # 675 # This map contains the header field names and values. Headers can be set 676 # when the job is created. 677 # 678 # Cloud Scheduler sets some headers to default values: 679 # 680 # * `User-Agent`: By default, this header is 681 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 682 # This header can be modified, but Cloud Scheduler will append 683 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 684 # modified `User-Agent`. 685 # * `X-CloudScheduler`: This header will be set to true. 686 # 687 # If the job has an body, Cloud Scheduler sets 688 # the following headers: 689 # 690 # * `Content-Type`: By default, the `Content-Type` header is set to 691 # `"application/octet-stream"`. The default can be overridden by explictly 692 # setting `Content-Type` to a particular media type when the job is 693 # created. 694 # For example, `Content-Type` can be set to `"application/json"`. 695 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 696 # output only. It cannot be changed. 697 # 698 # The headers below are output only. They cannot be set or overridden: 699 # 700 # * `X-Google-*`: For Google internal use only. 701 # * `X-AppEngine-*`: For Google internal use only. 702 # 703 # In addition, some App Engine headers, which contain 704 # job-specific information, are also be sent to the job handler. 705 "a_key": "A String", 706 }, 707 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 708 # 709 # For more information about services, versions, and instances see 710 # [An Overview of App 711 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 712 # [Microservices Architecture on Google App 713 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 714 # [App Engine Standard request 715 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 716 # and [App Engine Flex request 717 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 718 "instance": "A String", # App instance. 719 # 720 # By default, the job is sent to an instance which is available when 721 # the job is attempted. 722 # 723 # Requests can only be sent to a specific instance if 724 # [manual scaling is used in App Engine 725 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 726 # App Engine Flex does not support instances. For more information, see 727 # [App Engine Standard request 728 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 729 # and [App Engine Flex request 730 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 731 "host": "A String", # Output only. The host that the job is sent to. 732 # 733 # For more information about how App Engine requests are routed, see 734 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 735 # 736 # The host is constructed as: 737 # 738 # 739 # * `host = [application_domain_name]`</br> 740 # `| [service] + '.' + [application_domain_name]`</br> 741 # `| [version] + '.' + [application_domain_name]`</br> 742 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 743 # `| [instance] + '.' + [application_domain_name]`</br> 744 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 745 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 746 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 747 # 748 # * `application_domain_name` = The domain name of the app, for 749 # example <app-id>.appspot.com, which is associated with the 750 # job's project ID. 751 # 752 # * `service =` service 753 # 754 # * `version =` version 755 # 756 # * `version_dot_service =` 757 # version `+ '.' +` 758 # service 759 # 760 # * `instance =` instance 761 # 762 # * `instance_dot_service =` 763 # instance `+ '.' +` 764 # service 765 # 766 # * `instance_dot_version =` 767 # instance `+ '.' +` 768 # version 769 # 770 # * `instance_dot_version_dot_service =` 771 # instance `+ '.' +` 772 # version `+ '.' +` 773 # service 774 # 775 # 776 # If service is empty, then the job will be sent 777 # to the service which is the default service when the job is attempted. 778 # 779 # If version is empty, then the job will be sent 780 # to the version which is the default version when the job is attempted. 781 # 782 # If instance is empty, then the job will be 783 # sent to an instance which is available when the job is attempted. 784 # 785 # If service, 786 # version, or 787 # instance is invalid, then the job will be sent 788 # to the default version of the default service when the job is attempted. 789 "version": "A String", # App version. 790 # 791 # By default, the job is sent to the version which is the default 792 # version when the job is attempted. 793 "service": "A String", # App service. 794 # 795 # By default, the job is sent to the service which is the default 796 # service when the job is attempted. 797 }, 798 "relativeUri": "A String", # The relative URI. 799 # 800 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 801 # It can contain a path, query string arguments, and `#` fragments. 802 # If the relative URL is empty, then the root path "/" will be used. 803 # No spaces are allowed, and the maximum length allowed is 2083 characters. 804 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 805 # permitted. 806 }, 807 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 808 "state": "A String", # Output only. State of the job. 809 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 810 # the given Pub/Sub topic. 811 "attributes": { # Attributes for PubsubMessage. 812 # 813 # Pubsub message must contain either non-empty data, or at least one 814 # attribute. 815 "a_key": "A String", 816 }, 817 "data": "A String", # The message payload for PubsubMessage. 818 # 819 # Pubsub message must contain either non-empty data, or at least one 820 # attribute. 821 "topicName": "A String", # Required. 822 # 823 # The name of the Cloud Pub/Sub topic to which messages will 824 # be published when a job is delivered. The topic name must be in the 825 # same format as required by PubSub's 826 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 827 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 828 # 829 # The topic must be in the same project as the Cloud Scheduler job. 830 }, 831 "timeZone": "A String", # Specifies the time zone to be used in interpreting 832 # schedule. The value of this field must be a time 833 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 834 # 835 # Note that some time zones include a provision for 836 # daylight savings time. The rules for daylight saving time are 837 # determined by the chosen tz. For UTC use the string "utc". If a 838 # time zone is not specified, the default will be in UTC (also known 839 # as GMT). 840 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 841 # 842 # By default, if a job does not complete successfully (meaning that 843 # an acknowledgement is not received from the handler, then it will be retried 844 # with exponential backoff according to the settings in RetryConfig. 845 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 846 # it fails. 847 # 848 # The default value of this field is 1 hour. 849 "retryCount": 42, # The number of attempts that the system will make to run a job using the 850 # exponential backoff procedure described by 851 # max_doublings. 852 # 853 # The default value of retry_count is zero. 854 # 855 # If retry_count is zero, a job attempt will *not* be retried if 856 # it fails. Instead the Cloud Scheduler system will wait for the 857 # next scheduled execution time. 858 # 859 # If retry_count is set to a non-zero number then Cloud Scheduler 860 # will retry failed attempts, using exponential backoff, 861 # retry_count times, or until the next scheduled execution time, 862 # whichever comes first. 863 # 864 # Values greater than 5 and negative values are not allowed. 865 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 866 # 867 # A job's retry interval starts at 868 # min_backoff_duration, then doubles 869 # `max_doublings` times, then increases linearly, and finally 870 # retries retries at intervals of 871 # max_backoff_duration up to 872 # retry_count times. 873 # 874 # For example, if min_backoff_duration is 875 # 10s, max_backoff_duration is 300s, and 876 # `max_doublings` is 3, then the a job will first be retried in 10s. The 877 # retry interval will double three times, and then increase linearly by 878 # 2^3 * 10s. Finally, the job will retry at intervals of 879 # max_backoff_duration until the job has 880 # been attempted retry_count times. Thus, the 881 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 882 # 883 # The default value of this field is 5. 884 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 885 # execution was first attempted. If specified with 886 # retry_count, the job will be retried until both 887 # limits are reached. 888 # 889 # The default value for max_retry_duration is zero, which means retry 890 # duration is unlimited. 891 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 892 # it fails. 893 # 894 # The default value of this field is 5 seconds. 895 }, 896 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 897 # this deadline then the request is cancelled and the attempt is marked as a 898 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 899 # execution logs. Cloud Scheduler will retry the job according 900 # to the RetryConfig. 901 # 902 # The allowed duration for this deadline is: 903 # * For HTTP targets, between 15 seconds and 30 minutes. 904 # * For App Engine HTTP targets, between 15 905 # seconds and 24 hours. 906 "userUpdateTime": "A String", # Output only. The creation time of the job. 907 }</pre> 908</div> 909 910<div class="method"> 911 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 912 <pre>Deletes a job. 913 914Args: 915 name: string, Required. 916 917The job name. For example: 918`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required) 919 x__xgafv: string, V1 error format. 920 Allowed values 921 1 - v1 error format 922 2 - v2 error format 923 924Returns: 925 An object of the form: 926 927 { # A generic empty message that you can re-use to avoid defining duplicated 928 # empty messages in your APIs. A typical example is to use it as the request 929 # or the response type of an API method. For instance: 930 # 931 # service Foo { 932 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 933 # } 934 # 935 # The JSON representation for `Empty` is empty JSON object `{}`. 936 }</pre> 937</div> 938 939<div class="method"> 940 <code class="details" id="get">get(name, x__xgafv=None)</code> 941 <pre>Gets a job. 942 943Args: 944 name: string, Required. 945 946The job name. For example: 947`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required) 948 x__xgafv: string, V1 error format. 949 Allowed values 950 1 - v1 error format 951 2 - v2 error format 952 953Returns: 954 An object of the form: 955 956 { # Configuration for a job. 957 # The maximum allowed size for a job is 100KB. 958 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 959 # different programming environments, including REST APIs and RPC APIs. It is 960 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 961 # three pieces of data: error code, error message, and error details. 962 # 963 # You can find out more about this error model and how to work with it in the 964 # [API Design Guide](https://cloud.google.com/apis/design/errors). 965 "message": "A String", # A developer-facing error message, which should be in English. Any 966 # user-facing error message should be localized and sent in the 967 # google.rpc.Status.details field, or localized by the client. 968 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 969 "details": [ # A list of messages that carry the error details. There is a common set of 970 # message types for APIs to use. 971 { 972 "a_key": "", # Properties of the object. Contains field @type with type URL. 973 }, 974 ], 975 }, 976 "description": "A String", # Optionally caller-specified in CreateJob or 977 # UpdateJob. 978 # 979 # A human-readable description for the job. This string must not contain 980 # more than 500 characters. 981 "name": "A String", # Optionally caller-specified in CreateJob, after 982 # which it becomes output only. 983 # 984 # The job name. For example: 985 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 986 # 987 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 988 # hyphens (-), colons (:), or periods (.). 989 # For more information, see 990 # [Identifying 991 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 992 # * `LOCATION_ID` is the canonical ID for the job's location. 993 # The list of available locations can be obtained by calling 994 # ListLocations. 995 # For more information, see https://cloud.google.com/about/locations/. 996 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 997 # hyphens (-), or underscores (_). The maximum length is 500 characters. 998 "schedule": "A String", # Required, except when used with UpdateJob. 999 # 1000 # Describes the schedule on which the job will be executed. 1001 # 1002 # The schedule can be either of the following types: 1003 # 1004 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 1005 # * English-like 1006 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 1007 # 1008 # As a general rule, execution `n + 1` of a job will not begin 1009 # until execution `n` has finished. Cloud Scheduler will never 1010 # allow two simultaneously outstanding executions. For example, 1011 # this implies that if the `n+1`th execution is scheduled to run at 1012 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 1013 # execution will not start until `16:15`. 1014 # A scheduled start time will be delayed if the previous 1015 # execution has not ended when its scheduled time occurs. 1016 # 1017 # If retry_count > 0 and a job attempt fails, 1018 # the job will be tried a total of retry_count 1019 # times, with exponential backoff, until the next scheduled start 1020 # time. 1021 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 1022 # retry of a previously failed attempt or the next execution time 1023 # according to the schedule. 1024 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 1025 # an HTTP request via an http_method such as HTTP 1026 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 1027 # response code in the range [200 - 299]. A failure to receive a response 1028 # constitutes a failed execution. For a redirected request, the response 1029 # returned by the redirected request is considered. 1030 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 1031 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 1032 # incompatible HttpMethod. 1033 "headers": { # The user can specify HTTP request headers to send with the job's 1034 # HTTP request. This map contains the header field names and 1035 # values. Repeated headers are not supported, but a header value can 1036 # contain commas. These headers represent a subset of the headers 1037 # that will accompany the job's HTTP request. Some HTTP request 1038 # headers will be ignored or replaced. A partial list of headers that 1039 # will be ignored or replaced is below: 1040 # - Host: This will be computed by Cloud Scheduler and derived from 1041 # uri. 1042 # * `Content-Length`: This will be computed by Cloud Scheduler. 1043 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 1044 # * `X-Google-*`: Google internal use only. 1045 # * `X-AppEngine-*`: Google internal use only. 1046 # 1047 # The total size of headers must be less than 80KB. 1048 "a_key": "A String", 1049 }, 1050 "oidcToken": { # Contains information needed for generating an # If specified, an 1051 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 1052 # token will be generated and attached as an `Authorization` header in the 1053 # HTTP request. 1054 # 1055 # This type of authorization can be used for many scenarios, including 1056 # calling Cloud Run, or endpoints where you intend to validate the token 1057 # yourself. 1058 # [OpenID Connect 1059 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 1060 # This type of authorization can be used for many scenarios, including 1061 # calling Cloud Run, or endpoints where you intend to validate the token 1062 # yourself. 1063 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 1064 # specified in target will be used. 1065 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1066 # to be used for generating OIDC token. 1067 # The service account must be within the same project as the job. The caller 1068 # must have iam.serviceAccounts.actAs permission for the service account. 1069 }, 1070 "uri": "A String", # Required. 1071 # 1072 # The full URI path that the request will be sent to. This string 1073 # must begin with either "http://" or "https://". Some examples of 1074 # valid values for uri are: 1075 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 1076 # encode some characters for safety and compatibility. The maximum allowed 1077 # URL length is 2083 characters after encoding. 1078 "oauthToken": { # Contains information needed for generating an # If specified, an 1079 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 1080 # will be generated and attached as an `Authorization` header in the HTTP 1081 # request. 1082 # 1083 # This type of authorization should generally only be used when calling 1084 # Google APIs hosted on *.googleapis.com. 1085 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 1086 # This type of authorization should generally only be used when calling Google 1087 # APIs hosted on *.googleapis.com. 1088 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 1089 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 1090 # will be used. 1091 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1092 # to be used for generating OAuth token. 1093 # The service account must be within the same project as the job. The caller 1094 # must have iam.serviceAccounts.actAs permission for the service account. 1095 }, 1096 "httpMethod": "A String", # Which HTTP method to use for the request. 1097 }, 1098 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 1099 # of an HTTP request via an http_method such 1100 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 1101 # HTTP response code in the range [200 - 299]. Error 503 is 1102 # considered an App Engine system error instead of an application 1103 # error. Requests returning error 503 will be retried regardless of 1104 # retry configuration and not counted against retry counts. Any other 1105 # response code, or a failure to receive a response before the 1106 # deadline, constitutes a failed attempt. 1107 "body": "A String", # Body. 1108 # 1109 # HTTP request body. A request body is allowed only if the HTTP method is 1110 # POST or PUT. It will result in invalid argument error to set a body on a 1111 # job with an incompatible HttpMethod. 1112 "headers": { # HTTP request headers. 1113 # 1114 # This map contains the header field names and values. Headers can be set 1115 # when the job is created. 1116 # 1117 # Cloud Scheduler sets some headers to default values: 1118 # 1119 # * `User-Agent`: By default, this header is 1120 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 1121 # This header can be modified, but Cloud Scheduler will append 1122 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 1123 # modified `User-Agent`. 1124 # * `X-CloudScheduler`: This header will be set to true. 1125 # 1126 # If the job has an body, Cloud Scheduler sets 1127 # the following headers: 1128 # 1129 # * `Content-Type`: By default, the `Content-Type` header is set to 1130 # `"application/octet-stream"`. The default can be overridden by explictly 1131 # setting `Content-Type` to a particular media type when the job is 1132 # created. 1133 # For example, `Content-Type` can be set to `"application/json"`. 1134 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 1135 # output only. It cannot be changed. 1136 # 1137 # The headers below are output only. They cannot be set or overridden: 1138 # 1139 # * `X-Google-*`: For Google internal use only. 1140 # * `X-AppEngine-*`: For Google internal use only. 1141 # 1142 # In addition, some App Engine headers, which contain 1143 # job-specific information, are also be sent to the job handler. 1144 "a_key": "A String", 1145 }, 1146 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 1147 # 1148 # For more information about services, versions, and instances see 1149 # [An Overview of App 1150 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 1151 # [Microservices Architecture on Google App 1152 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 1153 # [App Engine Standard request 1154 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 1155 # and [App Engine Flex request 1156 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 1157 "instance": "A String", # App instance. 1158 # 1159 # By default, the job is sent to an instance which is available when 1160 # the job is attempted. 1161 # 1162 # Requests can only be sent to a specific instance if 1163 # [manual scaling is used in App Engine 1164 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 1165 # App Engine Flex does not support instances. For more information, see 1166 # [App Engine Standard request 1167 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 1168 # and [App Engine Flex request 1169 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 1170 "host": "A String", # Output only. The host that the job is sent to. 1171 # 1172 # For more information about how App Engine requests are routed, see 1173 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 1174 # 1175 # The host is constructed as: 1176 # 1177 # 1178 # * `host = [application_domain_name]`</br> 1179 # `| [service] + '.' + [application_domain_name]`</br> 1180 # `| [version] + '.' + [application_domain_name]`</br> 1181 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 1182 # `| [instance] + '.' + [application_domain_name]`</br> 1183 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 1184 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 1185 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 1186 # 1187 # * `application_domain_name` = The domain name of the app, for 1188 # example <app-id>.appspot.com, which is associated with the 1189 # job's project ID. 1190 # 1191 # * `service =` service 1192 # 1193 # * `version =` version 1194 # 1195 # * `version_dot_service =` 1196 # version `+ '.' +` 1197 # service 1198 # 1199 # * `instance =` instance 1200 # 1201 # * `instance_dot_service =` 1202 # instance `+ '.' +` 1203 # service 1204 # 1205 # * `instance_dot_version =` 1206 # instance `+ '.' +` 1207 # version 1208 # 1209 # * `instance_dot_version_dot_service =` 1210 # instance `+ '.' +` 1211 # version `+ '.' +` 1212 # service 1213 # 1214 # 1215 # If service is empty, then the job will be sent 1216 # to the service which is the default service when the job is attempted. 1217 # 1218 # If version is empty, then the job will be sent 1219 # to the version which is the default version when the job is attempted. 1220 # 1221 # If instance is empty, then the job will be 1222 # sent to an instance which is available when the job is attempted. 1223 # 1224 # If service, 1225 # version, or 1226 # instance is invalid, then the job will be sent 1227 # to the default version of the default service when the job is attempted. 1228 "version": "A String", # App version. 1229 # 1230 # By default, the job is sent to the version which is the default 1231 # version when the job is attempted. 1232 "service": "A String", # App service. 1233 # 1234 # By default, the job is sent to the service which is the default 1235 # service when the job is attempted. 1236 }, 1237 "relativeUri": "A String", # The relative URI. 1238 # 1239 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 1240 # It can contain a path, query string arguments, and `#` fragments. 1241 # If the relative URL is empty, then the root path "/" will be used. 1242 # No spaces are allowed, and the maximum length allowed is 2083 characters. 1243 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 1244 # permitted. 1245 }, 1246 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 1247 "state": "A String", # Output only. State of the job. 1248 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 1249 # the given Pub/Sub topic. 1250 "attributes": { # Attributes for PubsubMessage. 1251 # 1252 # Pubsub message must contain either non-empty data, or at least one 1253 # attribute. 1254 "a_key": "A String", 1255 }, 1256 "data": "A String", # The message payload for PubsubMessage. 1257 # 1258 # Pubsub message must contain either non-empty data, or at least one 1259 # attribute. 1260 "topicName": "A String", # Required. 1261 # 1262 # The name of the Cloud Pub/Sub topic to which messages will 1263 # be published when a job is delivered. The topic name must be in the 1264 # same format as required by PubSub's 1265 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 1266 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 1267 # 1268 # The topic must be in the same project as the Cloud Scheduler job. 1269 }, 1270 "timeZone": "A String", # Specifies the time zone to be used in interpreting 1271 # schedule. The value of this field must be a time 1272 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 1273 # 1274 # Note that some time zones include a provision for 1275 # daylight savings time. The rules for daylight saving time are 1276 # determined by the chosen tz. For UTC use the string "utc". If a 1277 # time zone is not specified, the default will be in UTC (also known 1278 # as GMT). 1279 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 1280 # 1281 # By default, if a job does not complete successfully (meaning that 1282 # an acknowledgement is not received from the handler, then it will be retried 1283 # with exponential backoff according to the settings in RetryConfig. 1284 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 1285 # it fails. 1286 # 1287 # The default value of this field is 1 hour. 1288 "retryCount": 42, # The number of attempts that the system will make to run a job using the 1289 # exponential backoff procedure described by 1290 # max_doublings. 1291 # 1292 # The default value of retry_count is zero. 1293 # 1294 # If retry_count is zero, a job attempt will *not* be retried if 1295 # it fails. Instead the Cloud Scheduler system will wait for the 1296 # next scheduled execution time. 1297 # 1298 # If retry_count is set to a non-zero number then Cloud Scheduler 1299 # will retry failed attempts, using exponential backoff, 1300 # retry_count times, or until the next scheduled execution time, 1301 # whichever comes first. 1302 # 1303 # Values greater than 5 and negative values are not allowed. 1304 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 1305 # 1306 # A job's retry interval starts at 1307 # min_backoff_duration, then doubles 1308 # `max_doublings` times, then increases linearly, and finally 1309 # retries retries at intervals of 1310 # max_backoff_duration up to 1311 # retry_count times. 1312 # 1313 # For example, if min_backoff_duration is 1314 # 10s, max_backoff_duration is 300s, and 1315 # `max_doublings` is 3, then the a job will first be retried in 10s. The 1316 # retry interval will double three times, and then increase linearly by 1317 # 2^3 * 10s. Finally, the job will retry at intervals of 1318 # max_backoff_duration until the job has 1319 # been attempted retry_count times. Thus, the 1320 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 1321 # 1322 # The default value of this field is 5. 1323 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 1324 # execution was first attempted. If specified with 1325 # retry_count, the job will be retried until both 1326 # limits are reached. 1327 # 1328 # The default value for max_retry_duration is zero, which means retry 1329 # duration is unlimited. 1330 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 1331 # it fails. 1332 # 1333 # The default value of this field is 5 seconds. 1334 }, 1335 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 1336 # this deadline then the request is cancelled and the attempt is marked as a 1337 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 1338 # execution logs. Cloud Scheduler will retry the job according 1339 # to the RetryConfig. 1340 # 1341 # The allowed duration for this deadline is: 1342 # * For HTTP targets, between 15 seconds and 30 minutes. 1343 # * For App Engine HTTP targets, between 15 1344 # seconds and 24 hours. 1345 "userUpdateTime": "A String", # Output only. The creation time of the job. 1346 }</pre> 1347</div> 1348 1349<div class="method"> 1350 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> 1351 <pre>Lists jobs. 1352 1353Args: 1354 parent: string, Required. 1355 1356The location name. For example: 1357`projects/PROJECT_ID/locations/LOCATION_ID`. (required) 1358 pageToken: string, A token identifying a page of results the server will return. To 1359request the first page results, page_token must be empty. To 1360request the next page of results, page_token must be the value of 1361next_page_token returned from 1362the previous call to ListJobs. It is an error to 1363switch the value of filter or 1364order_by while iterating through pages. 1365 x__xgafv: string, V1 error format. 1366 Allowed values 1367 1 - v1 error format 1368 2 - v2 error format 1369 pageSize: integer, Requested page size. 1370 1371The maximum page size is 500. If unspecified, the page size will 1372be the maximum. Fewer jobs than requested might be returned, 1373even if more jobs exist; use next_page_token to determine if more 1374jobs exist. 1375 1376Returns: 1377 An object of the form: 1378 1379 { # Response message for listing jobs using ListJobs. 1380 "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the 1381 # page_token field in the subsequent call to 1382 # ListJobs to retrieve the next page of results. 1383 # If this is empty it indicates that there are no more results 1384 # through which to paginate. 1385 # 1386 # The page token is valid for only 2 hours. 1387 "jobs": [ # The list of jobs. 1388 { # Configuration for a job. 1389 # The maximum allowed size for a job is 100KB. 1390 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 1391 # different programming environments, including REST APIs and RPC APIs. It is 1392 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 1393 # three pieces of data: error code, error message, and error details. 1394 # 1395 # You can find out more about this error model and how to work with it in the 1396 # [API Design Guide](https://cloud.google.com/apis/design/errors). 1397 "message": "A String", # A developer-facing error message, which should be in English. Any 1398 # user-facing error message should be localized and sent in the 1399 # google.rpc.Status.details field, or localized by the client. 1400 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1401 "details": [ # A list of messages that carry the error details. There is a common set of 1402 # message types for APIs to use. 1403 { 1404 "a_key": "", # Properties of the object. Contains field @type with type URL. 1405 }, 1406 ], 1407 }, 1408 "description": "A String", # Optionally caller-specified in CreateJob or 1409 # UpdateJob. 1410 # 1411 # A human-readable description for the job. This string must not contain 1412 # more than 500 characters. 1413 "name": "A String", # Optionally caller-specified in CreateJob, after 1414 # which it becomes output only. 1415 # 1416 # The job name. For example: 1417 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 1418 # 1419 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 1420 # hyphens (-), colons (:), or periods (.). 1421 # For more information, see 1422 # [Identifying 1423 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 1424 # * `LOCATION_ID` is the canonical ID for the job's location. 1425 # The list of available locations can be obtained by calling 1426 # ListLocations. 1427 # For more information, see https://cloud.google.com/about/locations/. 1428 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 1429 # hyphens (-), or underscores (_). The maximum length is 500 characters. 1430 "schedule": "A String", # Required, except when used with UpdateJob. 1431 # 1432 # Describes the schedule on which the job will be executed. 1433 # 1434 # The schedule can be either of the following types: 1435 # 1436 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 1437 # * English-like 1438 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 1439 # 1440 # As a general rule, execution `n + 1` of a job will not begin 1441 # until execution `n` has finished. Cloud Scheduler will never 1442 # allow two simultaneously outstanding executions. For example, 1443 # this implies that if the `n+1`th execution is scheduled to run at 1444 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 1445 # execution will not start until `16:15`. 1446 # A scheduled start time will be delayed if the previous 1447 # execution has not ended when its scheduled time occurs. 1448 # 1449 # If retry_count > 0 and a job attempt fails, 1450 # the job will be tried a total of retry_count 1451 # times, with exponential backoff, until the next scheduled start 1452 # time. 1453 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 1454 # retry of a previously failed attempt or the next execution time 1455 # according to the schedule. 1456 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 1457 # an HTTP request via an http_method such as HTTP 1458 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 1459 # response code in the range [200 - 299]. A failure to receive a response 1460 # constitutes a failed execution. For a redirected request, the response 1461 # returned by the redirected request is considered. 1462 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 1463 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 1464 # incompatible HttpMethod. 1465 "headers": { # The user can specify HTTP request headers to send with the job's 1466 # HTTP request. This map contains the header field names and 1467 # values. Repeated headers are not supported, but a header value can 1468 # contain commas. These headers represent a subset of the headers 1469 # that will accompany the job's HTTP request. Some HTTP request 1470 # headers will be ignored or replaced. A partial list of headers that 1471 # will be ignored or replaced is below: 1472 # - Host: This will be computed by Cloud Scheduler and derived from 1473 # uri. 1474 # * `Content-Length`: This will be computed by Cloud Scheduler. 1475 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 1476 # * `X-Google-*`: Google internal use only. 1477 # * `X-AppEngine-*`: Google internal use only. 1478 # 1479 # The total size of headers must be less than 80KB. 1480 "a_key": "A String", 1481 }, 1482 "oidcToken": { # Contains information needed for generating an # If specified, an 1483 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 1484 # token will be generated and attached as an `Authorization` header in the 1485 # HTTP request. 1486 # 1487 # This type of authorization can be used for many scenarios, including 1488 # calling Cloud Run, or endpoints where you intend to validate the token 1489 # yourself. 1490 # [OpenID Connect 1491 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 1492 # This type of authorization can be used for many scenarios, including 1493 # calling Cloud Run, or endpoints where you intend to validate the token 1494 # yourself. 1495 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 1496 # specified in target will be used. 1497 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1498 # to be used for generating OIDC token. 1499 # The service account must be within the same project as the job. The caller 1500 # must have iam.serviceAccounts.actAs permission for the service account. 1501 }, 1502 "uri": "A String", # Required. 1503 # 1504 # The full URI path that the request will be sent to. This string 1505 # must begin with either "http://" or "https://". Some examples of 1506 # valid values for uri are: 1507 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 1508 # encode some characters for safety and compatibility. The maximum allowed 1509 # URL length is 2083 characters after encoding. 1510 "oauthToken": { # Contains information needed for generating an # If specified, an 1511 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 1512 # will be generated and attached as an `Authorization` header in the HTTP 1513 # request. 1514 # 1515 # This type of authorization should generally only be used when calling 1516 # Google APIs hosted on *.googleapis.com. 1517 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 1518 # This type of authorization should generally only be used when calling Google 1519 # APIs hosted on *.googleapis.com. 1520 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 1521 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 1522 # will be used. 1523 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1524 # to be used for generating OAuth token. 1525 # The service account must be within the same project as the job. The caller 1526 # must have iam.serviceAccounts.actAs permission for the service account. 1527 }, 1528 "httpMethod": "A String", # Which HTTP method to use for the request. 1529 }, 1530 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 1531 # of an HTTP request via an http_method such 1532 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 1533 # HTTP response code in the range [200 - 299]. Error 503 is 1534 # considered an App Engine system error instead of an application 1535 # error. Requests returning error 503 will be retried regardless of 1536 # retry configuration and not counted against retry counts. Any other 1537 # response code, or a failure to receive a response before the 1538 # deadline, constitutes a failed attempt. 1539 "body": "A String", # Body. 1540 # 1541 # HTTP request body. A request body is allowed only if the HTTP method is 1542 # POST or PUT. It will result in invalid argument error to set a body on a 1543 # job with an incompatible HttpMethod. 1544 "headers": { # HTTP request headers. 1545 # 1546 # This map contains the header field names and values. Headers can be set 1547 # when the job is created. 1548 # 1549 # Cloud Scheduler sets some headers to default values: 1550 # 1551 # * `User-Agent`: By default, this header is 1552 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 1553 # This header can be modified, but Cloud Scheduler will append 1554 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 1555 # modified `User-Agent`. 1556 # * `X-CloudScheduler`: This header will be set to true. 1557 # 1558 # If the job has an body, Cloud Scheduler sets 1559 # the following headers: 1560 # 1561 # * `Content-Type`: By default, the `Content-Type` header is set to 1562 # `"application/octet-stream"`. The default can be overridden by explictly 1563 # setting `Content-Type` to a particular media type when the job is 1564 # created. 1565 # For example, `Content-Type` can be set to `"application/json"`. 1566 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 1567 # output only. It cannot be changed. 1568 # 1569 # The headers below are output only. They cannot be set or overridden: 1570 # 1571 # * `X-Google-*`: For Google internal use only. 1572 # * `X-AppEngine-*`: For Google internal use only. 1573 # 1574 # In addition, some App Engine headers, which contain 1575 # job-specific information, are also be sent to the job handler. 1576 "a_key": "A String", 1577 }, 1578 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 1579 # 1580 # For more information about services, versions, and instances see 1581 # [An Overview of App 1582 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 1583 # [Microservices Architecture on Google App 1584 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 1585 # [App Engine Standard request 1586 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 1587 # and [App Engine Flex request 1588 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 1589 "instance": "A String", # App instance. 1590 # 1591 # By default, the job is sent to an instance which is available when 1592 # the job is attempted. 1593 # 1594 # Requests can only be sent to a specific instance if 1595 # [manual scaling is used in App Engine 1596 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 1597 # App Engine Flex does not support instances. For more information, see 1598 # [App Engine Standard request 1599 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 1600 # and [App Engine Flex request 1601 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 1602 "host": "A String", # Output only. The host that the job is sent to. 1603 # 1604 # For more information about how App Engine requests are routed, see 1605 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 1606 # 1607 # The host is constructed as: 1608 # 1609 # 1610 # * `host = [application_domain_name]`</br> 1611 # `| [service] + '.' + [application_domain_name]`</br> 1612 # `| [version] + '.' + [application_domain_name]`</br> 1613 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 1614 # `| [instance] + '.' + [application_domain_name]`</br> 1615 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 1616 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 1617 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 1618 # 1619 # * `application_domain_name` = The domain name of the app, for 1620 # example <app-id>.appspot.com, which is associated with the 1621 # job's project ID. 1622 # 1623 # * `service =` service 1624 # 1625 # * `version =` version 1626 # 1627 # * `version_dot_service =` 1628 # version `+ '.' +` 1629 # service 1630 # 1631 # * `instance =` instance 1632 # 1633 # * `instance_dot_service =` 1634 # instance `+ '.' +` 1635 # service 1636 # 1637 # * `instance_dot_version =` 1638 # instance `+ '.' +` 1639 # version 1640 # 1641 # * `instance_dot_version_dot_service =` 1642 # instance `+ '.' +` 1643 # version `+ '.' +` 1644 # service 1645 # 1646 # 1647 # If service is empty, then the job will be sent 1648 # to the service which is the default service when the job is attempted. 1649 # 1650 # If version is empty, then the job will be sent 1651 # to the version which is the default version when the job is attempted. 1652 # 1653 # If instance is empty, then the job will be 1654 # sent to an instance which is available when the job is attempted. 1655 # 1656 # If service, 1657 # version, or 1658 # instance is invalid, then the job will be sent 1659 # to the default version of the default service when the job is attempted. 1660 "version": "A String", # App version. 1661 # 1662 # By default, the job is sent to the version which is the default 1663 # version when the job is attempted. 1664 "service": "A String", # App service. 1665 # 1666 # By default, the job is sent to the service which is the default 1667 # service when the job is attempted. 1668 }, 1669 "relativeUri": "A String", # The relative URI. 1670 # 1671 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 1672 # It can contain a path, query string arguments, and `#` fragments. 1673 # If the relative URL is empty, then the root path "/" will be used. 1674 # No spaces are allowed, and the maximum length allowed is 2083 characters. 1675 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 1676 # permitted. 1677 }, 1678 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 1679 "state": "A String", # Output only. State of the job. 1680 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 1681 # the given Pub/Sub topic. 1682 "attributes": { # Attributes for PubsubMessage. 1683 # 1684 # Pubsub message must contain either non-empty data, or at least one 1685 # attribute. 1686 "a_key": "A String", 1687 }, 1688 "data": "A String", # The message payload for PubsubMessage. 1689 # 1690 # Pubsub message must contain either non-empty data, or at least one 1691 # attribute. 1692 "topicName": "A String", # Required. 1693 # 1694 # The name of the Cloud Pub/Sub topic to which messages will 1695 # be published when a job is delivered. The topic name must be in the 1696 # same format as required by PubSub's 1697 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 1698 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 1699 # 1700 # The topic must be in the same project as the Cloud Scheduler job. 1701 }, 1702 "timeZone": "A String", # Specifies the time zone to be used in interpreting 1703 # schedule. The value of this field must be a time 1704 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 1705 # 1706 # Note that some time zones include a provision for 1707 # daylight savings time. The rules for daylight saving time are 1708 # determined by the chosen tz. For UTC use the string "utc". If a 1709 # time zone is not specified, the default will be in UTC (also known 1710 # as GMT). 1711 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 1712 # 1713 # By default, if a job does not complete successfully (meaning that 1714 # an acknowledgement is not received from the handler, then it will be retried 1715 # with exponential backoff according to the settings in RetryConfig. 1716 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 1717 # it fails. 1718 # 1719 # The default value of this field is 1 hour. 1720 "retryCount": 42, # The number of attempts that the system will make to run a job using the 1721 # exponential backoff procedure described by 1722 # max_doublings. 1723 # 1724 # The default value of retry_count is zero. 1725 # 1726 # If retry_count is zero, a job attempt will *not* be retried if 1727 # it fails. Instead the Cloud Scheduler system will wait for the 1728 # next scheduled execution time. 1729 # 1730 # If retry_count is set to a non-zero number then Cloud Scheduler 1731 # will retry failed attempts, using exponential backoff, 1732 # retry_count times, or until the next scheduled execution time, 1733 # whichever comes first. 1734 # 1735 # Values greater than 5 and negative values are not allowed. 1736 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 1737 # 1738 # A job's retry interval starts at 1739 # min_backoff_duration, then doubles 1740 # `max_doublings` times, then increases linearly, and finally 1741 # retries retries at intervals of 1742 # max_backoff_duration up to 1743 # retry_count times. 1744 # 1745 # For example, if min_backoff_duration is 1746 # 10s, max_backoff_duration is 300s, and 1747 # `max_doublings` is 3, then the a job will first be retried in 10s. The 1748 # retry interval will double three times, and then increase linearly by 1749 # 2^3 * 10s. Finally, the job will retry at intervals of 1750 # max_backoff_duration until the job has 1751 # been attempted retry_count times. Thus, the 1752 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 1753 # 1754 # The default value of this field is 5. 1755 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 1756 # execution was first attempted. If specified with 1757 # retry_count, the job will be retried until both 1758 # limits are reached. 1759 # 1760 # The default value for max_retry_duration is zero, which means retry 1761 # duration is unlimited. 1762 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 1763 # it fails. 1764 # 1765 # The default value of this field is 5 seconds. 1766 }, 1767 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 1768 # this deadline then the request is cancelled and the attempt is marked as a 1769 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 1770 # execution logs. Cloud Scheduler will retry the job according 1771 # to the RetryConfig. 1772 # 1773 # The allowed duration for this deadline is: 1774 # * For HTTP targets, between 15 seconds and 30 minutes. 1775 # * For App Engine HTTP targets, between 15 1776 # seconds and 24 hours. 1777 "userUpdateTime": "A String", # Output only. The creation time of the job. 1778 }, 1779 ], 1780 }</pre> 1781</div> 1782 1783<div class="method"> 1784 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 1785 <pre>Retrieves the next page of results. 1786 1787Args: 1788 previous_request: The request for the previous page. (required) 1789 previous_response: The response from the request for the previous page. (required) 1790 1791Returns: 1792 A request object that you can call 'execute()' on to request the next 1793 page. Returns None if there are no more items in the collection. 1794 </pre> 1795</div> 1796 1797<div class="method"> 1798 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 1799 <pre>Updates a job. 1800 1801If successful, the updated Job is returned. If the job does 1802not exist, `NOT_FOUND` is returned. 1803 1804If UpdateJob does not successfully return, it is possible for the 1805job to be in an Job.State.UPDATE_FAILED state. A job in this state may 1806not be executed. If this happens, retry the UpdateJob request 1807until a successful response is received. 1808 1809Args: 1810 name: string, Optionally caller-specified in CreateJob, after 1811which it becomes output only. 1812 1813The job name. For example: 1814`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 1815 1816* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 1817 hyphens (-), colons (:), or periods (.). 1818 For more information, see 1819 [Identifying 1820 projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 1821* `LOCATION_ID` is the canonical ID for the job's location. 1822 The list of available locations can be obtained by calling 1823 ListLocations. 1824 For more information, see https://cloud.google.com/about/locations/. 1825* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 1826 hyphens (-), or underscores (_). The maximum length is 500 characters. (required) 1827 body: object, The request body. (required) 1828 The object takes the form of: 1829 1830{ # Configuration for a job. 1831 # The maximum allowed size for a job is 100KB. 1832 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 1833 # different programming environments, including REST APIs and RPC APIs. It is 1834 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 1835 # three pieces of data: error code, error message, and error details. 1836 # 1837 # You can find out more about this error model and how to work with it in the 1838 # [API Design Guide](https://cloud.google.com/apis/design/errors). 1839 "message": "A String", # A developer-facing error message, which should be in English. Any 1840 # user-facing error message should be localized and sent in the 1841 # google.rpc.Status.details field, or localized by the client. 1842 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1843 "details": [ # A list of messages that carry the error details. There is a common set of 1844 # message types for APIs to use. 1845 { 1846 "a_key": "", # Properties of the object. Contains field @type with type URL. 1847 }, 1848 ], 1849 }, 1850 "description": "A String", # Optionally caller-specified in CreateJob or 1851 # UpdateJob. 1852 # 1853 # A human-readable description for the job. This string must not contain 1854 # more than 500 characters. 1855 "name": "A String", # Optionally caller-specified in CreateJob, after 1856 # which it becomes output only. 1857 # 1858 # The job name. For example: 1859 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 1860 # 1861 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 1862 # hyphens (-), colons (:), or periods (.). 1863 # For more information, see 1864 # [Identifying 1865 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 1866 # * `LOCATION_ID` is the canonical ID for the job's location. 1867 # The list of available locations can be obtained by calling 1868 # ListLocations. 1869 # For more information, see https://cloud.google.com/about/locations/. 1870 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 1871 # hyphens (-), or underscores (_). The maximum length is 500 characters. 1872 "schedule": "A String", # Required, except when used with UpdateJob. 1873 # 1874 # Describes the schedule on which the job will be executed. 1875 # 1876 # The schedule can be either of the following types: 1877 # 1878 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 1879 # * English-like 1880 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 1881 # 1882 # As a general rule, execution `n + 1` of a job will not begin 1883 # until execution `n` has finished. Cloud Scheduler will never 1884 # allow two simultaneously outstanding executions. For example, 1885 # this implies that if the `n+1`th execution is scheduled to run at 1886 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 1887 # execution will not start until `16:15`. 1888 # A scheduled start time will be delayed if the previous 1889 # execution has not ended when its scheduled time occurs. 1890 # 1891 # If retry_count > 0 and a job attempt fails, 1892 # the job will be tried a total of retry_count 1893 # times, with exponential backoff, until the next scheduled start 1894 # time. 1895 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 1896 # retry of a previously failed attempt or the next execution time 1897 # according to the schedule. 1898 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 1899 # an HTTP request via an http_method such as HTTP 1900 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 1901 # response code in the range [200 - 299]. A failure to receive a response 1902 # constitutes a failed execution. For a redirected request, the response 1903 # returned by the redirected request is considered. 1904 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 1905 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 1906 # incompatible HttpMethod. 1907 "headers": { # The user can specify HTTP request headers to send with the job's 1908 # HTTP request. This map contains the header field names and 1909 # values. Repeated headers are not supported, but a header value can 1910 # contain commas. These headers represent a subset of the headers 1911 # that will accompany the job's HTTP request. Some HTTP request 1912 # headers will be ignored or replaced. A partial list of headers that 1913 # will be ignored or replaced is below: 1914 # - Host: This will be computed by Cloud Scheduler and derived from 1915 # uri. 1916 # * `Content-Length`: This will be computed by Cloud Scheduler. 1917 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 1918 # * `X-Google-*`: Google internal use only. 1919 # * `X-AppEngine-*`: Google internal use only. 1920 # 1921 # The total size of headers must be less than 80KB. 1922 "a_key": "A String", 1923 }, 1924 "oidcToken": { # Contains information needed for generating an # If specified, an 1925 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 1926 # token will be generated and attached as an `Authorization` header in the 1927 # HTTP request. 1928 # 1929 # This type of authorization can be used for many scenarios, including 1930 # calling Cloud Run, or endpoints where you intend to validate the token 1931 # yourself. 1932 # [OpenID Connect 1933 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 1934 # This type of authorization can be used for many scenarios, including 1935 # calling Cloud Run, or endpoints where you intend to validate the token 1936 # yourself. 1937 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 1938 # specified in target will be used. 1939 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1940 # to be used for generating OIDC token. 1941 # The service account must be within the same project as the job. The caller 1942 # must have iam.serviceAccounts.actAs permission for the service account. 1943 }, 1944 "uri": "A String", # Required. 1945 # 1946 # The full URI path that the request will be sent to. This string 1947 # must begin with either "http://" or "https://". Some examples of 1948 # valid values for uri are: 1949 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 1950 # encode some characters for safety and compatibility. The maximum allowed 1951 # URL length is 2083 characters after encoding. 1952 "oauthToken": { # Contains information needed for generating an # If specified, an 1953 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 1954 # will be generated and attached as an `Authorization` header in the HTTP 1955 # request. 1956 # 1957 # This type of authorization should generally only be used when calling 1958 # Google APIs hosted on *.googleapis.com. 1959 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 1960 # This type of authorization should generally only be used when calling Google 1961 # APIs hosted on *.googleapis.com. 1962 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 1963 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 1964 # will be used. 1965 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 1966 # to be used for generating OAuth token. 1967 # The service account must be within the same project as the job. The caller 1968 # must have iam.serviceAccounts.actAs permission for the service account. 1969 }, 1970 "httpMethod": "A String", # Which HTTP method to use for the request. 1971 }, 1972 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 1973 # of an HTTP request via an http_method such 1974 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 1975 # HTTP response code in the range [200 - 299]. Error 503 is 1976 # considered an App Engine system error instead of an application 1977 # error. Requests returning error 503 will be retried regardless of 1978 # retry configuration and not counted against retry counts. Any other 1979 # response code, or a failure to receive a response before the 1980 # deadline, constitutes a failed attempt. 1981 "body": "A String", # Body. 1982 # 1983 # HTTP request body. A request body is allowed only if the HTTP method is 1984 # POST or PUT. It will result in invalid argument error to set a body on a 1985 # job with an incompatible HttpMethod. 1986 "headers": { # HTTP request headers. 1987 # 1988 # This map contains the header field names and values. Headers can be set 1989 # when the job is created. 1990 # 1991 # Cloud Scheduler sets some headers to default values: 1992 # 1993 # * `User-Agent`: By default, this header is 1994 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 1995 # This header can be modified, but Cloud Scheduler will append 1996 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 1997 # modified `User-Agent`. 1998 # * `X-CloudScheduler`: This header will be set to true. 1999 # 2000 # If the job has an body, Cloud Scheduler sets 2001 # the following headers: 2002 # 2003 # * `Content-Type`: By default, the `Content-Type` header is set to 2004 # `"application/octet-stream"`. The default can be overridden by explictly 2005 # setting `Content-Type` to a particular media type when the job is 2006 # created. 2007 # For example, `Content-Type` can be set to `"application/json"`. 2008 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 2009 # output only. It cannot be changed. 2010 # 2011 # The headers below are output only. They cannot be set or overridden: 2012 # 2013 # * `X-Google-*`: For Google internal use only. 2014 # * `X-AppEngine-*`: For Google internal use only. 2015 # 2016 # In addition, some App Engine headers, which contain 2017 # job-specific information, are also be sent to the job handler. 2018 "a_key": "A String", 2019 }, 2020 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 2021 # 2022 # For more information about services, versions, and instances see 2023 # [An Overview of App 2024 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 2025 # [Microservices Architecture on Google App 2026 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 2027 # [App Engine Standard request 2028 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 2029 # and [App Engine Flex request 2030 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2031 "instance": "A String", # App instance. 2032 # 2033 # By default, the job is sent to an instance which is available when 2034 # the job is attempted. 2035 # 2036 # Requests can only be sent to a specific instance if 2037 # [manual scaling is used in App Engine 2038 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 2039 # App Engine Flex does not support instances. For more information, see 2040 # [App Engine Standard request 2041 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 2042 # and [App Engine Flex request 2043 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2044 "host": "A String", # Output only. The host that the job is sent to. 2045 # 2046 # For more information about how App Engine requests are routed, see 2047 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 2048 # 2049 # The host is constructed as: 2050 # 2051 # 2052 # * `host = [application_domain_name]`</br> 2053 # `| [service] + '.' + [application_domain_name]`</br> 2054 # `| [version] + '.' + [application_domain_name]`</br> 2055 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 2056 # `| [instance] + '.' + [application_domain_name]`</br> 2057 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 2058 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 2059 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 2060 # 2061 # * `application_domain_name` = The domain name of the app, for 2062 # example <app-id>.appspot.com, which is associated with the 2063 # job's project ID. 2064 # 2065 # * `service =` service 2066 # 2067 # * `version =` version 2068 # 2069 # * `version_dot_service =` 2070 # version `+ '.' +` 2071 # service 2072 # 2073 # * `instance =` instance 2074 # 2075 # * `instance_dot_service =` 2076 # instance `+ '.' +` 2077 # service 2078 # 2079 # * `instance_dot_version =` 2080 # instance `+ '.' +` 2081 # version 2082 # 2083 # * `instance_dot_version_dot_service =` 2084 # instance `+ '.' +` 2085 # version `+ '.' +` 2086 # service 2087 # 2088 # 2089 # If service is empty, then the job will be sent 2090 # to the service which is the default service when the job is attempted. 2091 # 2092 # If version is empty, then the job will be sent 2093 # to the version which is the default version when the job is attempted. 2094 # 2095 # If instance is empty, then the job will be 2096 # sent to an instance which is available when the job is attempted. 2097 # 2098 # If service, 2099 # version, or 2100 # instance is invalid, then the job will be sent 2101 # to the default version of the default service when the job is attempted. 2102 "version": "A String", # App version. 2103 # 2104 # By default, the job is sent to the version which is the default 2105 # version when the job is attempted. 2106 "service": "A String", # App service. 2107 # 2108 # By default, the job is sent to the service which is the default 2109 # service when the job is attempted. 2110 }, 2111 "relativeUri": "A String", # The relative URI. 2112 # 2113 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 2114 # It can contain a path, query string arguments, and `#` fragments. 2115 # If the relative URL is empty, then the root path "/" will be used. 2116 # No spaces are allowed, and the maximum length allowed is 2083 characters. 2117 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 2118 # permitted. 2119 }, 2120 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 2121 "state": "A String", # Output only. State of the job. 2122 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 2123 # the given Pub/Sub topic. 2124 "attributes": { # Attributes for PubsubMessage. 2125 # 2126 # Pubsub message must contain either non-empty data, or at least one 2127 # attribute. 2128 "a_key": "A String", 2129 }, 2130 "data": "A String", # The message payload for PubsubMessage. 2131 # 2132 # Pubsub message must contain either non-empty data, or at least one 2133 # attribute. 2134 "topicName": "A String", # Required. 2135 # 2136 # The name of the Cloud Pub/Sub topic to which messages will 2137 # be published when a job is delivered. The topic name must be in the 2138 # same format as required by PubSub's 2139 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 2140 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 2141 # 2142 # The topic must be in the same project as the Cloud Scheduler job. 2143 }, 2144 "timeZone": "A String", # Specifies the time zone to be used in interpreting 2145 # schedule. The value of this field must be a time 2146 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 2147 # 2148 # Note that some time zones include a provision for 2149 # daylight savings time. The rules for daylight saving time are 2150 # determined by the chosen tz. For UTC use the string "utc". If a 2151 # time zone is not specified, the default will be in UTC (also known 2152 # as GMT). 2153 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 2154 # 2155 # By default, if a job does not complete successfully (meaning that 2156 # an acknowledgement is not received from the handler, then it will be retried 2157 # with exponential backoff according to the settings in RetryConfig. 2158 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 2159 # it fails. 2160 # 2161 # The default value of this field is 1 hour. 2162 "retryCount": 42, # The number of attempts that the system will make to run a job using the 2163 # exponential backoff procedure described by 2164 # max_doublings. 2165 # 2166 # The default value of retry_count is zero. 2167 # 2168 # If retry_count is zero, a job attempt will *not* be retried if 2169 # it fails. Instead the Cloud Scheduler system will wait for the 2170 # next scheduled execution time. 2171 # 2172 # If retry_count is set to a non-zero number then Cloud Scheduler 2173 # will retry failed attempts, using exponential backoff, 2174 # retry_count times, or until the next scheduled execution time, 2175 # whichever comes first. 2176 # 2177 # Values greater than 5 and negative values are not allowed. 2178 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 2179 # 2180 # A job's retry interval starts at 2181 # min_backoff_duration, then doubles 2182 # `max_doublings` times, then increases linearly, and finally 2183 # retries retries at intervals of 2184 # max_backoff_duration up to 2185 # retry_count times. 2186 # 2187 # For example, if min_backoff_duration is 2188 # 10s, max_backoff_duration is 300s, and 2189 # `max_doublings` is 3, then the a job will first be retried in 10s. The 2190 # retry interval will double three times, and then increase linearly by 2191 # 2^3 * 10s. Finally, the job will retry at intervals of 2192 # max_backoff_duration until the job has 2193 # been attempted retry_count times. Thus, the 2194 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 2195 # 2196 # The default value of this field is 5. 2197 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 2198 # execution was first attempted. If specified with 2199 # retry_count, the job will be retried until both 2200 # limits are reached. 2201 # 2202 # The default value for max_retry_duration is zero, which means retry 2203 # duration is unlimited. 2204 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 2205 # it fails. 2206 # 2207 # The default value of this field is 5 seconds. 2208 }, 2209 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 2210 # this deadline then the request is cancelled and the attempt is marked as a 2211 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 2212 # execution logs. Cloud Scheduler will retry the job according 2213 # to the RetryConfig. 2214 # 2215 # The allowed duration for this deadline is: 2216 # * For HTTP targets, between 15 seconds and 30 minutes. 2217 # * For App Engine HTTP targets, between 15 2218 # seconds and 24 hours. 2219 "userUpdateTime": "A String", # Output only. The creation time of the job. 2220} 2221 2222 updateMask: string, A mask used to specify which fields of the job are being updated. 2223 x__xgafv: string, V1 error format. 2224 Allowed values 2225 1 - v1 error format 2226 2 - v2 error format 2227 2228Returns: 2229 An object of the form: 2230 2231 { # Configuration for a job. 2232 # The maximum allowed size for a job is 100KB. 2233 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 2234 # different programming environments, including REST APIs and RPC APIs. It is 2235 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 2236 # three pieces of data: error code, error message, and error details. 2237 # 2238 # You can find out more about this error model and how to work with it in the 2239 # [API Design Guide](https://cloud.google.com/apis/design/errors). 2240 "message": "A String", # A developer-facing error message, which should be in English. Any 2241 # user-facing error message should be localized and sent in the 2242 # google.rpc.Status.details field, or localized by the client. 2243 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 2244 "details": [ # A list of messages that carry the error details. There is a common set of 2245 # message types for APIs to use. 2246 { 2247 "a_key": "", # Properties of the object. Contains field @type with type URL. 2248 }, 2249 ], 2250 }, 2251 "description": "A String", # Optionally caller-specified in CreateJob or 2252 # UpdateJob. 2253 # 2254 # A human-readable description for the job. This string must not contain 2255 # more than 500 characters. 2256 "name": "A String", # Optionally caller-specified in CreateJob, after 2257 # which it becomes output only. 2258 # 2259 # The job name. For example: 2260 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 2261 # 2262 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 2263 # hyphens (-), colons (:), or periods (.). 2264 # For more information, see 2265 # [Identifying 2266 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 2267 # * `LOCATION_ID` is the canonical ID for the job's location. 2268 # The list of available locations can be obtained by calling 2269 # ListLocations. 2270 # For more information, see https://cloud.google.com/about/locations/. 2271 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 2272 # hyphens (-), or underscores (_). The maximum length is 500 characters. 2273 "schedule": "A String", # Required, except when used with UpdateJob. 2274 # 2275 # Describes the schedule on which the job will be executed. 2276 # 2277 # The schedule can be either of the following types: 2278 # 2279 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 2280 # * English-like 2281 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 2282 # 2283 # As a general rule, execution `n + 1` of a job will not begin 2284 # until execution `n` has finished. Cloud Scheduler will never 2285 # allow two simultaneously outstanding executions. For example, 2286 # this implies that if the `n+1`th execution is scheduled to run at 2287 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 2288 # execution will not start until `16:15`. 2289 # A scheduled start time will be delayed if the previous 2290 # execution has not ended when its scheduled time occurs. 2291 # 2292 # If retry_count > 0 and a job attempt fails, 2293 # the job will be tried a total of retry_count 2294 # times, with exponential backoff, until the next scheduled start 2295 # time. 2296 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 2297 # retry of a previously failed attempt or the next execution time 2298 # according to the schedule. 2299 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 2300 # an HTTP request via an http_method such as HTTP 2301 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 2302 # response code in the range [200 - 299]. A failure to receive a response 2303 # constitutes a failed execution. For a redirected request, the response 2304 # returned by the redirected request is considered. 2305 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 2306 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 2307 # incompatible HttpMethod. 2308 "headers": { # The user can specify HTTP request headers to send with the job's 2309 # HTTP request. This map contains the header field names and 2310 # values. Repeated headers are not supported, but a header value can 2311 # contain commas. These headers represent a subset of the headers 2312 # that will accompany the job's HTTP request. Some HTTP request 2313 # headers will be ignored or replaced. A partial list of headers that 2314 # will be ignored or replaced is below: 2315 # - Host: This will be computed by Cloud Scheduler and derived from 2316 # uri. 2317 # * `Content-Length`: This will be computed by Cloud Scheduler. 2318 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 2319 # * `X-Google-*`: Google internal use only. 2320 # * `X-AppEngine-*`: Google internal use only. 2321 # 2322 # The total size of headers must be less than 80KB. 2323 "a_key": "A String", 2324 }, 2325 "oidcToken": { # Contains information needed for generating an # If specified, an 2326 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 2327 # token will be generated and attached as an `Authorization` header in the 2328 # HTTP request. 2329 # 2330 # This type of authorization can be used for many scenarios, including 2331 # calling Cloud Run, or endpoints where you intend to validate the token 2332 # yourself. 2333 # [OpenID Connect 2334 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 2335 # This type of authorization can be used for many scenarios, including 2336 # calling Cloud Run, or endpoints where you intend to validate the token 2337 # yourself. 2338 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 2339 # specified in target will be used. 2340 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 2341 # to be used for generating OIDC token. 2342 # The service account must be within the same project as the job. The caller 2343 # must have iam.serviceAccounts.actAs permission for the service account. 2344 }, 2345 "uri": "A String", # Required. 2346 # 2347 # The full URI path that the request will be sent to. This string 2348 # must begin with either "http://" or "https://". Some examples of 2349 # valid values for uri are: 2350 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 2351 # encode some characters for safety and compatibility. The maximum allowed 2352 # URL length is 2083 characters after encoding. 2353 "oauthToken": { # Contains information needed for generating an # If specified, an 2354 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 2355 # will be generated and attached as an `Authorization` header in the HTTP 2356 # request. 2357 # 2358 # This type of authorization should generally only be used when calling 2359 # Google APIs hosted on *.googleapis.com. 2360 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 2361 # This type of authorization should generally only be used when calling Google 2362 # APIs hosted on *.googleapis.com. 2363 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 2364 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 2365 # will be used. 2366 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 2367 # to be used for generating OAuth token. 2368 # The service account must be within the same project as the job. The caller 2369 # must have iam.serviceAccounts.actAs permission for the service account. 2370 }, 2371 "httpMethod": "A String", # Which HTTP method to use for the request. 2372 }, 2373 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 2374 # of an HTTP request via an http_method such 2375 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 2376 # HTTP response code in the range [200 - 299]. Error 503 is 2377 # considered an App Engine system error instead of an application 2378 # error. Requests returning error 503 will be retried regardless of 2379 # retry configuration and not counted against retry counts. Any other 2380 # response code, or a failure to receive a response before the 2381 # deadline, constitutes a failed attempt. 2382 "body": "A String", # Body. 2383 # 2384 # HTTP request body. A request body is allowed only if the HTTP method is 2385 # POST or PUT. It will result in invalid argument error to set a body on a 2386 # job with an incompatible HttpMethod. 2387 "headers": { # HTTP request headers. 2388 # 2389 # This map contains the header field names and values. Headers can be set 2390 # when the job is created. 2391 # 2392 # Cloud Scheduler sets some headers to default values: 2393 # 2394 # * `User-Agent`: By default, this header is 2395 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 2396 # This header can be modified, but Cloud Scheduler will append 2397 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 2398 # modified `User-Agent`. 2399 # * `X-CloudScheduler`: This header will be set to true. 2400 # 2401 # If the job has an body, Cloud Scheduler sets 2402 # the following headers: 2403 # 2404 # * `Content-Type`: By default, the `Content-Type` header is set to 2405 # `"application/octet-stream"`. The default can be overridden by explictly 2406 # setting `Content-Type` to a particular media type when the job is 2407 # created. 2408 # For example, `Content-Type` can be set to `"application/json"`. 2409 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 2410 # output only. It cannot be changed. 2411 # 2412 # The headers below are output only. They cannot be set or overridden: 2413 # 2414 # * `X-Google-*`: For Google internal use only. 2415 # * `X-AppEngine-*`: For Google internal use only. 2416 # 2417 # In addition, some App Engine headers, which contain 2418 # job-specific information, are also be sent to the job handler. 2419 "a_key": "A String", 2420 }, 2421 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 2422 # 2423 # For more information about services, versions, and instances see 2424 # [An Overview of App 2425 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 2426 # [Microservices Architecture on Google App 2427 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 2428 # [App Engine Standard request 2429 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 2430 # and [App Engine Flex request 2431 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2432 "instance": "A String", # App instance. 2433 # 2434 # By default, the job is sent to an instance which is available when 2435 # the job is attempted. 2436 # 2437 # Requests can only be sent to a specific instance if 2438 # [manual scaling is used in App Engine 2439 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 2440 # App Engine Flex does not support instances. For more information, see 2441 # [App Engine Standard request 2442 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 2443 # and [App Engine Flex request 2444 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2445 "host": "A String", # Output only. The host that the job is sent to. 2446 # 2447 # For more information about how App Engine requests are routed, see 2448 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 2449 # 2450 # The host is constructed as: 2451 # 2452 # 2453 # * `host = [application_domain_name]`</br> 2454 # `| [service] + '.' + [application_domain_name]`</br> 2455 # `| [version] + '.' + [application_domain_name]`</br> 2456 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 2457 # `| [instance] + '.' + [application_domain_name]`</br> 2458 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 2459 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 2460 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 2461 # 2462 # * `application_domain_name` = The domain name of the app, for 2463 # example <app-id>.appspot.com, which is associated with the 2464 # job's project ID. 2465 # 2466 # * `service =` service 2467 # 2468 # * `version =` version 2469 # 2470 # * `version_dot_service =` 2471 # version `+ '.' +` 2472 # service 2473 # 2474 # * `instance =` instance 2475 # 2476 # * `instance_dot_service =` 2477 # instance `+ '.' +` 2478 # service 2479 # 2480 # * `instance_dot_version =` 2481 # instance `+ '.' +` 2482 # version 2483 # 2484 # * `instance_dot_version_dot_service =` 2485 # instance `+ '.' +` 2486 # version `+ '.' +` 2487 # service 2488 # 2489 # 2490 # If service is empty, then the job will be sent 2491 # to the service which is the default service when the job is attempted. 2492 # 2493 # If version is empty, then the job will be sent 2494 # to the version which is the default version when the job is attempted. 2495 # 2496 # If instance is empty, then the job will be 2497 # sent to an instance which is available when the job is attempted. 2498 # 2499 # If service, 2500 # version, or 2501 # instance is invalid, then the job will be sent 2502 # to the default version of the default service when the job is attempted. 2503 "version": "A String", # App version. 2504 # 2505 # By default, the job is sent to the version which is the default 2506 # version when the job is attempted. 2507 "service": "A String", # App service. 2508 # 2509 # By default, the job is sent to the service which is the default 2510 # service when the job is attempted. 2511 }, 2512 "relativeUri": "A String", # The relative URI. 2513 # 2514 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 2515 # It can contain a path, query string arguments, and `#` fragments. 2516 # If the relative URL is empty, then the root path "/" will be used. 2517 # No spaces are allowed, and the maximum length allowed is 2083 characters. 2518 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 2519 # permitted. 2520 }, 2521 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 2522 "state": "A String", # Output only. State of the job. 2523 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 2524 # the given Pub/Sub topic. 2525 "attributes": { # Attributes for PubsubMessage. 2526 # 2527 # Pubsub message must contain either non-empty data, or at least one 2528 # attribute. 2529 "a_key": "A String", 2530 }, 2531 "data": "A String", # The message payload for PubsubMessage. 2532 # 2533 # Pubsub message must contain either non-empty data, or at least one 2534 # attribute. 2535 "topicName": "A String", # Required. 2536 # 2537 # The name of the Cloud Pub/Sub topic to which messages will 2538 # be published when a job is delivered. The topic name must be in the 2539 # same format as required by PubSub's 2540 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 2541 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 2542 # 2543 # The topic must be in the same project as the Cloud Scheduler job. 2544 }, 2545 "timeZone": "A String", # Specifies the time zone to be used in interpreting 2546 # schedule. The value of this field must be a time 2547 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 2548 # 2549 # Note that some time zones include a provision for 2550 # daylight savings time. The rules for daylight saving time are 2551 # determined by the chosen tz. For UTC use the string "utc". If a 2552 # time zone is not specified, the default will be in UTC (also known 2553 # as GMT). 2554 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 2555 # 2556 # By default, if a job does not complete successfully (meaning that 2557 # an acknowledgement is not received from the handler, then it will be retried 2558 # with exponential backoff according to the settings in RetryConfig. 2559 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 2560 # it fails. 2561 # 2562 # The default value of this field is 1 hour. 2563 "retryCount": 42, # The number of attempts that the system will make to run a job using the 2564 # exponential backoff procedure described by 2565 # max_doublings. 2566 # 2567 # The default value of retry_count is zero. 2568 # 2569 # If retry_count is zero, a job attempt will *not* be retried if 2570 # it fails. Instead the Cloud Scheduler system will wait for the 2571 # next scheduled execution time. 2572 # 2573 # If retry_count is set to a non-zero number then Cloud Scheduler 2574 # will retry failed attempts, using exponential backoff, 2575 # retry_count times, or until the next scheduled execution time, 2576 # whichever comes first. 2577 # 2578 # Values greater than 5 and negative values are not allowed. 2579 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 2580 # 2581 # A job's retry interval starts at 2582 # min_backoff_duration, then doubles 2583 # `max_doublings` times, then increases linearly, and finally 2584 # retries retries at intervals of 2585 # max_backoff_duration up to 2586 # retry_count times. 2587 # 2588 # For example, if min_backoff_duration is 2589 # 10s, max_backoff_duration is 300s, and 2590 # `max_doublings` is 3, then the a job will first be retried in 10s. The 2591 # retry interval will double three times, and then increase linearly by 2592 # 2^3 * 10s. Finally, the job will retry at intervals of 2593 # max_backoff_duration until the job has 2594 # been attempted retry_count times. Thus, the 2595 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 2596 # 2597 # The default value of this field is 5. 2598 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 2599 # execution was first attempted. If specified with 2600 # retry_count, the job will be retried until both 2601 # limits are reached. 2602 # 2603 # The default value for max_retry_duration is zero, which means retry 2604 # duration is unlimited. 2605 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 2606 # it fails. 2607 # 2608 # The default value of this field is 5 seconds. 2609 }, 2610 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 2611 # this deadline then the request is cancelled and the attempt is marked as a 2612 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 2613 # execution logs. Cloud Scheduler will retry the job according 2614 # to the RetryConfig. 2615 # 2616 # The allowed duration for this deadline is: 2617 # * For HTTP targets, between 15 seconds and 30 minutes. 2618 # * For App Engine HTTP targets, between 15 2619 # seconds and 24 hours. 2620 "userUpdateTime": "A String", # Output only. The creation time of the job. 2621 }</pre> 2622</div> 2623 2624<div class="method"> 2625 <code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code> 2626 <pre>Pauses a job. 2627 2628If a job is paused then the system will stop executing the job 2629until it is re-enabled via ResumeJob. The 2630state of the job is stored in state; if paused it 2631will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED 2632to be paused. 2633 2634Args: 2635 name: string, Required. 2636 2637The job name. For example: 2638`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required) 2639 body: object, The request body. 2640 The object takes the form of: 2641 2642{ # Request message for PauseJob. 2643 } 2644 2645 x__xgafv: string, V1 error format. 2646 Allowed values 2647 1 - v1 error format 2648 2 - v2 error format 2649 2650Returns: 2651 An object of the form: 2652 2653 { # Configuration for a job. 2654 # The maximum allowed size for a job is 100KB. 2655 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 2656 # different programming environments, including REST APIs and RPC APIs. It is 2657 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 2658 # three pieces of data: error code, error message, and error details. 2659 # 2660 # You can find out more about this error model and how to work with it in the 2661 # [API Design Guide](https://cloud.google.com/apis/design/errors). 2662 "message": "A String", # A developer-facing error message, which should be in English. Any 2663 # user-facing error message should be localized and sent in the 2664 # google.rpc.Status.details field, or localized by the client. 2665 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 2666 "details": [ # A list of messages that carry the error details. There is a common set of 2667 # message types for APIs to use. 2668 { 2669 "a_key": "", # Properties of the object. Contains field @type with type URL. 2670 }, 2671 ], 2672 }, 2673 "description": "A String", # Optionally caller-specified in CreateJob or 2674 # UpdateJob. 2675 # 2676 # A human-readable description for the job. This string must not contain 2677 # more than 500 characters. 2678 "name": "A String", # Optionally caller-specified in CreateJob, after 2679 # which it becomes output only. 2680 # 2681 # The job name. For example: 2682 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 2683 # 2684 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 2685 # hyphens (-), colons (:), or periods (.). 2686 # For more information, see 2687 # [Identifying 2688 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 2689 # * `LOCATION_ID` is the canonical ID for the job's location. 2690 # The list of available locations can be obtained by calling 2691 # ListLocations. 2692 # For more information, see https://cloud.google.com/about/locations/. 2693 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 2694 # hyphens (-), or underscores (_). The maximum length is 500 characters. 2695 "schedule": "A String", # Required, except when used with UpdateJob. 2696 # 2697 # Describes the schedule on which the job will be executed. 2698 # 2699 # The schedule can be either of the following types: 2700 # 2701 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 2702 # * English-like 2703 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 2704 # 2705 # As a general rule, execution `n + 1` of a job will not begin 2706 # until execution `n` has finished. Cloud Scheduler will never 2707 # allow two simultaneously outstanding executions. For example, 2708 # this implies that if the `n+1`th execution is scheduled to run at 2709 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 2710 # execution will not start until `16:15`. 2711 # A scheduled start time will be delayed if the previous 2712 # execution has not ended when its scheduled time occurs. 2713 # 2714 # If retry_count > 0 and a job attempt fails, 2715 # the job will be tried a total of retry_count 2716 # times, with exponential backoff, until the next scheduled start 2717 # time. 2718 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 2719 # retry of a previously failed attempt or the next execution time 2720 # according to the schedule. 2721 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 2722 # an HTTP request via an http_method such as HTTP 2723 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 2724 # response code in the range [200 - 299]. A failure to receive a response 2725 # constitutes a failed execution. For a redirected request, the response 2726 # returned by the redirected request is considered. 2727 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 2728 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 2729 # incompatible HttpMethod. 2730 "headers": { # The user can specify HTTP request headers to send with the job's 2731 # HTTP request. This map contains the header field names and 2732 # values. Repeated headers are not supported, but a header value can 2733 # contain commas. These headers represent a subset of the headers 2734 # that will accompany the job's HTTP request. Some HTTP request 2735 # headers will be ignored or replaced. A partial list of headers that 2736 # will be ignored or replaced is below: 2737 # - Host: This will be computed by Cloud Scheduler and derived from 2738 # uri. 2739 # * `Content-Length`: This will be computed by Cloud Scheduler. 2740 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 2741 # * `X-Google-*`: Google internal use only. 2742 # * `X-AppEngine-*`: Google internal use only. 2743 # 2744 # The total size of headers must be less than 80KB. 2745 "a_key": "A String", 2746 }, 2747 "oidcToken": { # Contains information needed for generating an # If specified, an 2748 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 2749 # token will be generated and attached as an `Authorization` header in the 2750 # HTTP request. 2751 # 2752 # This type of authorization can be used for many scenarios, including 2753 # calling Cloud Run, or endpoints where you intend to validate the token 2754 # yourself. 2755 # [OpenID Connect 2756 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 2757 # This type of authorization can be used for many scenarios, including 2758 # calling Cloud Run, or endpoints where you intend to validate the token 2759 # yourself. 2760 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 2761 # specified in target will be used. 2762 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 2763 # to be used for generating OIDC token. 2764 # The service account must be within the same project as the job. The caller 2765 # must have iam.serviceAccounts.actAs permission for the service account. 2766 }, 2767 "uri": "A String", # Required. 2768 # 2769 # The full URI path that the request will be sent to. This string 2770 # must begin with either "http://" or "https://". Some examples of 2771 # valid values for uri are: 2772 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 2773 # encode some characters for safety and compatibility. The maximum allowed 2774 # URL length is 2083 characters after encoding. 2775 "oauthToken": { # Contains information needed for generating an # If specified, an 2776 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 2777 # will be generated and attached as an `Authorization` header in the HTTP 2778 # request. 2779 # 2780 # This type of authorization should generally only be used when calling 2781 # Google APIs hosted on *.googleapis.com. 2782 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 2783 # This type of authorization should generally only be used when calling Google 2784 # APIs hosted on *.googleapis.com. 2785 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 2786 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 2787 # will be used. 2788 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 2789 # to be used for generating OAuth token. 2790 # The service account must be within the same project as the job. The caller 2791 # must have iam.serviceAccounts.actAs permission for the service account. 2792 }, 2793 "httpMethod": "A String", # Which HTTP method to use for the request. 2794 }, 2795 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 2796 # of an HTTP request via an http_method such 2797 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 2798 # HTTP response code in the range [200 - 299]. Error 503 is 2799 # considered an App Engine system error instead of an application 2800 # error. Requests returning error 503 will be retried regardless of 2801 # retry configuration and not counted against retry counts. Any other 2802 # response code, or a failure to receive a response before the 2803 # deadline, constitutes a failed attempt. 2804 "body": "A String", # Body. 2805 # 2806 # HTTP request body. A request body is allowed only if the HTTP method is 2807 # POST or PUT. It will result in invalid argument error to set a body on a 2808 # job with an incompatible HttpMethod. 2809 "headers": { # HTTP request headers. 2810 # 2811 # This map contains the header field names and values. Headers can be set 2812 # when the job is created. 2813 # 2814 # Cloud Scheduler sets some headers to default values: 2815 # 2816 # * `User-Agent`: By default, this header is 2817 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 2818 # This header can be modified, but Cloud Scheduler will append 2819 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 2820 # modified `User-Agent`. 2821 # * `X-CloudScheduler`: This header will be set to true. 2822 # 2823 # If the job has an body, Cloud Scheduler sets 2824 # the following headers: 2825 # 2826 # * `Content-Type`: By default, the `Content-Type` header is set to 2827 # `"application/octet-stream"`. The default can be overridden by explictly 2828 # setting `Content-Type` to a particular media type when the job is 2829 # created. 2830 # For example, `Content-Type` can be set to `"application/json"`. 2831 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 2832 # output only. It cannot be changed. 2833 # 2834 # The headers below are output only. They cannot be set or overridden: 2835 # 2836 # * `X-Google-*`: For Google internal use only. 2837 # * `X-AppEngine-*`: For Google internal use only. 2838 # 2839 # In addition, some App Engine headers, which contain 2840 # job-specific information, are also be sent to the job handler. 2841 "a_key": "A String", 2842 }, 2843 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 2844 # 2845 # For more information about services, versions, and instances see 2846 # [An Overview of App 2847 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 2848 # [Microservices Architecture on Google App 2849 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 2850 # [App Engine Standard request 2851 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 2852 # and [App Engine Flex request 2853 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2854 "instance": "A String", # App instance. 2855 # 2856 # By default, the job is sent to an instance which is available when 2857 # the job is attempted. 2858 # 2859 # Requests can only be sent to a specific instance if 2860 # [manual scaling is used in App Engine 2861 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 2862 # App Engine Flex does not support instances. For more information, see 2863 # [App Engine Standard request 2864 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 2865 # and [App Engine Flex request 2866 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 2867 "host": "A String", # Output only. The host that the job is sent to. 2868 # 2869 # For more information about how App Engine requests are routed, see 2870 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 2871 # 2872 # The host is constructed as: 2873 # 2874 # 2875 # * `host = [application_domain_name]`</br> 2876 # `| [service] + '.' + [application_domain_name]`</br> 2877 # `| [version] + '.' + [application_domain_name]`</br> 2878 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 2879 # `| [instance] + '.' + [application_domain_name]`</br> 2880 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 2881 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 2882 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 2883 # 2884 # * `application_domain_name` = The domain name of the app, for 2885 # example <app-id>.appspot.com, which is associated with the 2886 # job's project ID. 2887 # 2888 # * `service =` service 2889 # 2890 # * `version =` version 2891 # 2892 # * `version_dot_service =` 2893 # version `+ '.' +` 2894 # service 2895 # 2896 # * `instance =` instance 2897 # 2898 # * `instance_dot_service =` 2899 # instance `+ '.' +` 2900 # service 2901 # 2902 # * `instance_dot_version =` 2903 # instance `+ '.' +` 2904 # version 2905 # 2906 # * `instance_dot_version_dot_service =` 2907 # instance `+ '.' +` 2908 # version `+ '.' +` 2909 # service 2910 # 2911 # 2912 # If service is empty, then the job will be sent 2913 # to the service which is the default service when the job is attempted. 2914 # 2915 # If version is empty, then the job will be sent 2916 # to the version which is the default version when the job is attempted. 2917 # 2918 # If instance is empty, then the job will be 2919 # sent to an instance which is available when the job is attempted. 2920 # 2921 # If service, 2922 # version, or 2923 # instance is invalid, then the job will be sent 2924 # to the default version of the default service when the job is attempted. 2925 "version": "A String", # App version. 2926 # 2927 # By default, the job is sent to the version which is the default 2928 # version when the job is attempted. 2929 "service": "A String", # App service. 2930 # 2931 # By default, the job is sent to the service which is the default 2932 # service when the job is attempted. 2933 }, 2934 "relativeUri": "A String", # The relative URI. 2935 # 2936 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 2937 # It can contain a path, query string arguments, and `#` fragments. 2938 # If the relative URL is empty, then the root path "/" will be used. 2939 # No spaces are allowed, and the maximum length allowed is 2083 characters. 2940 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 2941 # permitted. 2942 }, 2943 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 2944 "state": "A String", # Output only. State of the job. 2945 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 2946 # the given Pub/Sub topic. 2947 "attributes": { # Attributes for PubsubMessage. 2948 # 2949 # Pubsub message must contain either non-empty data, or at least one 2950 # attribute. 2951 "a_key": "A String", 2952 }, 2953 "data": "A String", # The message payload for PubsubMessage. 2954 # 2955 # Pubsub message must contain either non-empty data, or at least one 2956 # attribute. 2957 "topicName": "A String", # Required. 2958 # 2959 # The name of the Cloud Pub/Sub topic to which messages will 2960 # be published when a job is delivered. The topic name must be in the 2961 # same format as required by PubSub's 2962 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 2963 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 2964 # 2965 # The topic must be in the same project as the Cloud Scheduler job. 2966 }, 2967 "timeZone": "A String", # Specifies the time zone to be used in interpreting 2968 # schedule. The value of this field must be a time 2969 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 2970 # 2971 # Note that some time zones include a provision for 2972 # daylight savings time. The rules for daylight saving time are 2973 # determined by the chosen tz. For UTC use the string "utc". If a 2974 # time zone is not specified, the default will be in UTC (also known 2975 # as GMT). 2976 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 2977 # 2978 # By default, if a job does not complete successfully (meaning that 2979 # an acknowledgement is not received from the handler, then it will be retried 2980 # with exponential backoff according to the settings in RetryConfig. 2981 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 2982 # it fails. 2983 # 2984 # The default value of this field is 1 hour. 2985 "retryCount": 42, # The number of attempts that the system will make to run a job using the 2986 # exponential backoff procedure described by 2987 # max_doublings. 2988 # 2989 # The default value of retry_count is zero. 2990 # 2991 # If retry_count is zero, a job attempt will *not* be retried if 2992 # it fails. Instead the Cloud Scheduler system will wait for the 2993 # next scheduled execution time. 2994 # 2995 # If retry_count is set to a non-zero number then Cloud Scheduler 2996 # will retry failed attempts, using exponential backoff, 2997 # retry_count times, or until the next scheduled execution time, 2998 # whichever comes first. 2999 # 3000 # Values greater than 5 and negative values are not allowed. 3001 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 3002 # 3003 # A job's retry interval starts at 3004 # min_backoff_duration, then doubles 3005 # `max_doublings` times, then increases linearly, and finally 3006 # retries retries at intervals of 3007 # max_backoff_duration up to 3008 # retry_count times. 3009 # 3010 # For example, if min_backoff_duration is 3011 # 10s, max_backoff_duration is 300s, and 3012 # `max_doublings` is 3, then the a job will first be retried in 10s. The 3013 # retry interval will double three times, and then increase linearly by 3014 # 2^3 * 10s. Finally, the job will retry at intervals of 3015 # max_backoff_duration until the job has 3016 # been attempted retry_count times. Thus, the 3017 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 3018 # 3019 # The default value of this field is 5. 3020 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 3021 # execution was first attempted. If specified with 3022 # retry_count, the job will be retried until both 3023 # limits are reached. 3024 # 3025 # The default value for max_retry_duration is zero, which means retry 3026 # duration is unlimited. 3027 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 3028 # it fails. 3029 # 3030 # The default value of this field is 5 seconds. 3031 }, 3032 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 3033 # this deadline then the request is cancelled and the attempt is marked as a 3034 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 3035 # execution logs. Cloud Scheduler will retry the job according 3036 # to the RetryConfig. 3037 # 3038 # The allowed duration for this deadline is: 3039 # * For HTTP targets, between 15 seconds and 30 minutes. 3040 # * For App Engine HTTP targets, between 15 3041 # seconds and 24 hours. 3042 "userUpdateTime": "A String", # Output only. The creation time of the job. 3043 }</pre> 3044</div> 3045 3046<div class="method"> 3047 <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code> 3048 <pre>Resume a job. 3049 3050This method reenables a job after it has been Job.State.PAUSED. The 3051state of a job is stored in Job.state; after calling this method it 3052will be set to Job.State.ENABLED. A job must be in 3053Job.State.PAUSED to be resumed. 3054 3055Args: 3056 name: string, Required. 3057 3058The job name. For example: 3059`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required) 3060 body: object, The request body. 3061 The object takes the form of: 3062 3063{ # Request message for ResumeJob. 3064 } 3065 3066 x__xgafv: string, V1 error format. 3067 Allowed values 3068 1 - v1 error format 3069 2 - v2 error format 3070 3071Returns: 3072 An object of the form: 3073 3074 { # Configuration for a job. 3075 # The maximum allowed size for a job is 100KB. 3076 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 3077 # different programming environments, including REST APIs and RPC APIs. It is 3078 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 3079 # three pieces of data: error code, error message, and error details. 3080 # 3081 # You can find out more about this error model and how to work with it in the 3082 # [API Design Guide](https://cloud.google.com/apis/design/errors). 3083 "message": "A String", # A developer-facing error message, which should be in English. Any 3084 # user-facing error message should be localized and sent in the 3085 # google.rpc.Status.details field, or localized by the client. 3086 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 3087 "details": [ # A list of messages that carry the error details. There is a common set of 3088 # message types for APIs to use. 3089 { 3090 "a_key": "", # Properties of the object. Contains field @type with type URL. 3091 }, 3092 ], 3093 }, 3094 "description": "A String", # Optionally caller-specified in CreateJob or 3095 # UpdateJob. 3096 # 3097 # A human-readable description for the job. This string must not contain 3098 # more than 500 characters. 3099 "name": "A String", # Optionally caller-specified in CreateJob, after 3100 # which it becomes output only. 3101 # 3102 # The job name. For example: 3103 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 3104 # 3105 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 3106 # hyphens (-), colons (:), or periods (.). 3107 # For more information, see 3108 # [Identifying 3109 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 3110 # * `LOCATION_ID` is the canonical ID for the job's location. 3111 # The list of available locations can be obtained by calling 3112 # ListLocations. 3113 # For more information, see https://cloud.google.com/about/locations/. 3114 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 3115 # hyphens (-), or underscores (_). The maximum length is 500 characters. 3116 "schedule": "A String", # Required, except when used with UpdateJob. 3117 # 3118 # Describes the schedule on which the job will be executed. 3119 # 3120 # The schedule can be either of the following types: 3121 # 3122 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 3123 # * English-like 3124 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 3125 # 3126 # As a general rule, execution `n + 1` of a job will not begin 3127 # until execution `n` has finished. Cloud Scheduler will never 3128 # allow two simultaneously outstanding executions. For example, 3129 # this implies that if the `n+1`th execution is scheduled to run at 3130 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 3131 # execution will not start until `16:15`. 3132 # A scheduled start time will be delayed if the previous 3133 # execution has not ended when its scheduled time occurs. 3134 # 3135 # If retry_count > 0 and a job attempt fails, 3136 # the job will be tried a total of retry_count 3137 # times, with exponential backoff, until the next scheduled start 3138 # time. 3139 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 3140 # retry of a previously failed attempt or the next execution time 3141 # according to the schedule. 3142 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 3143 # an HTTP request via an http_method such as HTTP 3144 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 3145 # response code in the range [200 - 299]. A failure to receive a response 3146 # constitutes a failed execution. For a redirected request, the response 3147 # returned by the redirected request is considered. 3148 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 3149 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 3150 # incompatible HttpMethod. 3151 "headers": { # The user can specify HTTP request headers to send with the job's 3152 # HTTP request. This map contains the header field names and 3153 # values. Repeated headers are not supported, but a header value can 3154 # contain commas. These headers represent a subset of the headers 3155 # that will accompany the job's HTTP request. Some HTTP request 3156 # headers will be ignored or replaced. A partial list of headers that 3157 # will be ignored or replaced is below: 3158 # - Host: This will be computed by Cloud Scheduler and derived from 3159 # uri. 3160 # * `Content-Length`: This will be computed by Cloud Scheduler. 3161 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 3162 # * `X-Google-*`: Google internal use only. 3163 # * `X-AppEngine-*`: Google internal use only. 3164 # 3165 # The total size of headers must be less than 80KB. 3166 "a_key": "A String", 3167 }, 3168 "oidcToken": { # Contains information needed for generating an # If specified, an 3169 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 3170 # token will be generated and attached as an `Authorization` header in the 3171 # HTTP request. 3172 # 3173 # This type of authorization can be used for many scenarios, including 3174 # calling Cloud Run, or endpoints where you intend to validate the token 3175 # yourself. 3176 # [OpenID Connect 3177 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 3178 # This type of authorization can be used for many scenarios, including 3179 # calling Cloud Run, or endpoints where you intend to validate the token 3180 # yourself. 3181 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 3182 # specified in target will be used. 3183 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 3184 # to be used for generating OIDC token. 3185 # The service account must be within the same project as the job. The caller 3186 # must have iam.serviceAccounts.actAs permission for the service account. 3187 }, 3188 "uri": "A String", # Required. 3189 # 3190 # The full URI path that the request will be sent to. This string 3191 # must begin with either "http://" or "https://". Some examples of 3192 # valid values for uri are: 3193 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 3194 # encode some characters for safety and compatibility. The maximum allowed 3195 # URL length is 2083 characters after encoding. 3196 "oauthToken": { # Contains information needed for generating an # If specified, an 3197 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 3198 # will be generated and attached as an `Authorization` header in the HTTP 3199 # request. 3200 # 3201 # This type of authorization should generally only be used when calling 3202 # Google APIs hosted on *.googleapis.com. 3203 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 3204 # This type of authorization should generally only be used when calling Google 3205 # APIs hosted on *.googleapis.com. 3206 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 3207 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 3208 # will be used. 3209 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 3210 # to be used for generating OAuth token. 3211 # The service account must be within the same project as the job. The caller 3212 # must have iam.serviceAccounts.actAs permission for the service account. 3213 }, 3214 "httpMethod": "A String", # Which HTTP method to use for the request. 3215 }, 3216 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 3217 # of an HTTP request via an http_method such 3218 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 3219 # HTTP response code in the range [200 - 299]. Error 503 is 3220 # considered an App Engine system error instead of an application 3221 # error. Requests returning error 503 will be retried regardless of 3222 # retry configuration and not counted against retry counts. Any other 3223 # response code, or a failure to receive a response before the 3224 # deadline, constitutes a failed attempt. 3225 "body": "A String", # Body. 3226 # 3227 # HTTP request body. A request body is allowed only if the HTTP method is 3228 # POST or PUT. It will result in invalid argument error to set a body on a 3229 # job with an incompatible HttpMethod. 3230 "headers": { # HTTP request headers. 3231 # 3232 # This map contains the header field names and values. Headers can be set 3233 # when the job is created. 3234 # 3235 # Cloud Scheduler sets some headers to default values: 3236 # 3237 # * `User-Agent`: By default, this header is 3238 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 3239 # This header can be modified, but Cloud Scheduler will append 3240 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 3241 # modified `User-Agent`. 3242 # * `X-CloudScheduler`: This header will be set to true. 3243 # 3244 # If the job has an body, Cloud Scheduler sets 3245 # the following headers: 3246 # 3247 # * `Content-Type`: By default, the `Content-Type` header is set to 3248 # `"application/octet-stream"`. The default can be overridden by explictly 3249 # setting `Content-Type` to a particular media type when the job is 3250 # created. 3251 # For example, `Content-Type` can be set to `"application/json"`. 3252 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 3253 # output only. It cannot be changed. 3254 # 3255 # The headers below are output only. They cannot be set or overridden: 3256 # 3257 # * `X-Google-*`: For Google internal use only. 3258 # * `X-AppEngine-*`: For Google internal use only. 3259 # 3260 # In addition, some App Engine headers, which contain 3261 # job-specific information, are also be sent to the job handler. 3262 "a_key": "A String", 3263 }, 3264 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 3265 # 3266 # For more information about services, versions, and instances see 3267 # [An Overview of App 3268 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 3269 # [Microservices Architecture on Google App 3270 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 3271 # [App Engine Standard request 3272 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 3273 # and [App Engine Flex request 3274 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 3275 "instance": "A String", # App instance. 3276 # 3277 # By default, the job is sent to an instance which is available when 3278 # the job is attempted. 3279 # 3280 # Requests can only be sent to a specific instance if 3281 # [manual scaling is used in App Engine 3282 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 3283 # App Engine Flex does not support instances. For more information, see 3284 # [App Engine Standard request 3285 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 3286 # and [App Engine Flex request 3287 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 3288 "host": "A String", # Output only. The host that the job is sent to. 3289 # 3290 # For more information about how App Engine requests are routed, see 3291 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 3292 # 3293 # The host is constructed as: 3294 # 3295 # 3296 # * `host = [application_domain_name]`</br> 3297 # `| [service] + '.' + [application_domain_name]`</br> 3298 # `| [version] + '.' + [application_domain_name]`</br> 3299 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 3300 # `| [instance] + '.' + [application_domain_name]`</br> 3301 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 3302 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 3303 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 3304 # 3305 # * `application_domain_name` = The domain name of the app, for 3306 # example <app-id>.appspot.com, which is associated with the 3307 # job's project ID. 3308 # 3309 # * `service =` service 3310 # 3311 # * `version =` version 3312 # 3313 # * `version_dot_service =` 3314 # version `+ '.' +` 3315 # service 3316 # 3317 # * `instance =` instance 3318 # 3319 # * `instance_dot_service =` 3320 # instance `+ '.' +` 3321 # service 3322 # 3323 # * `instance_dot_version =` 3324 # instance `+ '.' +` 3325 # version 3326 # 3327 # * `instance_dot_version_dot_service =` 3328 # instance `+ '.' +` 3329 # version `+ '.' +` 3330 # service 3331 # 3332 # 3333 # If service is empty, then the job will be sent 3334 # to the service which is the default service when the job is attempted. 3335 # 3336 # If version is empty, then the job will be sent 3337 # to the version which is the default version when the job is attempted. 3338 # 3339 # If instance is empty, then the job will be 3340 # sent to an instance which is available when the job is attempted. 3341 # 3342 # If service, 3343 # version, or 3344 # instance is invalid, then the job will be sent 3345 # to the default version of the default service when the job is attempted. 3346 "version": "A String", # App version. 3347 # 3348 # By default, the job is sent to the version which is the default 3349 # version when the job is attempted. 3350 "service": "A String", # App service. 3351 # 3352 # By default, the job is sent to the service which is the default 3353 # service when the job is attempted. 3354 }, 3355 "relativeUri": "A String", # The relative URI. 3356 # 3357 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 3358 # It can contain a path, query string arguments, and `#` fragments. 3359 # If the relative URL is empty, then the root path "/" will be used. 3360 # No spaces are allowed, and the maximum length allowed is 2083 characters. 3361 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 3362 # permitted. 3363 }, 3364 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 3365 "state": "A String", # Output only. State of the job. 3366 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 3367 # the given Pub/Sub topic. 3368 "attributes": { # Attributes for PubsubMessage. 3369 # 3370 # Pubsub message must contain either non-empty data, or at least one 3371 # attribute. 3372 "a_key": "A String", 3373 }, 3374 "data": "A String", # The message payload for PubsubMessage. 3375 # 3376 # Pubsub message must contain either non-empty data, or at least one 3377 # attribute. 3378 "topicName": "A String", # Required. 3379 # 3380 # The name of the Cloud Pub/Sub topic to which messages will 3381 # be published when a job is delivered. The topic name must be in the 3382 # same format as required by PubSub's 3383 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 3384 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 3385 # 3386 # The topic must be in the same project as the Cloud Scheduler job. 3387 }, 3388 "timeZone": "A String", # Specifies the time zone to be used in interpreting 3389 # schedule. The value of this field must be a time 3390 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 3391 # 3392 # Note that some time zones include a provision for 3393 # daylight savings time. The rules for daylight saving time are 3394 # determined by the chosen tz. For UTC use the string "utc". If a 3395 # time zone is not specified, the default will be in UTC (also known 3396 # as GMT). 3397 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 3398 # 3399 # By default, if a job does not complete successfully (meaning that 3400 # an acknowledgement is not received from the handler, then it will be retried 3401 # with exponential backoff according to the settings in RetryConfig. 3402 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 3403 # it fails. 3404 # 3405 # The default value of this field is 1 hour. 3406 "retryCount": 42, # The number of attempts that the system will make to run a job using the 3407 # exponential backoff procedure described by 3408 # max_doublings. 3409 # 3410 # The default value of retry_count is zero. 3411 # 3412 # If retry_count is zero, a job attempt will *not* be retried if 3413 # it fails. Instead the Cloud Scheduler system will wait for the 3414 # next scheduled execution time. 3415 # 3416 # If retry_count is set to a non-zero number then Cloud Scheduler 3417 # will retry failed attempts, using exponential backoff, 3418 # retry_count times, or until the next scheduled execution time, 3419 # whichever comes first. 3420 # 3421 # Values greater than 5 and negative values are not allowed. 3422 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 3423 # 3424 # A job's retry interval starts at 3425 # min_backoff_duration, then doubles 3426 # `max_doublings` times, then increases linearly, and finally 3427 # retries retries at intervals of 3428 # max_backoff_duration up to 3429 # retry_count times. 3430 # 3431 # For example, if min_backoff_duration is 3432 # 10s, max_backoff_duration is 300s, and 3433 # `max_doublings` is 3, then the a job will first be retried in 10s. The 3434 # retry interval will double three times, and then increase linearly by 3435 # 2^3 * 10s. Finally, the job will retry at intervals of 3436 # max_backoff_duration until the job has 3437 # been attempted retry_count times. Thus, the 3438 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 3439 # 3440 # The default value of this field is 5. 3441 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 3442 # execution was first attempted. If specified with 3443 # retry_count, the job will be retried until both 3444 # limits are reached. 3445 # 3446 # The default value for max_retry_duration is zero, which means retry 3447 # duration is unlimited. 3448 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 3449 # it fails. 3450 # 3451 # The default value of this field is 5 seconds. 3452 }, 3453 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 3454 # this deadline then the request is cancelled and the attempt is marked as a 3455 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 3456 # execution logs. Cloud Scheduler will retry the job according 3457 # to the RetryConfig. 3458 # 3459 # The allowed duration for this deadline is: 3460 # * For HTTP targets, between 15 seconds and 30 minutes. 3461 # * For App Engine HTTP targets, between 15 3462 # seconds and 24 hours. 3463 "userUpdateTime": "A String", # Output only. The creation time of the job. 3464 }</pre> 3465</div> 3466 3467<div class="method"> 3468 <code class="details" id="run">run(name, body=None, x__xgafv=None)</code> 3469 <pre>Forces a job to run now. 3470 3471When this method is called, Cloud Scheduler will dispatch the job, even 3472if the job is already running. 3473 3474Args: 3475 name: string, Required. 3476 3477The job name. For example: 3478`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required) 3479 body: object, The request body. 3480 The object takes the form of: 3481 3482{ # Request message for forcing a job to run now using 3483 # RunJob. 3484 } 3485 3486 x__xgafv: string, V1 error format. 3487 Allowed values 3488 1 - v1 error format 3489 2 - v2 error format 3490 3491Returns: 3492 An object of the form: 3493 3494 { # Configuration for a job. 3495 # The maximum allowed size for a job is 100KB. 3496 "status": { # The `Status` type defines a logical error model that is suitable for # Output only. The response from the target for the last attempted execution. 3497 # different programming environments, including REST APIs and RPC APIs. It is 3498 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 3499 # three pieces of data: error code, error message, and error details. 3500 # 3501 # You can find out more about this error model and how to work with it in the 3502 # [API Design Guide](https://cloud.google.com/apis/design/errors). 3503 "message": "A String", # A developer-facing error message, which should be in English. Any 3504 # user-facing error message should be localized and sent in the 3505 # google.rpc.Status.details field, or localized by the client. 3506 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 3507 "details": [ # A list of messages that carry the error details. There is a common set of 3508 # message types for APIs to use. 3509 { 3510 "a_key": "", # Properties of the object. Contains field @type with type URL. 3511 }, 3512 ], 3513 }, 3514 "description": "A String", # Optionally caller-specified in CreateJob or 3515 # UpdateJob. 3516 # 3517 # A human-readable description for the job. This string must not contain 3518 # more than 500 characters. 3519 "name": "A String", # Optionally caller-specified in CreateJob, after 3520 # which it becomes output only. 3521 # 3522 # The job name. For example: 3523 # `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 3524 # 3525 # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 3526 # hyphens (-), colons (:), or periods (.). 3527 # For more information, see 3528 # [Identifying 3529 # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 3530 # * `LOCATION_ID` is the canonical ID for the job's location. 3531 # The list of available locations can be obtained by calling 3532 # ListLocations. 3533 # For more information, see https://cloud.google.com/about/locations/. 3534 # * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 3535 # hyphens (-), or underscores (_). The maximum length is 500 characters. 3536 "schedule": "A String", # Required, except when used with UpdateJob. 3537 # 3538 # Describes the schedule on which the job will be executed. 3539 # 3540 # The schedule can be either of the following types: 3541 # 3542 # * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) 3543 # * English-like 3544 # [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 3545 # 3546 # As a general rule, execution `n + 1` of a job will not begin 3547 # until execution `n` has finished. Cloud Scheduler will never 3548 # allow two simultaneously outstanding executions. For example, 3549 # this implies that if the `n+1`th execution is scheduled to run at 3550 # 16:00 but the `n`th execution takes until 16:15, the `n+1`th 3551 # execution will not start until `16:15`. 3552 # A scheduled start time will be delayed if the previous 3553 # execution has not ended when its scheduled time occurs. 3554 # 3555 # If retry_count > 0 and a job attempt fails, 3556 # the job will be tried a total of retry_count 3557 # times, with exponential backoff, until the next scheduled start 3558 # time. 3559 "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a 3560 # retry of a previously failed attempt or the next execution time 3561 # according to the schedule. 3562 "httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target. 3563 # an HTTP request via an http_method such as HTTP 3564 # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP 3565 # response code in the range [200 - 299]. A failure to receive a response 3566 # constitutes a failed execution. For a redirected request, the response 3567 # returned by the redirected request is considered. 3568 "body": "A String", # HTTP request body. A request body is allowed only if the HTTP 3569 # method is POST, PUT, or PATCH. It is an error to set body on a job with an 3570 # incompatible HttpMethod. 3571 "headers": { # The user can specify HTTP request headers to send with the job's 3572 # HTTP request. This map contains the header field names and 3573 # values. Repeated headers are not supported, but a header value can 3574 # contain commas. These headers represent a subset of the headers 3575 # that will accompany the job's HTTP request. Some HTTP request 3576 # headers will be ignored or replaced. A partial list of headers that 3577 # will be ignored or replaced is below: 3578 # - Host: This will be computed by Cloud Scheduler and derived from 3579 # uri. 3580 # * `Content-Length`: This will be computed by Cloud Scheduler. 3581 # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. 3582 # * `X-Google-*`: Google internal use only. 3583 # * `X-AppEngine-*`: Google internal use only. 3584 # 3585 # The total size of headers must be less than 80KB. 3586 "a_key": "A String", 3587 }, 3588 "oidcToken": { # Contains information needed for generating an # If specified, an 3589 # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) 3590 # token will be generated and attached as an `Authorization` header in the 3591 # HTTP request. 3592 # 3593 # This type of authorization can be used for many scenarios, including 3594 # calling Cloud Run, or endpoints where you intend to validate the token 3595 # yourself. 3596 # [OpenID Connect 3597 # token](https://developers.google.com/identity/protocols/OpenIDConnect). 3598 # This type of authorization can be used for many scenarios, including 3599 # calling Cloud Run, or endpoints where you intend to validate the token 3600 # yourself. 3601 "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI 3602 # specified in target will be used. 3603 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 3604 # to be used for generating OIDC token. 3605 # The service account must be within the same project as the job. The caller 3606 # must have iam.serviceAccounts.actAs permission for the service account. 3607 }, 3608 "uri": "A String", # Required. 3609 # 3610 # The full URI path that the request will be sent to. This string 3611 # must begin with either "http://" or "https://". Some examples of 3612 # valid values for uri are: 3613 # `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will 3614 # encode some characters for safety and compatibility. The maximum allowed 3615 # URL length is 2083 characters after encoding. 3616 "oauthToken": { # Contains information needed for generating an # If specified, an 3617 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2) 3618 # will be generated and attached as an `Authorization` header in the HTTP 3619 # request. 3620 # 3621 # This type of authorization should generally only be used when calling 3622 # Google APIs hosted on *.googleapis.com. 3623 # [OAuth token](https://developers.google.com/identity/protocols/OAuth2). 3624 # This type of authorization should generally only be used when calling Google 3625 # APIs hosted on *.googleapis.com. 3626 "scope": "A String", # OAuth scope to be used for generating OAuth access token. 3627 # If not specified, "https://www.googleapis.com/auth/cloud-platform" 3628 # will be used. 3629 "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) 3630 # to be used for generating OAuth token. 3631 # The service account must be within the same project as the job. The caller 3632 # must have iam.serviceAccounts.actAs permission for the service account. 3633 }, 3634 "httpMethod": "A String", # Which HTTP method to use for the request. 3635 }, 3636 "appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target. 3637 # of an HTTP request via an http_method such 3638 # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an 3639 # HTTP response code in the range [200 - 299]. Error 503 is 3640 # considered an App Engine system error instead of an application 3641 # error. Requests returning error 503 will be retried regardless of 3642 # retry configuration and not counted against retry counts. Any other 3643 # response code, or a failure to receive a response before the 3644 # deadline, constitutes a failed attempt. 3645 "body": "A String", # Body. 3646 # 3647 # HTTP request body. A request body is allowed only if the HTTP method is 3648 # POST or PUT. It will result in invalid argument error to set a body on a 3649 # job with an incompatible HttpMethod. 3650 "headers": { # HTTP request headers. 3651 # 3652 # This map contains the header field names and values. Headers can be set 3653 # when the job is created. 3654 # 3655 # Cloud Scheduler sets some headers to default values: 3656 # 3657 # * `User-Agent`: By default, this header is 3658 # `"AppEngine-Google; (+http://code.google.com/appengine)"`. 3659 # This header can be modified, but Cloud Scheduler will append 3660 # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the 3661 # modified `User-Agent`. 3662 # * `X-CloudScheduler`: This header will be set to true. 3663 # 3664 # If the job has an body, Cloud Scheduler sets 3665 # the following headers: 3666 # 3667 # * `Content-Type`: By default, the `Content-Type` header is set to 3668 # `"application/octet-stream"`. The default can be overridden by explictly 3669 # setting `Content-Type` to a particular media type when the job is 3670 # created. 3671 # For example, `Content-Type` can be set to `"application/json"`. 3672 # * `Content-Length`: This is computed by Cloud Scheduler. This value is 3673 # output only. It cannot be changed. 3674 # 3675 # The headers below are output only. They cannot be set or overridden: 3676 # 3677 # * `X-Google-*`: For Google internal use only. 3678 # * `X-AppEngine-*`: For Google internal use only. 3679 # 3680 # In addition, some App Engine headers, which contain 3681 # job-specific information, are also be sent to the job handler. 3682 "a_key": "A String", 3683 }, 3684 "appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job. 3685 # 3686 # For more information about services, versions, and instances see 3687 # [An Overview of App 3688 # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 3689 # [Microservices Architecture on Google App 3690 # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 3691 # [App Engine Standard request 3692 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 3693 # and [App Engine Flex request 3694 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 3695 "instance": "A String", # App instance. 3696 # 3697 # By default, the job is sent to an instance which is available when 3698 # the job is attempted. 3699 # 3700 # Requests can only be sent to a specific instance if 3701 # [manual scaling is used in App Engine 3702 # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). 3703 # App Engine Flex does not support instances. For more information, see 3704 # [App Engine Standard request 3705 # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 3706 # and [App Engine Flex request 3707 # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 3708 "host": "A String", # Output only. The host that the job is sent to. 3709 # 3710 # For more information about how App Engine requests are routed, see 3711 # [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). 3712 # 3713 # The host is constructed as: 3714 # 3715 # 3716 # * `host = [application_domain_name]`</br> 3717 # `| [service] + '.' + [application_domain_name]`</br> 3718 # `| [version] + '.' + [application_domain_name]`</br> 3719 # `| [version_dot_service]+ '.' + [application_domain_name]`</br> 3720 # `| [instance] + '.' + [application_domain_name]`</br> 3721 # `| [instance_dot_service] + '.' + [application_domain_name]`</br> 3722 # `| [instance_dot_version] + '.' + [application_domain_name]`</br> 3723 # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` 3724 # 3725 # * `application_domain_name` = The domain name of the app, for 3726 # example <app-id>.appspot.com, which is associated with the 3727 # job's project ID. 3728 # 3729 # * `service =` service 3730 # 3731 # * `version =` version 3732 # 3733 # * `version_dot_service =` 3734 # version `+ '.' +` 3735 # service 3736 # 3737 # * `instance =` instance 3738 # 3739 # * `instance_dot_service =` 3740 # instance `+ '.' +` 3741 # service 3742 # 3743 # * `instance_dot_version =` 3744 # instance `+ '.' +` 3745 # version 3746 # 3747 # * `instance_dot_version_dot_service =` 3748 # instance `+ '.' +` 3749 # version `+ '.' +` 3750 # service 3751 # 3752 # 3753 # If service is empty, then the job will be sent 3754 # to the service which is the default service when the job is attempted. 3755 # 3756 # If version is empty, then the job will be sent 3757 # to the version which is the default version when the job is attempted. 3758 # 3759 # If instance is empty, then the job will be 3760 # sent to an instance which is available when the job is attempted. 3761 # 3762 # If service, 3763 # version, or 3764 # instance is invalid, then the job will be sent 3765 # to the default version of the default service when the job is attempted. 3766 "version": "A String", # App version. 3767 # 3768 # By default, the job is sent to the version which is the default 3769 # version when the job is attempted. 3770 "service": "A String", # App service. 3771 # 3772 # By default, the job is sent to the service which is the default 3773 # service when the job is attempted. 3774 }, 3775 "relativeUri": "A String", # The relative URI. 3776 # 3777 # The relative URL must begin with "/" and must be a valid HTTP relative URL. 3778 # It can contain a path, query string arguments, and `#` fragments. 3779 # If the relative URL is empty, then the root path "/" will be used. 3780 # No spaces are allowed, and the maximum length allowed is 2083 characters. 3781 "httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not 3782 # permitted. 3783 }, 3784 "lastAttemptTime": "A String", # Output only. The time the last job attempt started. 3785 "state": "A String", # Output only. State of the job. 3786 "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. 3787 # the given Pub/Sub topic. 3788 "attributes": { # Attributes for PubsubMessage. 3789 # 3790 # Pubsub message must contain either non-empty data, or at least one 3791 # attribute. 3792 "a_key": "A String", 3793 }, 3794 "data": "A String", # The message payload for PubsubMessage. 3795 # 3796 # Pubsub message must contain either non-empty data, or at least one 3797 # attribute. 3798 "topicName": "A String", # Required. 3799 # 3800 # The name of the Cloud Pub/Sub topic to which messages will 3801 # be published when a job is delivered. The topic name must be in the 3802 # same format as required by PubSub's 3803 # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), 3804 # for example `projects/PROJECT_ID/topics/TOPIC_ID`. 3805 # 3806 # The topic must be in the same project as the Cloud Scheduler job. 3807 }, 3808 "timeZone": "A String", # Specifies the time zone to be used in interpreting 3809 # schedule. The value of this field must be a time 3810 # zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). 3811 # 3812 # Note that some time zones include a provision for 3813 # daylight savings time. The rules for daylight saving time are 3814 # determined by the chosen tz. For UTC use the string "utc". If a 3815 # time zone is not specified, the default will be in UTC (also known 3816 # as GMT). 3817 "retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior. 3818 # 3819 # By default, if a job does not complete successfully (meaning that 3820 # an acknowledgement is not received from the handler, then it will be retried 3821 # with exponential backoff according to the settings in RetryConfig. 3822 "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after 3823 # it fails. 3824 # 3825 # The default value of this field is 1 hour. 3826 "retryCount": 42, # The number of attempts that the system will make to run a job using the 3827 # exponential backoff procedure described by 3828 # max_doublings. 3829 # 3830 # The default value of retry_count is zero. 3831 # 3832 # If retry_count is zero, a job attempt will *not* be retried if 3833 # it fails. Instead the Cloud Scheduler system will wait for the 3834 # next scheduled execution time. 3835 # 3836 # If retry_count is set to a non-zero number then Cloud Scheduler 3837 # will retry failed attempts, using exponential backoff, 3838 # retry_count times, or until the next scheduled execution time, 3839 # whichever comes first. 3840 # 3841 # Values greater than 5 and negative values are not allowed. 3842 "maxDoublings": 42, # The time between retries will double `max_doublings` times. 3843 # 3844 # A job's retry interval starts at 3845 # min_backoff_duration, then doubles 3846 # `max_doublings` times, then increases linearly, and finally 3847 # retries retries at intervals of 3848 # max_backoff_duration up to 3849 # retry_count times. 3850 # 3851 # For example, if min_backoff_duration is 3852 # 10s, max_backoff_duration is 300s, and 3853 # `max_doublings` is 3, then the a job will first be retried in 10s. The 3854 # retry interval will double three times, and then increase linearly by 3855 # 2^3 * 10s. Finally, the job will retry at intervals of 3856 # max_backoff_duration until the job has 3857 # been attempted retry_count times. Thus, the 3858 # requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... 3859 # 3860 # The default value of this field is 5. 3861 "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an 3862 # execution was first attempted. If specified with 3863 # retry_count, the job will be retried until both 3864 # limits are reached. 3865 # 3866 # The default value for max_retry_duration is zero, which means retry 3867 # duration is unlimited. 3868 "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after 3869 # it fails. 3870 # 3871 # The default value of this field is 5 seconds. 3872 }, 3873 "attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by 3874 # this deadline then the request is cancelled and the attempt is marked as a 3875 # `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 3876 # execution logs. Cloud Scheduler will retry the job according 3877 # to the RetryConfig. 3878 # 3879 # The allowed duration for this deadline is: 3880 # * For HTTP targets, between 15 seconds and 30 minutes. 3881 # * For App Engine HTTP targets, between 15 3882 # seconds and 24 hours. 3883 "userUpdateTime": "A String", # Output only. The creation time of the job. 3884 }</pre> 3885</div> 3886 3887</body></html>