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