Blame - docs/dyn/cloudscheduler_v1.projects.locations.jobs.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a job.</p>

80

81

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a job.</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

86

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

87

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Lists jobs.</p>

89

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Updates a job.</p>

95

96

<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Pauses a job.</p>

98

99

<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Resume a job.</p>

101

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

<pre>Creates a job.

108

109

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

parent: string, Required. The location name. For example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

111

`projects/PROJECT_ID/locations/LOCATION_ID`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

The object takes the form of:

114

115

{ # Configuration for a job.

116

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

117

"timeZone": "A String", # Specifies the time zone to be used in interpreting

118

# schedule. The value of this field must be a time

119

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

120

#

121

# Note that some time zones include a provision for

122

# daylight savings time. The rules for daylight saving time are

123

# determined by the chosen tz. For UTC use the string "utc". If a

124

# time zone is not specified, the default will be in UTC (also known

125

# as GMT).

126

"description": "A String", # Optionally caller-specified in CreateJob or

127

# UpdateJob.

128

#

129

# A human-readable description for the job. This string must not contain

130

# more than 500 characters.

131

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

132

# of an HTTP request via an http_method such

133

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

134

# HTTP response code in the range [200 - 299]. Error 503 is

135

# considered an App Engine system error instead of an application

136

# error. Requests returning error 503 will be retried regardless of

137

# retry configuration and not counted against retry counts. Any other

138

# response code, or a failure to receive a response before the

139

# deadline, constitutes a failed attempt.

140

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

141

# permitted.

142

"body": "A String", # Body.

143

#

144

# HTTP request body. A request body is allowed only if the HTTP method is

145

# POST or PUT. It will result in invalid argument error to set a body on a

146

# job with an incompatible HttpMethod.

147

"relativeUri": "A String", # The relative URI.

148

#

149

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

150

# It can contain a path, query string arguments, and `#` fragments.

151

# If the relative URL is empty, then the root path "/" will be used.

152

# No spaces are allowed, and the maximum length allowed is 2083 characters.

153

"headers": { # HTTP request headers.

154

#

155

# This map contains the header field names and values. Headers can be set

156

# when the job is created.

157

#

158

# Cloud Scheduler sets some headers to default values:

159

#

160

# * `User-Agent`: By default, this header is

161

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

162

# This header can be modified, but Cloud Scheduler will append

163

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

164

# modified `User-Agent`.

165

# * `X-CloudScheduler`: This header will be set to true.

166

#

167

# If the job has an body, Cloud Scheduler sets

168

# the following headers:

169

#

170

# * `Content-Type`: By default, the `Content-Type` header is set to

171

# `"application/octet-stream"`. The default can be overridden by explictly

172

# setting `Content-Type` to a particular media type when the job is

173

# created.

174

# For example, `Content-Type` can be set to `"application/json"`.

175

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

176

# output only. It cannot be changed.

177

#

178

# The headers below are output only. They cannot be set or overridden:

179

#

180

# * `X-Google-*`: For Google internal use only.

181

# * `X-AppEngine-*`: For Google internal use only.

182

#

183

# In addition, some App Engine headers, which contain

184

# job-specific information, are also be sent to the job handler.

185

"a_key": "A String",

186

},

187

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

188

#

189

# For more information about services, versions, and instances see

190

# [An Overview of App

191

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

192

# [Microservices Architecture on Google App

193

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

194

# [App Engine Standard request

195

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

196

# and [App Engine Flex request

197

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

198

"version": "A String", # App version.

199

#

200

# By default, the job is sent to the version which is the default

201

# version when the job is attempted.

202

"host": "A String", # Output only. The host that the job is sent to.

203

#

204

# For more information about how App Engine requests are routed, see

205

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

206

#

207

# The host is constructed as:

208

#

209

#

210

# * `host = [application_domain_name]`</br>

211

# `| [service] + '.' + [application_domain_name]`</br>

212

# `| [version] + '.' + [application_domain_name]`</br>

213

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

214

# `| [instance] + '.' + [application_domain_name]`</br>

215

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

216

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

217

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

218

#

219

# * `application_domain_name` = The domain name of the app, for

220

# example <app-id>.appspot.com, which is associated with the

221

# job's project ID.

222

#

223

# * `service =` service

224

#

225

# * `version =` version

226

#

227

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

232

#

233

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

248

# to the service which is the default service when the job is attempted.

249

#

250

# If version is empty, then the job will be sent

251

# to the version which is the default version when the job is attempted.

252

#

253

# If instance is empty, then the job will be

254

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

259

# to the default version of the default service when the job is attempted.

260

"service": "A String", # App service.

261

#

262

# By default, the job is sent to the service which is the default

263

# service when the job is attempted.

264

"instance": "A String", # App instance.

265

#

266

# By default, the job is sent to an instance which is available when

267

# the job is attempted.

268

#

269

# Requests can only be sent to a specific instance if

270

# [manual scaling is used in App Engine

271

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

272

# App Engine Flex does not support instances. For more information, see

273

# [App Engine Standard request

274

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

275

# and [App Engine Flex request

276

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

277

},

278

},

279

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

280

# different programming environments, including REST APIs and RPC APIs. It is

281

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

282

# three pieces of data: error code, error message, and error details.

283

#

284

# You can find out more about this error model and how to work with it in the

285

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

286

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

287

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

288

# user-facing error message should be localized and sent in the

289

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

291

# message types for APIs to use.

292

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

293

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

294

},

295

],

296

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

297

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

298

#

299

# By default, if a job does not complete successfully (meaning that

300

# an acknowledgement is not received from the handler, then it will be retried

301

# with exponential backoff according to the settings in RetryConfig.

302

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

303

# execution was first attempted. If specified with

304

# retry_count, the job will be retried until both

305

# limits are reached.

306

#

307

# The default value for max_retry_duration is zero, which means retry

308

# duration is unlimited.

309

"retryCount": 42, # The number of attempts that the system will make to run a job using the

310

# exponential backoff procedure described by

311

# max_doublings.

312

#

313

# The default value of retry_count is zero.

314

#

315

# If retry_count is zero, a job attempt will *not* be retried if

316

# it fails. Instead the Cloud Scheduler system will wait for the

317

# next scheduled execution time.

318

#

319

# If retry_count is set to a non-zero number then Cloud Scheduler

320

# will retry failed attempts, using exponential backoff,

321

# retry_count times, or until the next scheduled execution time,

322

# whichever comes first.

323

#

324

# Values greater than 5 and negative values are not allowed.

325

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

326

#

327

# A job's retry interval starts at

328

# min_backoff_duration, then doubles

329

# `max_doublings` times, then increases linearly, and finally

330

# retries at intervals of

331

# max_backoff_duration up to

332

# retry_count times.

333

#

334

# For example, if min_backoff_duration is

335

# 10s, max_backoff_duration is 300s, and

336

# `max_doublings` is 3, then the a job will first be retried in 10s. The

337

# retry interval will double three times, and then increase linearly by

338

# 2^3 * 10s. Finally, the job will retry at intervals of

339

# max_backoff_duration until the job has

340

# been attempted retry_count times. Thus, the

341

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

342

#

343

# The default value of this field is 5.

344

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

345

# it fails.

346

#

347

# The default value of this field is 1 hour.

348

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

349

# it fails.

350

#

351

# The default value of this field is 5 seconds.

352

},

353

"state": "A String", # Output only. State of the job.

354

"name": "A String", # Optionally caller-specified in CreateJob, after

355

# which it becomes output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

356

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

357

# The job name. For example:

358

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

359

#

360

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

361

# hyphens (-), colons (:), or periods (.).

362

# For more information, see

363

# [Identifying

364

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

365

# * `LOCATION_ID` is the canonical ID for the job's location.

366

# The list of available locations can be obtained by calling

367

# ListLocations.

368

# For more information, see https://cloud.google.com/about/locations/.

369

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

370

# hyphens (-), or underscores (_). The maximum length is 500 characters.

371

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

372

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

373

# retry of a previously failed attempt or the next execution time

374

# according to the schedule.

375

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

376

#

377

# Describes the schedule on which the job will be executed.

378

#

379

# The schedule can be either of the following types:

380

#

381

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

382

# * English-like

383

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

384

#

385

# As a general rule, execution `n + 1` of a job will not begin

386

# until execution `n` has finished. Cloud Scheduler will never

387

# allow two simultaneously outstanding executions. For example,

388

# this implies that if the `n+1`th execution is scheduled to run at

389

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

390

# execution will not start until `16:15`.

391

# A scheduled start time will be delayed if the previous

392

# execution has not ended when its scheduled time occurs.

393

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

394

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

395

# the job will be tried a total of retry_count

396

# times, with exponential backoff, until the next scheduled start

397

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

398

"userUpdateTime": "A String", # Output only. The creation time of the job.

399

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

400

# this deadline then the request is cancelled and the attempt is marked as a

401

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

402

# execution logs. Cloud Scheduler will retry the job according

403

# to the RetryConfig.

404

#

405

# The allowed duration for this deadline is:

406

# * For HTTP targets, between 15 seconds and 30 minutes.

407

# * For App Engine HTTP targets, between 15

408

# seconds and 24 hours.

409

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

410

# an HTTP request via an http_method such as HTTP

411

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

412

# response code in the range [200 - 299]. A failure to receive a response

413

# constitutes a failed execution. For a redirected request, the response

414

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

415

"httpMethod": "A String", # Which HTTP method to use for the request.

416

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

418

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

419

"oauthToken": { # Contains information needed for generating an # If specified, an

420

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

421

# will be generated and attached as an `Authorization` header in the HTTP

422

# request.

423

#

424

# This type of authorization should generally only be used when calling

425

# Google APIs hosted on *.googleapis.com.

426

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

427

# This type of authorization should generally only be used when calling Google

428

# APIs hosted on *.googleapis.com.

429

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

430

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

431

# will be used.

432

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

433

# to be used for generating OAuth token.

434

# The service account must be within the same project as the job. The caller

435

# must have iam.serviceAccounts.actAs permission for the service account.

436

},

437

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

438

# must begin with either "http://" or "https://". Some examples of

439

# valid values for uri are:

440

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

441

# encode some characters for safety and compatibility. The maximum allowed

442

# URL length is 2083 characters after encoding.

443

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

444

# HTTP request. This map contains the header field names and

445

# values. Repeated headers are not supported, but a header value can

446

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

447

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

448

# headers will be ignored or replaced. A partial list of headers that

449

# will be ignored or replaced is below:

450

# - Host: This will be computed by Cloud Scheduler and derived from

451

# uri.

452

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

453

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

454

# * `X-Google-*`: Google internal use only.

455

# * `X-AppEngine-*`: Google internal use only.

456

#

457

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

458

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

459

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

460

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

461

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

462

# token will be generated and attached as an `Authorization` header in the

463

# HTTP request.

464

#

465

# This type of authorization can be used for many scenarios, including

466

# calling Cloud Run, or endpoints where you intend to validate the token

467

# yourself.

468

# [OpenID Connect

469

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

470

# This type of authorization can be used for many scenarios, including

471

# calling Cloud Run, or endpoints where you intend to validate the token

472

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

473

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

474

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

476

# to be used for generating OIDC token.

477

# The service account must be within the same project as the job. The caller

478

# must have iam.serviceAccounts.actAs permission for the service account.

479

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

480

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

481

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

483

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

484

#

485

# Pubsub message must contain either non-empty data, or at least one

486

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

487

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

488

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

489

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

490

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

491

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

492

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

493

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

494

#

495

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

496

"data": "A String", # The message payload for PubsubMessage.

497

#

498

# Pubsub message must contain either non-empty data, or at least one

499

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

500

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

501

}

502

503

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

510

511

{ # Configuration for a job.

512

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

513

"timeZone": "A String", # Specifies the time zone to be used in interpreting

514

# schedule. The value of this field must be a time

515

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

516

#

517

# Note that some time zones include a provision for

518

# daylight savings time. The rules for daylight saving time are

519

# determined by the chosen tz. For UTC use the string "utc". If a

520

# time zone is not specified, the default will be in UTC (also known

521

# as GMT).

522

"description": "A String", # Optionally caller-specified in CreateJob or

523

# UpdateJob.

524

#

525

# A human-readable description for the job. This string must not contain

526

# more than 500 characters.

527

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

528

# of an HTTP request via an http_method such

529

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

530

# HTTP response code in the range [200 - 299]. Error 503 is

531

# considered an App Engine system error instead of an application

532

# error. Requests returning error 503 will be retried regardless of

533

# retry configuration and not counted against retry counts. Any other

534

# response code, or a failure to receive a response before the

535

# deadline, constitutes a failed attempt.

536

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

537

# permitted.

538

"body": "A String", # Body.

539

#

540

# HTTP request body. A request body is allowed only if the HTTP method is

541

# POST or PUT. It will result in invalid argument error to set a body on a

542

# job with an incompatible HttpMethod.

543

"relativeUri": "A String", # The relative URI.

544

#

545

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

546

# It can contain a path, query string arguments, and `#` fragments.

547

# If the relative URL is empty, then the root path "/" will be used.

548

# No spaces are allowed, and the maximum length allowed is 2083 characters.

549

"headers": { # HTTP request headers.

550

#

551

# This map contains the header field names and values. Headers can be set

552

# when the job is created.

553

#

554

# Cloud Scheduler sets some headers to default values:

555

#

556

# * `User-Agent`: By default, this header is

557

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

558

# This header can be modified, but Cloud Scheduler will append

559

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

560

# modified `User-Agent`.

561

# * `X-CloudScheduler`: This header will be set to true.

562

#

563

# If the job has an body, Cloud Scheduler sets

564

# the following headers:

565

#

566

# * `Content-Type`: By default, the `Content-Type` header is set to

567

# `"application/octet-stream"`. The default can be overridden by explictly

568

# setting `Content-Type` to a particular media type when the job is

569

# created.

570

# For example, `Content-Type` can be set to `"application/json"`.

571

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

572

# output only. It cannot be changed.

573

#

574

# The headers below are output only. They cannot be set or overridden:

575

#

576

# * `X-Google-*`: For Google internal use only.

577

# * `X-AppEngine-*`: For Google internal use only.

578

#

579

# In addition, some App Engine headers, which contain

580

# job-specific information, are also be sent to the job handler.

581

"a_key": "A String",

582

},

583

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

584

#

585

# For more information about services, versions, and instances see

586

# [An Overview of App

587

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

588

# [Microservices Architecture on Google App

589

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

590

# [App Engine Standard request

591

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

592

# and [App Engine Flex request

593

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

594

"version": "A String", # App version.

595

#

596

# By default, the job is sent to the version which is the default

597

# version when the job is attempted.

598

"host": "A String", # Output only. The host that the job is sent to.

599

#

600

# For more information about how App Engine requests are routed, see

601

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

602

#

603

# The host is constructed as:

604

#

605

#

606

# * `host = [application_domain_name]`</br>

607

# `| [service] + '.' + [application_domain_name]`</br>

608

# `| [version] + '.' + [application_domain_name]`</br>

609

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

610

# `| [instance] + '.' + [application_domain_name]`</br>

611

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

612

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

613

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

614

#

615

# * `application_domain_name` = The domain name of the app, for

616

# example <app-id>.appspot.com, which is associated with the

617

# job's project ID.

618

#

619

# * `service =` service

620

#

621

# * `version =` version

622

#

623

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

628

#

629

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

644

# to the service which is the default service when the job is attempted.

645

#

646

# If version is empty, then the job will be sent

647

# to the version which is the default version when the job is attempted.

648

#

649

# If instance is empty, then the job will be

650

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

655

# to the default version of the default service when the job is attempted.

656

"service": "A String", # App service.

657

#

658

# By default, the job is sent to the service which is the default

659

# service when the job is attempted.

660

"instance": "A String", # App instance.

661

#

662

# By default, the job is sent to an instance which is available when

663

# the job is attempted.

664

#

665

# Requests can only be sent to a specific instance if

666

# [manual scaling is used in App Engine

667

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

668

# App Engine Flex does not support instances. For more information, see

669

# [App Engine Standard request

670

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

671

# and [App Engine Flex request

672

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

673

},

674

},

675

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

676

# different programming environments, including REST APIs and RPC APIs. It is

677

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

678

# three pieces of data: error code, error message, and error details.

679

#

680

# You can find out more about this error model and how to work with it in the

681

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

682

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

683

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

684

# user-facing error message should be localized and sent in the

685

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

686

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

687

# message types for APIs to use.

688

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

689

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

690

},

691

],

692

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

693

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

694

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

695

# By default, if a job does not complete successfully (meaning that

696

# an acknowledgement is not received from the handler, then it will be retried

697

# with exponential backoff according to the settings in RetryConfig.

698

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

699

# execution was first attempted. If specified with

700

# retry_count, the job will be retried until both

701

# limits are reached.

702

#

703

# The default value for max_retry_duration is zero, which means retry

704

# duration is unlimited.

705

"retryCount": 42, # The number of attempts that the system will make to run a job using the

706

# exponential backoff procedure described by

707

# max_doublings.

708

#

709

# The default value of retry_count is zero.

710

#

711

# If retry_count is zero, a job attempt will *not* be retried if

712

# it fails. Instead the Cloud Scheduler system will wait for the

713

# next scheduled execution time.

714

#

715

# If retry_count is set to a non-zero number then Cloud Scheduler

716

# will retry failed attempts, using exponential backoff,

717

# retry_count times, or until the next scheduled execution time,

718

# whichever comes first.

719

#

720

# Values greater than 5 and negative values are not allowed.

721

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

722

#

723

# A job's retry interval starts at

724

# min_backoff_duration, then doubles

725

# `max_doublings` times, then increases linearly, and finally

726

# retries at intervals of

727

# max_backoff_duration up to

728

# retry_count times.

729

#

730

# For example, if min_backoff_duration is

731

# 10s, max_backoff_duration is 300s, and

732

# `max_doublings` is 3, then the a job will first be retried in 10s. The

733

# retry interval will double three times, and then increase linearly by

734

# 2^3 * 10s. Finally, the job will retry at intervals of

735

# max_backoff_duration until the job has

736

# been attempted retry_count times. Thus, the

737

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

738

#

739

# The default value of this field is 5.

740

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

741

# it fails.

742

#

743

# The default value of this field is 1 hour.

744

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

745

# it fails.

746

#

747

# The default value of this field is 5 seconds.

748

},

749

"state": "A String", # Output only. State of the job.

750

"name": "A String", # Optionally caller-specified in CreateJob, after

751

# which it becomes output only.

752

#

753

# The job name. For example:

754

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

755

#

756

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

757

# hyphens (-), colons (:), or periods (.).

758

# For more information, see

759

# [Identifying

760

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

761

# * `LOCATION_ID` is the canonical ID for the job's location.

762

# The list of available locations can be obtained by calling

763

# ListLocations.

764

# For more information, see https://cloud.google.com/about/locations/.

765

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

766

# hyphens (-), or underscores (_). The maximum length is 500 characters.

767

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

768

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

769

# retry of a previously failed attempt or the next execution time

770

# according to the schedule.

771

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

772

#

773

# Describes the schedule on which the job will be executed.

774

#

775

# The schedule can be either of the following types:

776

#

777

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

778

# * English-like

779

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

780

#

781

# As a general rule, execution `n + 1` of a job will not begin

782

# until execution `n` has finished. Cloud Scheduler will never

783

# allow two simultaneously outstanding executions. For example,

784

# this implies that if the `n+1`th execution is scheduled to run at

785

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

786

# execution will not start until `16:15`.

787

# A scheduled start time will be delayed if the previous

788

# execution has not ended when its scheduled time occurs.

789

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

790

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

791

# the job will be tried a total of retry_count

792

# times, with exponential backoff, until the next scheduled start

793

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

794

"userUpdateTime": "A String", # Output only. The creation time of the job.

795

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

796

# this deadline then the request is cancelled and the attempt is marked as a

797

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

798

# execution logs. Cloud Scheduler will retry the job according

799

# to the RetryConfig.

800

#

801

# The allowed duration for this deadline is:

802

# * For HTTP targets, between 15 seconds and 30 minutes.

803

# * For App Engine HTTP targets, between 15

804

# seconds and 24 hours.

805

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

806

# an HTTP request via an http_method such as HTTP

807

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

808

# response code in the range [200 - 299]. A failure to receive a response

809

# constitutes a failed execution. For a redirected request, the response

810

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

811

"httpMethod": "A String", # Which HTTP method to use for the request.

812

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

813

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

814

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

815

"oauthToken": { # Contains information needed for generating an # If specified, an

816

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

817

# will be generated and attached as an `Authorization` header in the HTTP

818

# request.

819

#

820

# This type of authorization should generally only be used when calling

821

# Google APIs hosted on *.googleapis.com.

822

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

823

# This type of authorization should generally only be used when calling Google

824

# APIs hosted on *.googleapis.com.

825

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

826

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

827

# will be used.

828

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

829

# to be used for generating OAuth token.

830

# The service account must be within the same project as the job. The caller

831

# must have iam.serviceAccounts.actAs permission for the service account.

832

},

833

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

834

# must begin with either "http://" or "https://". Some examples of

835

# valid values for uri are:

836

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

837

# encode some characters for safety and compatibility. The maximum allowed

838

# URL length is 2083 characters after encoding.

839

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

840

# HTTP request. This map contains the header field names and

841

# values. Repeated headers are not supported, but a header value can

842

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

843

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

844

# headers will be ignored or replaced. A partial list of headers that

845

# will be ignored or replaced is below:

846

# - Host: This will be computed by Cloud Scheduler and derived from

847

# uri.

848

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

849

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

850

# * `X-Google-*`: Google internal use only.

851

# * `X-AppEngine-*`: Google internal use only.

852

#

853

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

854

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

855

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

856

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

857

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

858

# token will be generated and attached as an `Authorization` header in the

859

# HTTP request.

860

#

861

# This type of authorization can be used for many scenarios, including

862

# calling Cloud Run, or endpoints where you intend to validate the token

863

# yourself.

864

# [OpenID Connect

865

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

866

# This type of authorization can be used for many scenarios, including

867

# calling Cloud Run, or endpoints where you intend to validate the token

868

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

869

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

870

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

871

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

872

# to be used for generating OIDC token.

873

# The service account must be within the same project as the job. The caller

874

# must have iam.serviceAccounts.actAs permission for the service account.

875

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

876

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

877

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

878

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

879

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

880

#

881

# Pubsub message must contain either non-empty data, or at least one

882

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

883

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

884

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

885

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

886

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

887

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

888

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

889

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

890

#

891

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

892

"data": "A String", # The message payload for PubsubMessage.

893

#

894

# Pubsub message must contain either non-empty data, or at least one

895

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

896

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

902

<pre>Deletes a job.

903

904

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

905

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

906

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

907

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

914

915

{ # A generic empty message that you can re-use to avoid defining duplicated

916

# empty messages in your APIs. A typical example is to use it as the request

917

# or the response type of an API method. For instance:

918

#

919

# service Foo {

920

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

921

# }

922

#

923

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

929

<pre>Gets a job.

930

931

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

932

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

933

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

934

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

941

942

{ # Configuration for a job.

943

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

944

"timeZone": "A String", # Specifies the time zone to be used in interpreting

945

# schedule. The value of this field must be a time

946

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

947

#

948

# Note that some time zones include a provision for

949

# daylight savings time. The rules for daylight saving time are

950

# determined by the chosen tz. For UTC use the string "utc". If a

951

# time zone is not specified, the default will be in UTC (also known

952

# as GMT).

953

"description": "A String", # Optionally caller-specified in CreateJob or

954

# UpdateJob.

955

#

956

# A human-readable description for the job. This string must not contain

957

# more than 500 characters.

958

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

959

# of an HTTP request via an http_method such

960

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

961

# HTTP response code in the range [200 - 299]. Error 503 is

962

# considered an App Engine system error instead of an application

963

# error. Requests returning error 503 will be retried regardless of

964

# retry configuration and not counted against retry counts. Any other

965

# response code, or a failure to receive a response before the

966

# deadline, constitutes a failed attempt.

967

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

968

# permitted.

969

"body": "A String", # Body.

970

#

971

# HTTP request body. A request body is allowed only if the HTTP method is

972

# POST or PUT. It will result in invalid argument error to set a body on a

973

# job with an incompatible HttpMethod.

974

"relativeUri": "A String", # The relative URI.

975

#

976

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

977

# It can contain a path, query string arguments, and `#` fragments.

978

# If the relative URL is empty, then the root path "/" will be used.

979

# No spaces are allowed, and the maximum length allowed is 2083 characters.

980

"headers": { # HTTP request headers.

981

#

982

# This map contains the header field names and values. Headers can be set

983

# when the job is created.

984

#

985

# Cloud Scheduler sets some headers to default values:

986

#

987

# * `User-Agent`: By default, this header is

988

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

989

# This header can be modified, but Cloud Scheduler will append

990

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

991

# modified `User-Agent`.

992

# * `X-CloudScheduler`: This header will be set to true.

993

#

994

# If the job has an body, Cloud Scheduler sets

995

# the following headers:

996

#

997

# * `Content-Type`: By default, the `Content-Type` header is set to

998

# `"application/octet-stream"`. The default can be overridden by explictly

999

# setting `Content-Type` to a particular media type when the job is

1000

# created.

1001

# For example, `Content-Type` can be set to `"application/json"`.

1002

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

1003

# output only. It cannot be changed.

1004

#

1005

# The headers below are output only. They cannot be set or overridden:

1006

#

1007

# * `X-Google-*`: For Google internal use only.

1008

# * `X-AppEngine-*`: For Google internal use only.

1009

#

1010

# In addition, some App Engine headers, which contain

1011

# job-specific information, are also be sent to the job handler.

1012

"a_key": "A String",

1013

},

1014

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

1015

#

1016

# For more information about services, versions, and instances see

1017

# [An Overview of App

1018

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

1019

# [Microservices Architecture on Google App

1020

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

1021

# [App Engine Standard request

1022

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

1023

# and [App Engine Flex request

1024

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1025

"version": "A String", # App version.

1026

#

1027

# By default, the job is sent to the version which is the default

1028

# version when the job is attempted.

1029

"host": "A String", # Output only. The host that the job is sent to.

1030

#

1031

# For more information about how App Engine requests are routed, see

1032

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1033

#

1034

# The host is constructed as:

1035

#

1036

#

1037

# * `host = [application_domain_name]`</br>

1038

# `| [service] + '.' + [application_domain_name]`</br>

1039

# `| [version] + '.' + [application_domain_name]`</br>

1040

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1041

# `| [instance] + '.' + [application_domain_name]`</br>

1042

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1043

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1044

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1045

#

1046

# * `application_domain_name` = The domain name of the app, for

1047

# example <app-id>.appspot.com, which is associated with the

1048

# job's project ID.

1049

#

1050

# * `service =` service

1051

#

1052

# * `version =` version

1053

#

1054

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1059

#

1060

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

1075

# to the service which is the default service when the job is attempted.

1076

#

1077

# If version is empty, then the job will be sent

1078

# to the version which is the default version when the job is attempted.

1079

#

1080

# If instance is empty, then the job will be

1081

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

1086

# to the default version of the default service when the job is attempted.

1087

"service": "A String", # App service.

1088

#

1089

# By default, the job is sent to the service which is the default

1090

# service when the job is attempted.

1091

"instance": "A String", # App instance.

1092

#

1093

# By default, the job is sent to an instance which is available when

1094

# the job is attempted.

1095

#

1096

# Requests can only be sent to a specific instance if

1097

# [manual scaling is used in App Engine

1098

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

1099

# App Engine Flex does not support instances. For more information, see

1100

# [App Engine Standard request

1101

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

1102

# and [App Engine Flex request

1103

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1104

},

1105

},

1106

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1107

# different programming environments, including REST APIs and RPC APIs. It is

1108

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1109

# three pieces of data: error code, error message, and error details.

1110

#

1111

# You can find out more about this error model and how to work with it in the

1112

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1113

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1114

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1115

# user-facing error message should be localized and sent in the

1116

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1117

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1118

# message types for APIs to use.

1119

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1120

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1121

},

1122

],

1123

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1124

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1125

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1126

# By default, if a job does not complete successfully (meaning that

1127

# an acknowledgement is not received from the handler, then it will be retried

1128

# with exponential backoff according to the settings in RetryConfig.

1129

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

1130

# execution was first attempted. If specified with

1131

# retry_count, the job will be retried until both

1132

# limits are reached.

1133

#

1134

# The default value for max_retry_duration is zero, which means retry

1135

# duration is unlimited.

1136

"retryCount": 42, # The number of attempts that the system will make to run a job using the

1137

# exponential backoff procedure described by

1138

# max_doublings.

1139

#

1140

# The default value of retry_count is zero.

1141

#

1142

# If retry_count is zero, a job attempt will *not* be retried if

1143

# it fails. Instead the Cloud Scheduler system will wait for the

1144

# next scheduled execution time.

1145

#

1146

# If retry_count is set to a non-zero number then Cloud Scheduler

1147

# will retry failed attempts, using exponential backoff,

1148

# retry_count times, or until the next scheduled execution time,

1149

# whichever comes first.

1150

#

1151

# Values greater than 5 and negative values are not allowed.

1152

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

1153

#

1154

# A job's retry interval starts at

1155

# min_backoff_duration, then doubles

1156

# `max_doublings` times, then increases linearly, and finally

1157

# retries at intervals of

1158

# max_backoff_duration up to

1159

# retry_count times.

1160

#

1161

# For example, if min_backoff_duration is

1162

# 10s, max_backoff_duration is 300s, and

1163

# `max_doublings` is 3, then the a job will first be retried in 10s. The

1164

# retry interval will double three times, and then increase linearly by

1165

# 2^3 * 10s. Finally, the job will retry at intervals of

1166

# max_backoff_duration until the job has

1167

# been attempted retry_count times. Thus, the

1168

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

1169

#

1170

# The default value of this field is 5.

1171

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

1172

# it fails.

1173

#

1174

# The default value of this field is 1 hour.

1175

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

1176

# it fails.

1177

#

1178

# The default value of this field is 5 seconds.

1179

},

1180

"state": "A String", # Output only. State of the job.

1181

"name": "A String", # Optionally caller-specified in CreateJob, after

1182

# which it becomes output only.

1183

#

1184

# The job name. For example:

1185

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1186

#

1187

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1188

# hyphens (-), colons (:), or periods (.).

1189

# For more information, see

1190

# [Identifying

1191

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

1192

# * `LOCATION_ID` is the canonical ID for the job's location.

1193

# The list of available locations can be obtained by calling

1194

# ListLocations.

1195

# For more information, see https://cloud.google.com/about/locations/.

1196

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1197

# hyphens (-), or underscores (_). The maximum length is 500 characters.

1198

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

1199

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

1200

# retry of a previously failed attempt or the next execution time

1201

# according to the schedule.

1202

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1203

#

1204

# Describes the schedule on which the job will be executed.

1205

#

1206

# The schedule can be either of the following types:

1207

#

1208

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

1209

# * English-like

1210

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

1211

#

1212

# As a general rule, execution `n + 1` of a job will not begin

1213

# until execution `n` has finished. Cloud Scheduler will never

1214

# allow two simultaneously outstanding executions. For example,

1215

# this implies that if the `n+1`th execution is scheduled to run at

1216

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

1217

# execution will not start until `16:15`.

1218

# A scheduled start time will be delayed if the previous

1219

# execution has not ended when its scheduled time occurs.

1220

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1221

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1222

# the job will be tried a total of retry_count

1223

# times, with exponential backoff, until the next scheduled start

1224

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1225

"userUpdateTime": "A String", # Output only. The creation time of the job.

1226

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

1227

# this deadline then the request is cancelled and the attempt is marked as a

1228

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

1229

# execution logs. Cloud Scheduler will retry the job according

1230

# to the RetryConfig.

1231

#

1232

# The allowed duration for this deadline is:

1233

# * For HTTP targets, between 15 seconds and 30 minutes.

1234

# * For App Engine HTTP targets, between 15

1235

# seconds and 24 hours.

1236

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1237

# an HTTP request via an http_method such as HTTP

1238

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

1239

# response code in the range [200 - 299]. A failure to receive a response

1240

# constitutes a failed execution. For a redirected request, the response

1241

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

"httpMethod": "A String", # Which HTTP method to use for the request.

1243

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1244

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

1245

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1246

"oauthToken": { # Contains information needed for generating an # If specified, an

1247

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

1248

# will be generated and attached as an `Authorization` header in the HTTP

1249

# request.

1250

#

1251

# This type of authorization should generally only be used when calling

1252

# Google APIs hosted on *.googleapis.com.

1253

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

1254

# This type of authorization should generally only be used when calling Google

1255

# APIs hosted on *.googleapis.com.

1256

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

1257

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

1258

# will be used.

1259

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

1260

# to be used for generating OAuth token.

1261

# The service account must be within the same project as the job. The caller

1262

# must have iam.serviceAccounts.actAs permission for the service account.

1263

},

1264

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

1265

# must begin with either "http://" or "https://". Some examples of

1266

# valid values for uri are:

1267

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

1268

# encode some characters for safety and compatibility. The maximum allowed

1269

# URL length is 2083 characters after encoding.

1270

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1271

# HTTP request. This map contains the header field names and

1272

# values. Repeated headers are not supported, but a header value can

1273

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1275

# headers will be ignored or replaced. A partial list of headers that

1276

# will be ignored or replaced is below:

1277

# - Host: This will be computed by Cloud Scheduler and derived from

1278

# uri.

1279

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1281

# * `X-Google-*`: Google internal use only.

1282

# * `X-AppEngine-*`: Google internal use only.

1283

#

1284

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1285

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1286

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1287

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1288

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

1289

# token will be generated and attached as an `Authorization` header in the

1290

# HTTP request.

1291

#

1292

# This type of authorization can be used for many scenarios, including

1293

# calling Cloud Run, or endpoints where you intend to validate the token

1294

# yourself.

1295

# [OpenID Connect

1296

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

1297

# This type of authorization can be used for many scenarios, including

1298

# calling Cloud Run, or endpoints where you intend to validate the token

1299

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1300

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1301

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1302

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1303

# to be used for generating OIDC token.

1304

# The service account must be within the same project as the job. The caller

1305

# must have iam.serviceAccounts.actAs permission for the service account.

1306

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1308

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1309

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1310

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1311

#

1312

# Pubsub message must contain either non-empty data, or at least one

1313

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1314

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1316

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1317

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1319

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

1320

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

1321

#

1322

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1323

"data": "A String", # The message payload for PubsubMessage.

1324

#

1325

# Pubsub message must contain either non-empty data, or at least one

1326

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1327

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1332

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1333

<pre>Lists jobs.

1334

1335

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1336

parent: string, Required. The location name. For example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1337

`projects/PROJECT_ID/locations/LOCATION_ID`. (required)

1338

pageToken: string, A token identifying a page of results the server will return. To

1339

request the first page results, page_token must be empty. To

1340

request the next page of results, page_token must be the value of

1341

next_page_token returned from

1342

the previous call to ListJobs. It is an error to

1343

switch the value of filter or

1344

order_by while iterating through pages.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1345

pageSize: integer, Requested page size.

1346

1347

The maximum page size is 500. If unspecified, the page size will

1348

be the maximum. Fewer jobs than requested might be returned,

1349

even if more jobs exist; use next_page_token to determine if more

1350

jobs exist.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1351

x__xgafv: string, V1 error format.

1352

Allowed values

1353

1 - v1 error format

1354

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1355

1356

Returns:

1357

An object of the form:

1358

1359

{ # Response message for listing jobs using ListJobs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1360

"jobs": [ # The list of jobs.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1361

{ # Configuration for a job.

1362

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

"timeZone": "A String", # Specifies the time zone to be used in interpreting

1364

# schedule. The value of this field must be a time

1365

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

1366

#

1367

# Note that some time zones include a provision for

1368

# daylight savings time. The rules for daylight saving time are

1369

# determined by the chosen tz. For UTC use the string "utc". If a

1370

# time zone is not specified, the default will be in UTC (also known

1371

# as GMT).

1372

"description": "A String", # Optionally caller-specified in CreateJob or

1373

# UpdateJob.

1374

#

1375

# A human-readable description for the job. This string must not contain

1376

# more than 500 characters.

1377

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

1378

# of an HTTP request via an http_method such

1379

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

1380

# HTTP response code in the range [200 - 299]. Error 503 is

1381

# considered an App Engine system error instead of an application

1382

# error. Requests returning error 503 will be retried regardless of

1383

# retry configuration and not counted against retry counts. Any other

1384

# response code, or a failure to receive a response before the

1385

# deadline, constitutes a failed attempt.

1386

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

1387

# permitted.

1388

"body": "A String", # Body.

1389

#

1390

# HTTP request body. A request body is allowed only if the HTTP method is

1391

# POST or PUT. It will result in invalid argument error to set a body on a

1392

# job with an incompatible HttpMethod.

1393

"relativeUri": "A String", # The relative URI.

1394

#

1395

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

1396

# It can contain a path, query string arguments, and `#` fragments.

1397

# If the relative URL is empty, then the root path "/" will be used.

1398

# No spaces are allowed, and the maximum length allowed is 2083 characters.

1399

"headers": { # HTTP request headers.

1400

#

1401

# This map contains the header field names and values. Headers can be set

1402

# when the job is created.

1403

#

1404

# Cloud Scheduler sets some headers to default values:

1405

#

1406

# * `User-Agent`: By default, this header is

1407

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

1408

# This header can be modified, but Cloud Scheduler will append

1409

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

1410

# modified `User-Agent`.

1411

# * `X-CloudScheduler`: This header will be set to true.

1412

#

1413

# If the job has an body, Cloud Scheduler sets

1414

# the following headers:

1415

#

1416

# * `Content-Type`: By default, the `Content-Type` header is set to

1417

# `"application/octet-stream"`. The default can be overridden by explictly

1418

# setting `Content-Type` to a particular media type when the job is

1419

# created.

1420

# For example, `Content-Type` can be set to `"application/json"`.

1421

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

1422

# output only. It cannot be changed.

1423

#

1424

# The headers below are output only. They cannot be set or overridden:

1425

#

1426

# * `X-Google-*`: For Google internal use only.

1427

# * `X-AppEngine-*`: For Google internal use only.

1428

#

1429

# In addition, some App Engine headers, which contain

1430

# job-specific information, are also be sent to the job handler.

1431

"a_key": "A String",

1432

},

1433

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

1434

#

1435

# For more information about services, versions, and instances see

1436

# [An Overview of App

1437

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

1438

# [Microservices Architecture on Google App

1439

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

1440

# [App Engine Standard request

1441

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

1442

# and [App Engine Flex request

1443

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1444

"version": "A String", # App version.

1445

#

1446

# By default, the job is sent to the version which is the default

1447

# version when the job is attempted.

1448

"host": "A String", # Output only. The host that the job is sent to.

1449

#

1450

# For more information about how App Engine requests are routed, see

1451

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1452

#

1453

# The host is constructed as:

1454

#

1455

#

1456

# * `host = [application_domain_name]`</br>

1457

# `| [service] + '.' + [application_domain_name]`</br>

1458

# `| [version] + '.' + [application_domain_name]`</br>

1459

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1460

# `| [instance] + '.' + [application_domain_name]`</br>

1461

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1462

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1463

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1464

#

1465

# * `application_domain_name` = The domain name of the app, for

1466

# example <app-id>.appspot.com, which is associated with the

1467

# job's project ID.

1468

#

1469

# * `service =` service

1470

#

1471

# * `version =` version

1472

#

1473

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1478

#

1479

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

1494

# to the service which is the default service when the job is attempted.

1495

#

1496

# If version is empty, then the job will be sent

1497

# to the version which is the default version when the job is attempted.

1498

#

1499

# If instance is empty, then the job will be

1500

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

1505

# to the default version of the default service when the job is attempted.

1506

"service": "A String", # App service.

1507

#

1508

# By default, the job is sent to the service which is the default

1509

# service when the job is attempted.

1510

"instance": "A String", # App instance.

1511

#

1512

# By default, the job is sent to an instance which is available when

1513

# the job is attempted.

1514

#

1515

# Requests can only be sent to a specific instance if

1516

# [manual scaling is used in App Engine

1517

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

1518

# App Engine Flex does not support instances. For more information, see

1519

# [App Engine Standard request

1520

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

1521

# and [App Engine Flex request

1522

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1523

},

1524

},

1525

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1526

# different programming environments, including REST APIs and RPC APIs. It is

1527

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1528

# three pieces of data: error code, error message, and error details.

1529

#

1530

# You can find out more about this error model and how to work with it in the

1531

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1532

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1533

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1534

# user-facing error message should be localized and sent in the

1535

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1536

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1537

# message types for APIs to use.

1538

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1539

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1540

},

1541

],

1542

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1543

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1544

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1545

# By default, if a job does not complete successfully (meaning that

1546

# an acknowledgement is not received from the handler, then it will be retried

1547

# with exponential backoff according to the settings in RetryConfig.

1548

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

1549

# execution was first attempted. If specified with

1550

# retry_count, the job will be retried until both

1551

# limits are reached.

1552

#

1553

# The default value for max_retry_duration is zero, which means retry

1554

# duration is unlimited.

1555

"retryCount": 42, # The number of attempts that the system will make to run a job using the

1556

# exponential backoff procedure described by

1557

# max_doublings.

1558

#

1559

# The default value of retry_count is zero.

1560

#

1561

# If retry_count is zero, a job attempt will *not* be retried if

1562

# it fails. Instead the Cloud Scheduler system will wait for the

1563

# next scheduled execution time.

1564

#

1565

# If retry_count is set to a non-zero number then Cloud Scheduler

1566

# will retry failed attempts, using exponential backoff,

1567

# retry_count times, or until the next scheduled execution time,

1568

# whichever comes first.

1569

#

1570

# Values greater than 5 and negative values are not allowed.

1571

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

1572

#

1573

# A job's retry interval starts at

1574

# min_backoff_duration, then doubles

1575

# `max_doublings` times, then increases linearly, and finally

1576

# retries at intervals of

1577

# max_backoff_duration up to

1578

# retry_count times.

1579

#

1580

# For example, if min_backoff_duration is

1581

# 10s, max_backoff_duration is 300s, and

1582

# `max_doublings` is 3, then the a job will first be retried in 10s. The

1583

# retry interval will double three times, and then increase linearly by

1584

# 2^3 * 10s. Finally, the job will retry at intervals of

1585

# max_backoff_duration until the job has

1586

# been attempted retry_count times. Thus, the

1587

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

1588

#

1589

# The default value of this field is 5.

1590

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

1591

# it fails.

1592

#

1593

# The default value of this field is 1 hour.

1594

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

1595

# it fails.

1596

#

1597

# The default value of this field is 5 seconds.

1598

},

1599

"state": "A String", # Output only. State of the job.

1600

"name": "A String", # Optionally caller-specified in CreateJob, after

1601

# which it becomes output only.

1602

#

1603

# The job name. For example:

1604

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1605

#

1606

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1607

# hyphens (-), colons (:), or periods (.).

1608

# For more information, see

1609

# [Identifying

1610

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

1611

# * `LOCATION_ID` is the canonical ID for the job's location.

1612

# The list of available locations can be obtained by calling

1613

# ListLocations.

1614

# For more information, see https://cloud.google.com/about/locations/.

1615

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1616

# hyphens (-), or underscores (_). The maximum length is 500 characters.

1617

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

1618

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

1619

# retry of a previously failed attempt or the next execution time

1620

# according to the schedule.

1621

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1622

#

1623

# Describes the schedule on which the job will be executed.

1624

#

1625

# The schedule can be either of the following types:

1626

#

1627

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

1628

# * English-like

1629

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

1630

#

1631

# As a general rule, execution `n + 1` of a job will not begin

1632

# until execution `n` has finished. Cloud Scheduler will never

1633

# allow two simultaneously outstanding executions. For example,

1634

# this implies that if the `n+1`th execution is scheduled to run at

1635

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

1636

# execution will not start until `16:15`.

1637

# A scheduled start time will be delayed if the previous

1638

# execution has not ended when its scheduled time occurs.

1639

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1640

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1641

# the job will be tried a total of retry_count

1642

# times, with exponential backoff, until the next scheduled start

1643

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1644

"userUpdateTime": "A String", # Output only. The creation time of the job.

1645

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

1646

# this deadline then the request is cancelled and the attempt is marked as a

1647

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

1648

# execution logs. Cloud Scheduler will retry the job according

1649

# to the RetryConfig.

1650

#

1651

# The allowed duration for this deadline is:

1652

# * For HTTP targets, between 15 seconds and 30 minutes.

1653

# * For App Engine HTTP targets, between 15

1654

# seconds and 24 hours.

1655

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1656

# an HTTP request via an http_method such as HTTP

1657

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

1658

# response code in the range [200 - 299]. A failure to receive a response

1659

# constitutes a failed execution. For a redirected request, the response

1660

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1661

"httpMethod": "A String", # Which HTTP method to use for the request.

1662

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1663

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

1664

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1665

"oauthToken": { # Contains information needed for generating an # If specified, an

1666

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

1667

# will be generated and attached as an `Authorization` header in the HTTP

1668

# request.

1669

#

1670

# This type of authorization should generally only be used when calling

1671

# Google APIs hosted on *.googleapis.com.

1672

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

1673

# This type of authorization should generally only be used when calling Google

1674

# APIs hosted on *.googleapis.com.

1675

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

1676

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

1677

# will be used.

1678

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

1679

# to be used for generating OAuth token.

1680

# The service account must be within the same project as the job. The caller

1681

# must have iam.serviceAccounts.actAs permission for the service account.

1682

},

1683

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

1684

# must begin with either "http://" or "https://". Some examples of

1685

# valid values for uri are:

1686

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

1687

# encode some characters for safety and compatibility. The maximum allowed

1688

# URL length is 2083 characters after encoding.

1689

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1690

# HTTP request. This map contains the header field names and

1691

# values. Repeated headers are not supported, but a header value can

1692

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1693

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1694

# headers will be ignored or replaced. A partial list of headers that

1695

# will be ignored or replaced is below:

1696

# - Host: This will be computed by Cloud Scheduler and derived from

1697

# uri.

1698

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1699

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1700

# * `X-Google-*`: Google internal use only.

1701

# * `X-AppEngine-*`: Google internal use only.

1702

#

1703

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1705

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1706

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1707

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

1708

# token will be generated and attached as an `Authorization` header in the

1709

# HTTP request.

1710

#

1711

# This type of authorization can be used for many scenarios, including

1712

# calling Cloud Run, or endpoints where you intend to validate the token

1713

# yourself.

1714

# [OpenID Connect

1715

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

1716

# This type of authorization can be used for many scenarios, including

1717

# calling Cloud Run, or endpoints where you intend to validate the token

1718

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1719

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1720

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1721

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1722

# to be used for generating OIDC token.

1723

# The service account must be within the same project as the job. The caller

1724

# must have iam.serviceAccounts.actAs permission for the service account.

1725

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1726

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1727

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1728

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1729

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1730

#

1731

# Pubsub message must contain either non-empty data, or at least one

1732

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1733

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1734

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1736

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1737

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1738

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

1739

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

1740

#

1741

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1742

"data": "A String", # The message payload for PubsubMessage.

1743

#

1744

# Pubsub message must contain either non-empty data, or at least one

1745

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1746

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1747

},

1748

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the

1750

# page_token field in the subsequent call to

1751

# ListJobs to retrieve the next page of results.

1752

# If this is empty it indicates that there are no more results

1753

# through which to paginate.

1754

#

1755

# The page token is valid for only 2 hours.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1761

<pre>Retrieves the next page of results.

1762

1763

Args:

1764

previous_request: The request for the previous page. (required)

1765

previous_response: The response from the request for the previous page. (required)

1766

1767

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1769

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1774

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1775

<pre>Updates a job.

1776

1777

If successful, the updated Job is returned. If the job does

1778

not exist, `NOT_FOUND` is returned.

1779

1780

If UpdateJob does not successfully return, it is possible for the

1781

job to be in an Job.State.UPDATE_FAILED state. A job in this state may

1782

not be executed. If this happens, retry the UpdateJob request

1783

until a successful response is received.

Args:

which it becomes output only.

1788

1789

The job name. For example:

1790

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1791

1792

* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1793

hyphens (-), colons (:), or periods (.).

1794

For more information, see

1795

[Identifying

1796

projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1797

* `LOCATION_ID` is the canonical ID for the job's location.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1798

The list of available locations can be obtained by calling

1799

ListLocations.

1800

For more information, see https://cloud.google.com/about/locations/.

1801

* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1802

hyphens (-), or underscores (_). The maximum length is 500 characters. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1803

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1804

The object takes the form of:

1805

1806

{ # Configuration for a job.

1807

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1808

"timeZone": "A String", # Specifies the time zone to be used in interpreting

1809

# schedule. The value of this field must be a time

1810

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

1811

#

1812

# Note that some time zones include a provision for

1813

# daylight savings time. The rules for daylight saving time are

1814

# determined by the chosen tz. For UTC use the string "utc". If a

1815

# time zone is not specified, the default will be in UTC (also known

1816

# as GMT).

1817

"description": "A String", # Optionally caller-specified in CreateJob or

1818

# UpdateJob.

1819

#

1820

# A human-readable description for the job. This string must not contain

1821

# more than 500 characters.

1822

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

1823

# of an HTTP request via an http_method such

1824

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

1825

# HTTP response code in the range [200 - 299]. Error 503 is

1826

# considered an App Engine system error instead of an application

1827

# error. Requests returning error 503 will be retried regardless of

1828

# retry configuration and not counted against retry counts. Any other

1829

# response code, or a failure to receive a response before the

1830

# deadline, constitutes a failed attempt.

1831

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

1832

# permitted.

1833

"body": "A String", # Body.

1834

#

1835

# HTTP request body. A request body is allowed only if the HTTP method is

1836

# POST or PUT. It will result in invalid argument error to set a body on a

1837

# job with an incompatible HttpMethod.

1838

"relativeUri": "A String", # The relative URI.

1839

#

1840

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

1841

# It can contain a path, query string arguments, and `#` fragments.

1842

# If the relative URL is empty, then the root path "/" will be used.

1843

# No spaces are allowed, and the maximum length allowed is 2083 characters.

1844

"headers": { # HTTP request headers.

1845

#

1846

# This map contains the header field names and values. Headers can be set

1847

# when the job is created.

1848

#

1849

# Cloud Scheduler sets some headers to default values:

1850

#

1851

# * `User-Agent`: By default, this header is

1852

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

1853

# This header can be modified, but Cloud Scheduler will append

1854

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

1855

# modified `User-Agent`.

1856

# * `X-CloudScheduler`: This header will be set to true.

1857

#

1858

# If the job has an body, Cloud Scheduler sets

1859

# the following headers:

1860

#

1861

# * `Content-Type`: By default, the `Content-Type` header is set to

1862

# `"application/octet-stream"`. The default can be overridden by explictly

1863

# setting `Content-Type` to a particular media type when the job is

1864

# created.

1865

# For example, `Content-Type` can be set to `"application/json"`.

1866

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

1867

# output only. It cannot be changed.

1868

#

1869

# The headers below are output only. They cannot be set or overridden:

1870

#

1871

# * `X-Google-*`: For Google internal use only.

1872

# * `X-AppEngine-*`: For Google internal use only.

1873

#

1874

# In addition, some App Engine headers, which contain

1875

# job-specific information, are also be sent to the job handler.

1876

"a_key": "A String",

1877

},

1878

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

1879

#

1880

# For more information about services, versions, and instances see

1881

# [An Overview of App

1882

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

1883

# [Microservices Architecture on Google App

1884

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

1885

# [App Engine Standard request

1886

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

1887

# and [App Engine Flex request

1888

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1889

"version": "A String", # App version.

1890

#

1891

# By default, the job is sent to the version which is the default

1892

# version when the job is attempted.

1893

"host": "A String", # Output only. The host that the job is sent to.

1894

#

1895

# For more information about how App Engine requests are routed, see

1896

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1897

#

1898

# The host is constructed as:

1899

#

1900

#

1901

# * `host = [application_domain_name]`</br>

1902

# `| [service] + '.' + [application_domain_name]`</br>

1903

# `| [version] + '.' + [application_domain_name]`</br>

1904

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1905

# `| [instance] + '.' + [application_domain_name]`</br>

1906

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1907

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1908

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1909

#

1910

# * `application_domain_name` = The domain name of the app, for

1911

# example <app-id>.appspot.com, which is associated with the

1912

# job's project ID.

1913

#

1914

# * `service =` service

1915

#

1916

# * `version =` version

1917

#

1918

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1923

#

1924

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

1939

# to the service which is the default service when the job is attempted.

1940

#

1941

# If version is empty, then the job will be sent

1942

# to the version which is the default version when the job is attempted.

1943

#

1944

# If instance is empty, then the job will be

1945

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

1950

# to the default version of the default service when the job is attempted.

1951

"service": "A String", # App service.

1952

#

1953

# By default, the job is sent to the service which is the default

1954

# service when the job is attempted.

1955

"instance": "A String", # App instance.

1956

#

1957

# By default, the job is sent to an instance which is available when

1958

# the job is attempted.

1959

#

1960

# Requests can only be sent to a specific instance if

1961

# [manual scaling is used in App Engine

1962

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

1963

# App Engine Flex does not support instances. For more information, see

1964

# [App Engine Standard request

1965

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

1966

# and [App Engine Flex request

1967

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

1968

},

1969

},

1970

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1971

# different programming environments, including REST APIs and RPC APIs. It is

1972

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1973

# three pieces of data: error code, error message, and error details.

1974

#

1975

# You can find out more about this error model and how to work with it in the

1976

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1977

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1978

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1979

# user-facing error message should be localized and sent in the

1980

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1981

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1982

# message types for APIs to use.

1983

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1984

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1985

},

1986

],

1987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

1989

#

1990

# By default, if a job does not complete successfully (meaning that

1991

# an acknowledgement is not received from the handler, then it will be retried

1992

# with exponential backoff according to the settings in RetryConfig.

1993

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

1994

# execution was first attempted. If specified with

1995

# retry_count, the job will be retried until both

1996

# limits are reached.

1997

#

1998

# The default value for max_retry_duration is zero, which means retry

1999

# duration is unlimited.

2000

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2001

# exponential backoff procedure described by

2002

# max_doublings.

2003

#

2004

# The default value of retry_count is zero.

2005

#

2006

# If retry_count is zero, a job attempt will *not* be retried if

2007

# it fails. Instead the Cloud Scheduler system will wait for the

2008

# next scheduled execution time.

2009

#

2010

# If retry_count is set to a non-zero number then Cloud Scheduler

2011

# will retry failed attempts, using exponential backoff,

2012

# retry_count times, or until the next scheduled execution time,

2013

# whichever comes first.

2014

#

2015

# Values greater than 5 and negative values are not allowed.

2016

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2017

#

2018

# A job's retry interval starts at

2019

# min_backoff_duration, then doubles

2020

# `max_doublings` times, then increases linearly, and finally

2021

# retries at intervals of

2022

# max_backoff_duration up to

2023

# retry_count times.

2024

#

2025

# For example, if min_backoff_duration is

2026

# 10s, max_backoff_duration is 300s, and

2027

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2028

# retry interval will double three times, and then increase linearly by

2029

# 2^3 * 10s. Finally, the job will retry at intervals of

2030

# max_backoff_duration until the job has

2031

# been attempted retry_count times. Thus, the

2032

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2033

#

2034

# The default value of this field is 5.

2035

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2036

# it fails.

2037

#

2038

# The default value of this field is 1 hour.

2039

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2040

# it fails.

2041

#

2042

# The default value of this field is 5 seconds.

2043

},

2044

"state": "A String", # Output only. State of the job.

2045

"name": "A String", # Optionally caller-specified in CreateJob, after

2046

# which it becomes output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2047

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2048

# The job name. For example:

2049

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2050

#

2051

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2052

# hyphens (-), colons (:), or periods (.).

2053

# For more information, see

2054

# [Identifying

2055

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2056

# * `LOCATION_ID` is the canonical ID for the job's location.

2057

# The list of available locations can be obtained by calling

2058

# ListLocations.

2059

# For more information, see https://cloud.google.com/about/locations/.

2060

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2061

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2062

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2063

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2064

# retry of a previously failed attempt or the next execution time

2065

# according to the schedule.

2066

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2067

#

2068

# Describes the schedule on which the job will be executed.

2069

#

2070

# The schedule can be either of the following types:

2071

#

2072

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2073

# * English-like

2074

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2075

#

2076

# As a general rule, execution `n + 1` of a job will not begin

2077

# until execution `n` has finished. Cloud Scheduler will never

2078

# allow two simultaneously outstanding executions. For example,

2079

# this implies that if the `n+1`th execution is scheduled to run at

2080

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2081

# execution will not start until `16:15`.

2082

# A scheduled start time will be delayed if the previous

2083

# execution has not ended when its scheduled time occurs.

2084

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2085

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2086

# the job will be tried a total of retry_count

2087

# times, with exponential backoff, until the next scheduled start

2088

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2089

"userUpdateTime": "A String", # Output only. The creation time of the job.

2090

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2091

# this deadline then the request is cancelled and the attempt is marked as a

2092

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2093

# execution logs. Cloud Scheduler will retry the job according

2094

# to the RetryConfig.

2095

#

2096

# The allowed duration for this deadline is:

2097

# * For HTTP targets, between 15 seconds and 30 minutes.

2098

# * For App Engine HTTP targets, between 15

2099

# seconds and 24 hours.

2100

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2101

# an HTTP request via an http_method such as HTTP

2102

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2103

# response code in the range [200 - 299]. A failure to receive a response

2104

# constitutes a failed execution. For a redirected request, the response

2105

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2106

"httpMethod": "A String", # Which HTTP method to use for the request.

2107

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2108

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2109

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2110

"oauthToken": { # Contains information needed for generating an # If specified, an

2111

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2112

# will be generated and attached as an `Authorization` header in the HTTP

2113

# request.

2114

#

2115

# This type of authorization should generally only be used when calling

2116

# Google APIs hosted on *.googleapis.com.

2117

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2118

# This type of authorization should generally only be used when calling Google

2119

# APIs hosted on *.googleapis.com.

2120

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2121

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2122

# will be used.

2123

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2124

# to be used for generating OAuth token.

2125

# The service account must be within the same project as the job. The caller

2126

# must have iam.serviceAccounts.actAs permission for the service account.

2127

},

2128

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2129

# must begin with either "http://" or "https://". Some examples of

2130

# valid values for uri are:

2131

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2132

# encode some characters for safety and compatibility. The maximum allowed

2133

# URL length is 2083 characters after encoding.

2134

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2135

# HTTP request. This map contains the header field names and

2136

# values. Repeated headers are not supported, but a header value can

2137

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2138

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2139

# headers will be ignored or replaced. A partial list of headers that

2140

# will be ignored or replaced is below:

2141

# - Host: This will be computed by Cloud Scheduler and derived from

2142

# uri.

2143

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2145

# * `X-Google-*`: Google internal use only.

2146

# * `X-AppEngine-*`: Google internal use only.

2147

#

2148

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2149

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2150

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2151

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2152

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2153

# token will be generated and attached as an `Authorization` header in the

2154

# HTTP request.

2155

#

2156

# This type of authorization can be used for many scenarios, including

2157

# calling Cloud Run, or endpoints where you intend to validate the token

2158

# yourself.

2159

# [OpenID Connect

2160

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2161

# This type of authorization can be used for many scenarios, including

2162

# calling Cloud Run, or endpoints where you intend to validate the token

2163

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2164

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2165

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2166

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2167

# to be used for generating OIDC token.

2168

# The service account must be within the same project as the job. The caller

2169

# must have iam.serviceAccounts.actAs permission for the service account.

2170

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2171

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2172

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2173

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2174

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2175

#

2176

# Pubsub message must contain either non-empty data, or at least one

2177

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2178

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2179

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2180

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2181

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2182

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2183

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2184

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2185

#

2186

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2187

"data": "A String", # The message payload for PubsubMessage.

2188

#

2189

# Pubsub message must contain either non-empty data, or at least one

2190

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2191

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2192

}

2193

2194

updateMask: string, A mask used to specify which fields of the job are being updated.

2195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2202

2203

{ # Configuration for a job.

2204

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2205

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2206

# schedule. The value of this field must be a time

2207

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2208

#

2209

# Note that some time zones include a provision for

2210

# daylight savings time. The rules for daylight saving time are

2211

# determined by the chosen tz. For UTC use the string "utc". If a

2212

# time zone is not specified, the default will be in UTC (also known

2213

# as GMT).

2214

"description": "A String", # Optionally caller-specified in CreateJob or

2215

# UpdateJob.

2216

#

2217

# A human-readable description for the job. This string must not contain

2218

# more than 500 characters.

2219

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2220

# of an HTTP request via an http_method such

2221

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2222

# HTTP response code in the range [200 - 299]. Error 503 is

2223

# considered an App Engine system error instead of an application

2224

# error. Requests returning error 503 will be retried regardless of

2225

# retry configuration and not counted against retry counts. Any other

2226

# response code, or a failure to receive a response before the

2227

# deadline, constitutes a failed attempt.

2228

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2229

# permitted.

2230

"body": "A String", # Body.

2231

#

2232

# HTTP request body. A request body is allowed only if the HTTP method is

2233

# POST or PUT. It will result in invalid argument error to set a body on a

2234

# job with an incompatible HttpMethod.

2235

"relativeUri": "A String", # The relative URI.

2236

#

2237

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2238

# It can contain a path, query string arguments, and `#` fragments.

2239

# If the relative URL is empty, then the root path "/" will be used.

2240

# No spaces are allowed, and the maximum length allowed is 2083 characters.

2241

"headers": { # HTTP request headers.

2242

#

2243

# This map contains the header field names and values. Headers can be set

2244

# when the job is created.

2245

#

2246

# Cloud Scheduler sets some headers to default values:

2247

#

2248

# * `User-Agent`: By default, this header is

2249

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2250

# This header can be modified, but Cloud Scheduler will append

2251

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2252

# modified `User-Agent`.

2253

# * `X-CloudScheduler`: This header will be set to true.

2254

#

2255

# If the job has an body, Cloud Scheduler sets

2256

# the following headers:

2257

#

2258

# * `Content-Type`: By default, the `Content-Type` header is set to

2259

# `"application/octet-stream"`. The default can be overridden by explictly

2260

# setting `Content-Type` to a particular media type when the job is

2261

# created.

2262

# For example, `Content-Type` can be set to `"application/json"`.

2263

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2264

# output only. It cannot be changed.

2265

#

2266

# The headers below are output only. They cannot be set or overridden:

2267

#

2268

# * `X-Google-*`: For Google internal use only.

2269

# * `X-AppEngine-*`: For Google internal use only.

2270

#

2271

# In addition, some App Engine headers, which contain

2272

# job-specific information, are also be sent to the job handler.

2273

"a_key": "A String",

2274

},

2275

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2276

#

2277

# For more information about services, versions, and instances see

2278

# [An Overview of App

2279

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2280

# [Microservices Architecture on Google App

2281

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2282

# [App Engine Standard request

2283

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2284

# and [App Engine Flex request

2285

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

2286

"version": "A String", # App version.

2287

#

2288

# By default, the job is sent to the version which is the default

2289

# version when the job is attempted.

2290

"host": "A String", # Output only. The host that the job is sent to.

2291

#

2292

# For more information about how App Engine requests are routed, see

2293

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2294

#

2295

# The host is constructed as:

2296

#

2297

#

2298

# * `host = [application_domain_name]`</br>

2299

# `| [service] + '.' + [application_domain_name]`</br>

2300

# `| [version] + '.' + [application_domain_name]`</br>

2301

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2302

# `| [instance] + '.' + [application_domain_name]`</br>

2303

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2304

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2305

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2306

#

2307

# * `application_domain_name` = The domain name of the app, for

2308

# example <app-id>.appspot.com, which is associated with the

2309

# job's project ID.

2310

#

2311

# * `service =` service

2312

#

2313

# * `version =` version

2314

#

2315

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2320

#

2321

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

2336

# to the service which is the default service when the job is attempted.

2337

#

2338

# If version is empty, then the job will be sent

2339

# to the version which is the default version when the job is attempted.

2340

#

2341

# If instance is empty, then the job will be

2342

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

2347

# to the default version of the default service when the job is attempted.

2348

"service": "A String", # App service.

2349

#

2350

# By default, the job is sent to the service which is the default

2351

# service when the job is attempted.

2352

"instance": "A String", # App instance.

2353

#

2354

# By default, the job is sent to an instance which is available when

2355

# the job is attempted.

2356

#

2357

# Requests can only be sent to a specific instance if

2358

# [manual scaling is used in App Engine

2359

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2360

# App Engine Flex does not support instances. For more information, see

2361

# [App Engine Standard request

2362

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2363

# and [App Engine Flex request

2364

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

2365

},

2366

},

2367

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2368

# different programming environments, including REST APIs and RPC APIs. It is

2369

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2370

# three pieces of data: error code, error message, and error details.

2371

#

2372

# You can find out more about this error model and how to work with it in the

2373

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2374

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2375

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2376

# user-facing error message should be localized and sent in the

2377

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2378

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2379

# message types for APIs to use.

2380

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2381

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2382

},

2383

],

2384

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2386

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2387

# By default, if a job does not complete successfully (meaning that

2388

# an acknowledgement is not received from the handler, then it will be retried

2389

# with exponential backoff according to the settings in RetryConfig.

2390

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2391

# execution was first attempted. If specified with

2392

# retry_count, the job will be retried until both

2393

# limits are reached.

2394

#

2395

# The default value for max_retry_duration is zero, which means retry

2396

# duration is unlimited.

2397

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2398

# exponential backoff procedure described by

2399

# max_doublings.

2400

#

2401

# The default value of retry_count is zero.

2402

#

2403

# If retry_count is zero, a job attempt will *not* be retried if

2404

# it fails. Instead the Cloud Scheduler system will wait for the

2405

# next scheduled execution time.

2406

#

2407

# If retry_count is set to a non-zero number then Cloud Scheduler

2408

# will retry failed attempts, using exponential backoff,

2409

# retry_count times, or until the next scheduled execution time,

2410

# whichever comes first.

2411

#

2412

# Values greater than 5 and negative values are not allowed.

2413

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2414

#

2415

# A job's retry interval starts at

2416

# min_backoff_duration, then doubles

2417

# `max_doublings` times, then increases linearly, and finally

2418

# retries at intervals of

2419

# max_backoff_duration up to

2420

# retry_count times.

2421

#

2422

# For example, if min_backoff_duration is

2423

# 10s, max_backoff_duration is 300s, and

2424

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2425

# retry interval will double three times, and then increase linearly by

2426

# 2^3 * 10s. Finally, the job will retry at intervals of

2427

# max_backoff_duration until the job has

2428

# been attempted retry_count times. Thus, the

2429

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2430

#

2431

# The default value of this field is 5.

2432

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2433

# it fails.

2434

#

2435

# The default value of this field is 1 hour.

2436

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2437

# it fails.

2438

#

2439

# The default value of this field is 5 seconds.

2440

},

2441

"state": "A String", # Output only. State of the job.

2442

"name": "A String", # Optionally caller-specified in CreateJob, after

2443

# which it becomes output only.

2444

#

2445

# The job name. For example:

2446

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2447

#

2448

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2449

# hyphens (-), colons (:), or periods (.).

2450

# For more information, see

2451

# [Identifying

2452

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2453

# * `LOCATION_ID` is the canonical ID for the job's location.

2454

# The list of available locations can be obtained by calling

2455

# ListLocations.

2456

# For more information, see https://cloud.google.com/about/locations/.

2457

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2458

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2459

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2460

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2461

# retry of a previously failed attempt or the next execution time

2462

# according to the schedule.

2463

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2464

#

2465

# Describes the schedule on which the job will be executed.

2466

#

2467

# The schedule can be either of the following types:

2468

#

2469

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2470

# * English-like

2471

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2472

#

2473

# As a general rule, execution `n + 1` of a job will not begin

2474

# until execution `n` has finished. Cloud Scheduler will never

2475

# allow two simultaneously outstanding executions. For example,

2476

# this implies that if the `n+1`th execution is scheduled to run at

2477

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2478

# execution will not start until `16:15`.

2479

# A scheduled start time will be delayed if the previous

2480

# execution has not ended when its scheduled time occurs.

2481

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2482

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2483

# the job will be tried a total of retry_count

2484

# times, with exponential backoff, until the next scheduled start

2485

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2486

"userUpdateTime": "A String", # Output only. The creation time of the job.

2487

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2488

# this deadline then the request is cancelled and the attempt is marked as a

2489

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2490

# execution logs. Cloud Scheduler will retry the job according

2491

# to the RetryConfig.

2492

#

2493

# The allowed duration for this deadline is:

2494

# * For HTTP targets, between 15 seconds and 30 minutes.

2495

# * For App Engine HTTP targets, between 15

2496

# seconds and 24 hours.

2497

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2498

# an HTTP request via an http_method such as HTTP

2499

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2500

# response code in the range [200 - 299]. A failure to receive a response

2501

# constitutes a failed execution. For a redirected request, the response

2502

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2503

"httpMethod": "A String", # Which HTTP method to use for the request.

2504

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2505

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2506

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2507

"oauthToken": { # Contains information needed for generating an # If specified, an

2508

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2509

# will be generated and attached as an `Authorization` header in the HTTP

2510

# request.

2511

#

2512

# This type of authorization should generally only be used when calling

2513

# Google APIs hosted on *.googleapis.com.

2514

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2515

# This type of authorization should generally only be used when calling Google

2516

# APIs hosted on *.googleapis.com.

2517

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2518

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2519

# will be used.

2520

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2521

# to be used for generating OAuth token.

2522

# The service account must be within the same project as the job. The caller

2523

# must have iam.serviceAccounts.actAs permission for the service account.

2524

},

2525

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2526

# must begin with either "http://" or "https://". Some examples of

2527

# valid values for uri are:

2528

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2529

# encode some characters for safety and compatibility. The maximum allowed

2530

# URL length is 2083 characters after encoding.

2531

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2532

# HTTP request. This map contains the header field names and

2533

# values. Repeated headers are not supported, but a header value can

2534

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2535

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2536

# headers will be ignored or replaced. A partial list of headers that

2537

# will be ignored or replaced is below:

2538

# - Host: This will be computed by Cloud Scheduler and derived from

2539

# uri.

2540

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2541

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2542

# * `X-Google-*`: Google internal use only.

2543

# * `X-AppEngine-*`: Google internal use only.

2544

#

2545

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2546

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2547

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2548

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2549

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2550

# token will be generated and attached as an `Authorization` header in the

2551

# HTTP request.

2552

#

2553

# This type of authorization can be used for many scenarios, including

2554

# calling Cloud Run, or endpoints where you intend to validate the token

2555

# yourself.

2556

# [OpenID Connect

2557

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2558

# This type of authorization can be used for many scenarios, including

2559

# calling Cloud Run, or endpoints where you intend to validate the token

2560

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2561

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2562

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2563

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2564

# to be used for generating OIDC token.

2565

# The service account must be within the same project as the job. The caller

2566

# must have iam.serviceAccounts.actAs permission for the service account.

2567

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2568

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2569

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2570

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2571

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2572

#

2573

# Pubsub message must contain either non-empty data, or at least one

2574

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2575

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2576

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2577

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2578

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2579

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2580

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2581

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2582

#

2583

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2584

"data": "A String", # The message payload for PubsubMessage.

2585

#

2586

# Pubsub message must contain either non-empty data, or at least one

2587

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2588

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code>

2594

<pre>Pauses a job.

2595

2596

If a job is paused then the system will stop executing the job

2597

until it is re-enabled via ResumeJob. The

2598

state of the job is stored in state; if paused it

2599

will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED

2600

to be paused.

2601

2602

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2603

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2604

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

2605

body: object, The request body.

2606

The object takes the form of:

2607

2608

{ # Request message for PauseJob.

2609

}

2610

2611

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2618

2619

{ # Configuration for a job.

2620

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2621

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2622

# schedule. The value of this field must be a time

2623

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2624

#

2625

# Note that some time zones include a provision for

2626

# daylight savings time. The rules for daylight saving time are

2627

# determined by the chosen tz. For UTC use the string "utc". If a

2628

# time zone is not specified, the default will be in UTC (also known

2629

# as GMT).

2630

"description": "A String", # Optionally caller-specified in CreateJob or

2631

# UpdateJob.

2632

#

2633

# A human-readable description for the job. This string must not contain

2634

# more than 500 characters.

2635

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2636

# of an HTTP request via an http_method such

2637

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2638

# HTTP response code in the range [200 - 299]. Error 503 is

2639

# considered an App Engine system error instead of an application

2640

# error. Requests returning error 503 will be retried regardless of

2641

# retry configuration and not counted against retry counts. Any other

2642

# response code, or a failure to receive a response before the

2643

# deadline, constitutes a failed attempt.

2644

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2645

# permitted.

2646

"body": "A String", # Body.

2647

#

2648

# HTTP request body. A request body is allowed only if the HTTP method is

2649

# POST or PUT. It will result in invalid argument error to set a body on a

2650

# job with an incompatible HttpMethod.

2651

"relativeUri": "A String", # The relative URI.

2652

#

2653

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2654

# It can contain a path, query string arguments, and `#` fragments.

2655

# If the relative URL is empty, then the root path "/" will be used.

2656

# No spaces are allowed, and the maximum length allowed is 2083 characters.

2657

"headers": { # HTTP request headers.

2658

#

2659

# This map contains the header field names and values. Headers can be set

2660

# when the job is created.

2661

#

2662

# Cloud Scheduler sets some headers to default values:

2663

#

2664

# * `User-Agent`: By default, this header is

2665

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2666

# This header can be modified, but Cloud Scheduler will append

2667

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2668

# modified `User-Agent`.

2669

# * `X-CloudScheduler`: This header will be set to true.

2670

#

2671

# If the job has an body, Cloud Scheduler sets

2672

# the following headers:

2673

#

2674

# * `Content-Type`: By default, the `Content-Type` header is set to

2675

# `"application/octet-stream"`. The default can be overridden by explictly

2676

# setting `Content-Type` to a particular media type when the job is

2677

# created.

2678

# For example, `Content-Type` can be set to `"application/json"`.

2679

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2680

# output only. It cannot be changed.

2681

#

2682

# The headers below are output only. They cannot be set or overridden:

2683

#

2684

# * `X-Google-*`: For Google internal use only.

2685

# * `X-AppEngine-*`: For Google internal use only.

2686

#

2687

# In addition, some App Engine headers, which contain

2688

# job-specific information, are also be sent to the job handler.

2689

"a_key": "A String",

2690

},

2691

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2692

#

2693

# For more information about services, versions, and instances see

2694

# [An Overview of App

2695

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2696

# [Microservices Architecture on Google App

2697

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2698

# [App Engine Standard request

2699

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2700

# and [App Engine Flex request

2701

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

2702

"version": "A String", # App version.

2703

#

2704

# By default, the job is sent to the version which is the default

2705

# version when the job is attempted.

2706

"host": "A String", # Output only. The host that the job is sent to.

2707

#

2708

# For more information about how App Engine requests are routed, see

2709

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2710

#

2711

# The host is constructed as:

2712

#

2713

#

2714

# * `host = [application_domain_name]`</br>

2715

# `| [service] + '.' + [application_domain_name]`</br>

2716

# `| [version] + '.' + [application_domain_name]`</br>

2717

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2718

# `| [instance] + '.' + [application_domain_name]`</br>

2719

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2720

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2721

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2722

#

2723

# * `application_domain_name` = The domain name of the app, for

2724

# example <app-id>.appspot.com, which is associated with the

2725

# job's project ID.

2726

#

2727

# * `service =` service

2728

#

2729

# * `version =` version

2730

#

2731

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2736

#

2737

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

2752

# to the service which is the default service when the job is attempted.

2753

#

2754

# If version is empty, then the job will be sent

2755

# to the version which is the default version when the job is attempted.

2756

#

2757

# If instance is empty, then the job will be

2758

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

2763

# to the default version of the default service when the job is attempted.

2764

"service": "A String", # App service.

2765

#

2766

# By default, the job is sent to the service which is the default

2767

# service when the job is attempted.

2768

"instance": "A String", # App instance.

2769

#

2770

# By default, the job is sent to an instance which is available when

2771

# the job is attempted.

2772

#

2773

# Requests can only be sent to a specific instance if

2774

# [manual scaling is used in App Engine

2775

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2776

# App Engine Flex does not support instances. For more information, see

2777

# [App Engine Standard request

2778

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2779

# and [App Engine Flex request

2780

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

2781

},

2782

},

2783

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2784

# different programming environments, including REST APIs and RPC APIs. It is

2785

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2786

# three pieces of data: error code, error message, and error details.

2787

#

2788

# You can find out more about this error model and how to work with it in the

2789

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2790

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2791

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2792

# user-facing error message should be localized and sent in the

2793

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2794

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2795

# message types for APIs to use.

2796

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2797

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2798

},

2799

],

2800

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2801

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2802

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2803

# By default, if a job does not complete successfully (meaning that

2804

# an acknowledgement is not received from the handler, then it will be retried

2805

# with exponential backoff according to the settings in RetryConfig.

2806

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2807

# execution was first attempted. If specified with

2808

# retry_count, the job will be retried until both

2809

# limits are reached.

2810

#

2811

# The default value for max_retry_duration is zero, which means retry

2812

# duration is unlimited.

2813

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2814

# exponential backoff procedure described by

2815

# max_doublings.

2816

#

2817

# The default value of retry_count is zero.

2818

#

2819

# If retry_count is zero, a job attempt will *not* be retried if

2820

# it fails. Instead the Cloud Scheduler system will wait for the

2821

# next scheduled execution time.

2822

#

2823

# If retry_count is set to a non-zero number then Cloud Scheduler

2824

# will retry failed attempts, using exponential backoff,

2825

# retry_count times, or until the next scheduled execution time,

2826

# whichever comes first.

2827

#

2828

# Values greater than 5 and negative values are not allowed.

2829

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2830

#

2831

# A job's retry interval starts at

2832

# min_backoff_duration, then doubles

2833

# `max_doublings` times, then increases linearly, and finally

2834

# retries at intervals of

2835

# max_backoff_duration up to

2836

# retry_count times.

2837

#

2838

# For example, if min_backoff_duration is

2839

# 10s, max_backoff_duration is 300s, and

2840

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2841

# retry interval will double three times, and then increase linearly by

2842

# 2^3 * 10s. Finally, the job will retry at intervals of

2843

# max_backoff_duration until the job has

2844

# been attempted retry_count times. Thus, the

2845

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2846

#

2847

# The default value of this field is 5.

2848

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2849

# it fails.

2850

#

2851

# The default value of this field is 1 hour.

2852

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2853

# it fails.

2854

#

2855

# The default value of this field is 5 seconds.

2856

},

2857

"state": "A String", # Output only. State of the job.

2858

"name": "A String", # Optionally caller-specified in CreateJob, after

2859

# which it becomes output only.

2860

#

2861

# The job name. For example:

2862

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2863

#

2864

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2865

# hyphens (-), colons (:), or periods (.).

2866

# For more information, see

2867

# [Identifying

2868

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2869

# * `LOCATION_ID` is the canonical ID for the job's location.

2870

# The list of available locations can be obtained by calling

2871

# ListLocations.

2872

# For more information, see https://cloud.google.com/about/locations/.

2873

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2874

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2875

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2876

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2877

# retry of a previously failed attempt or the next execution time

2878

# according to the schedule.

2879

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2880

#

2881

# Describes the schedule on which the job will be executed.

2882

#

2883

# The schedule can be either of the following types:

2884

#

2885

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2886

# * English-like

2887

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2888

#

2889

# As a general rule, execution `n + 1` of a job will not begin

2890

# until execution `n` has finished. Cloud Scheduler will never

2891

# allow two simultaneously outstanding executions. For example,

2892

# this implies that if the `n+1`th execution is scheduled to run at

2893

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2894

# execution will not start until `16:15`.

2895

# A scheduled start time will be delayed if the previous

2896

# execution has not ended when its scheduled time occurs.

2897

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2898

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2899

# the job will be tried a total of retry_count

2900

# times, with exponential backoff, until the next scheduled start

2901

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2902

"userUpdateTime": "A String", # Output only. The creation time of the job.

2903

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2904

# this deadline then the request is cancelled and the attempt is marked as a

2905

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2906

# execution logs. Cloud Scheduler will retry the job according

2907

# to the RetryConfig.

2908

#

2909

# The allowed duration for this deadline is:

2910

# * For HTTP targets, between 15 seconds and 30 minutes.

2911

# * For App Engine HTTP targets, between 15

2912

# seconds and 24 hours.

2913

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2914

# an HTTP request via an http_method such as HTTP

2915

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2916

# response code in the range [200 - 299]. A failure to receive a response

2917

# constitutes a failed execution. For a redirected request, the response

2918

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2919

"httpMethod": "A String", # Which HTTP method to use for the request.

2920

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2921

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2922

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2923

"oauthToken": { # Contains information needed for generating an # If specified, an

2924

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2925

# will be generated and attached as an `Authorization` header in the HTTP

2926

# request.

2927

#

2928

# This type of authorization should generally only be used when calling

2929

# Google APIs hosted on *.googleapis.com.

2930

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2931

# This type of authorization should generally only be used when calling Google

2932

# APIs hosted on *.googleapis.com.

2933

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2934

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2935

# will be used.

2936

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2937

# to be used for generating OAuth token.

2938

# The service account must be within the same project as the job. The caller

2939

# must have iam.serviceAccounts.actAs permission for the service account.

2940

},

2941

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2942

# must begin with either "http://" or "https://". Some examples of

2943

# valid values for uri are:

2944

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2945

# encode some characters for safety and compatibility. The maximum allowed

2946

# URL length is 2083 characters after encoding.

2947

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2948

# HTTP request. This map contains the header field names and

2949

# values. Repeated headers are not supported, but a header value can

2950

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2951

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2952

# headers will be ignored or replaced. A partial list of headers that

2953

# will be ignored or replaced is below:

2954

# - Host: This will be computed by Cloud Scheduler and derived from

2955

# uri.

2956

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2957

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2958

# * `X-Google-*`: Google internal use only.

2959

# * `X-AppEngine-*`: Google internal use only.

2960

#

2961

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2962

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2963

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2964

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2965

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2966

# token will be generated and attached as an `Authorization` header in the

2967

# HTTP request.

2968

#

2969

# This type of authorization can be used for many scenarios, including

2970

# calling Cloud Run, or endpoints where you intend to validate the token

2971

# yourself.

2972

# [OpenID Connect

2973

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2974

# This type of authorization can be used for many scenarios, including

2975

# calling Cloud Run, or endpoints where you intend to validate the token

2976

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2977

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2978

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2979

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2980

# to be used for generating OIDC token.

2981

# The service account must be within the same project as the job. The caller

2982

# must have iam.serviceAccounts.actAs permission for the service account.

2983

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2984

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2985

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2986

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2987

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2988

#

2989

# Pubsub message must contain either non-empty data, or at least one

2990

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2991

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2992

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2993

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2994

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2995

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2996

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2997

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2998

#

2999

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3000

"data": "A String", # The message payload for PubsubMessage.

3001

#

3002

# Pubsub message must contain either non-empty data, or at least one

3003

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3004

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>

3010

<pre>Resume a job.

3011

3012

This method reenables a job after it has been Job.State.PAUSED. The

3013

state of a job is stored in Job.state; after calling this method it

3014

will be set to Job.State.ENABLED. A job must be in

3015

Job.State.PAUSED to be resumed.

3016

3017

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3018

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3019

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3020

body: object, The request body.

3021

The object takes the form of:

3022

3023

{ # Request message for ResumeJob.

3024

}

3025

3026

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3033

3034

{ # Configuration for a job.

3035

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3037

# schedule. The value of this field must be a time

3038

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3039

#

3040

# Note that some time zones include a provision for

3041

# daylight savings time. The rules for daylight saving time are

3042

# determined by the chosen tz. For UTC use the string "utc". If a

3043

# time zone is not specified, the default will be in UTC (also known

3044

# as GMT).

3045

"description": "A String", # Optionally caller-specified in CreateJob or

3046

# UpdateJob.

3047

#

3048

# A human-readable description for the job. This string must not contain

3049

# more than 500 characters.

3050

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3051

# of an HTTP request via an http_method such

3052

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3053

# HTTP response code in the range [200 - 299]. Error 503 is

3054

# considered an App Engine system error instead of an application

3055

# error. Requests returning error 503 will be retried regardless of

3056

# retry configuration and not counted against retry counts. Any other

3057

# response code, or a failure to receive a response before the

3058

# deadline, constitutes a failed attempt.

3059

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3060

# permitted.

3061

"body": "A String", # Body.

3062

#

3063

# HTTP request body. A request body is allowed only if the HTTP method is

3064

# POST or PUT. It will result in invalid argument error to set a body on a

3065

# job with an incompatible HttpMethod.

3066

"relativeUri": "A String", # The relative URI.

3067

#

3068

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3069

# It can contain a path, query string arguments, and `#` fragments.

3070

# If the relative URL is empty, then the root path "/" will be used.

3071

# No spaces are allowed, and the maximum length allowed is 2083 characters.

3072

"headers": { # HTTP request headers.

3073

#

3074

# This map contains the header field names and values. Headers can be set

3075

# when the job is created.

3076

#

3077

# Cloud Scheduler sets some headers to default values:

3078

#

3079

# * `User-Agent`: By default, this header is

3080

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3081

# This header can be modified, but Cloud Scheduler will append

3082

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3083

# modified `User-Agent`.

3084

# * `X-CloudScheduler`: This header will be set to true.

3085

#

3086

# If the job has an body, Cloud Scheduler sets

3087

# the following headers:

3088

#

3089

# * `Content-Type`: By default, the `Content-Type` header is set to

3090

# `"application/octet-stream"`. The default can be overridden by explictly

3091

# setting `Content-Type` to a particular media type when the job is

3092

# created.

3093

# For example, `Content-Type` can be set to `"application/json"`.

3094

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3095

# output only. It cannot be changed.

3096

#

3097

# The headers below are output only. They cannot be set or overridden:

3098

#

3099

# * `X-Google-*`: For Google internal use only.

3100

# * `X-AppEngine-*`: For Google internal use only.

3101

#

3102

# In addition, some App Engine headers, which contain

3103

# job-specific information, are also be sent to the job handler.

3104

"a_key": "A String",

3105

},

3106

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3107

#

3108

# For more information about services, versions, and instances see

3109

# [An Overview of App

3110

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3111

# [Microservices Architecture on Google App

3112

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3113

# [App Engine Standard request

3114

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3115

# and [App Engine Flex request

3116

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

3117

"version": "A String", # App version.

3118

#

3119

# By default, the job is sent to the version which is the default

3120

# version when the job is attempted.

3121

"host": "A String", # Output only. The host that the job is sent to.

3122

#

3123

# For more information about how App Engine requests are routed, see

3124

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3125

#

3126

# The host is constructed as:

3127

#

3128

#

3129

# * `host = [application_domain_name]`</br>

3130

# `| [service] + '.' + [application_domain_name]`</br>

3131

# `| [version] + '.' + [application_domain_name]`</br>

3132

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3133

# `| [instance] + '.' + [application_domain_name]`</br>

3134

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3135

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3136

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3137

#

3138

# * `application_domain_name` = The domain name of the app, for

3139

# example <app-id>.appspot.com, which is associated with the

3140

# job's project ID.

3141

#

3142

# * `service =` service

3143

#

3144

# * `version =` version

3145

#

3146

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3151

#

3152

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

3167

# to the service which is the default service when the job is attempted.

3168

#

3169

# If version is empty, then the job will be sent

3170

# to the version which is the default version when the job is attempted.

3171

#

3172

# If instance is empty, then the job will be

3173

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

3178

# to the default version of the default service when the job is attempted.

3179

"service": "A String", # App service.

3180

#

3181

# By default, the job is sent to the service which is the default

3182

# service when the job is attempted.

3183

"instance": "A String", # App instance.

3184

#

3185

# By default, the job is sent to an instance which is available when

3186

# the job is attempted.

3187

#

3188

# Requests can only be sent to a specific instance if

3189

# [manual scaling is used in App Engine

3190

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3191

# App Engine Flex does not support instances. For more information, see

3192

# [App Engine Standard request

3193

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3194

# and [App Engine Flex request

3195

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

3196

},

3197

},

3198

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3199

# different programming environments, including REST APIs and RPC APIs. It is

3200

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3201

# three pieces of data: error code, error message, and error details.

3202

#

3203

# You can find out more about this error model and how to work with it in the

3204

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3205

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3206

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3207

# user-facing error message should be localized and sent in the

3208

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3209

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3210

# message types for APIs to use.

3211

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3212

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3213

},

3214

],

3215

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3216

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3217

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3218

# By default, if a job does not complete successfully (meaning that

3219

# an acknowledgement is not received from the handler, then it will be retried

3220

# with exponential backoff according to the settings in RetryConfig.

3221

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3222

# execution was first attempted. If specified with

3223

# retry_count, the job will be retried until both

3224

# limits are reached.

3225

#

3226

# The default value for max_retry_duration is zero, which means retry

3227

# duration is unlimited.

3228

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3229

# exponential backoff procedure described by

3230

# max_doublings.

3231

#

3232

# The default value of retry_count is zero.

3233

#

3234

# If retry_count is zero, a job attempt will *not* be retried if

3235

# it fails. Instead the Cloud Scheduler system will wait for the

3236

# next scheduled execution time.

3237

#

3238

# If retry_count is set to a non-zero number then Cloud Scheduler

3239

# will retry failed attempts, using exponential backoff,

3240

# retry_count times, or until the next scheduled execution time,

3241

# whichever comes first.

3242

#

3243

# Values greater than 5 and negative values are not allowed.

3244

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3245

#

3246

# A job's retry interval starts at

3247

# min_backoff_duration, then doubles

3248

# `max_doublings` times, then increases linearly, and finally

3249

# retries at intervals of

3250

# max_backoff_duration up to

3251

# retry_count times.

3252

#

3253

# For example, if min_backoff_duration is

3254

# 10s, max_backoff_duration is 300s, and

3255

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3256

# retry interval will double three times, and then increase linearly by

3257

# 2^3 * 10s. Finally, the job will retry at intervals of

3258

# max_backoff_duration until the job has

3259

# been attempted retry_count times. Thus, the

3260

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3261

#

3262

# The default value of this field is 5.

3263

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3264

# it fails.

3265

#

3266

# The default value of this field is 1 hour.

3267

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3268

# it fails.

3269

#

3270

# The default value of this field is 5 seconds.

3271

},

3272

"state": "A String", # Output only. State of the job.

3273

"name": "A String", # Optionally caller-specified in CreateJob, after

3274

# which it becomes output only.

3275

#

3276

# The job name. For example:

3277

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3278

#

3279

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3280

# hyphens (-), colons (:), or periods (.).

3281

# For more information, see

3282

# [Identifying

3283

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3284

# * `LOCATION_ID` is the canonical ID for the job's location.

3285

# The list of available locations can be obtained by calling

3286

# ListLocations.

3287

# For more information, see https://cloud.google.com/about/locations/.

3288

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3289

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3290

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3291

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3292

# retry of a previously failed attempt or the next execution time

3293

# according to the schedule.

3294

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3295

#

3296

# Describes the schedule on which the job will be executed.

3297

#

3298

# The schedule can be either of the following types:

3299

#

3300

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3301

# * English-like

3302

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3303

#

3304

# As a general rule, execution `n + 1` of a job will not begin

3305

# until execution `n` has finished. Cloud Scheduler will never

3306

# allow two simultaneously outstanding executions. For example,

3307

# this implies that if the `n+1`th execution is scheduled to run at

3308

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3309

# execution will not start until `16:15`.

3310

# A scheduled start time will be delayed if the previous

3311

# execution has not ended when its scheduled time occurs.

3312

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3313

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3314

# the job will be tried a total of retry_count

3315

# times, with exponential backoff, until the next scheduled start

3316

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3317

"userUpdateTime": "A String", # Output only. The creation time of the job.

3318

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3319

# this deadline then the request is cancelled and the attempt is marked as a

3320

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3321

# execution logs. Cloud Scheduler will retry the job according

3322

# to the RetryConfig.

3323

#

3324

# The allowed duration for this deadline is:

3325

# * For HTTP targets, between 15 seconds and 30 minutes.

3326

# * For App Engine HTTP targets, between 15

3327

# seconds and 24 hours.

3328

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3329

# an HTTP request via an http_method such as HTTP

3330

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3331

# response code in the range [200 - 299]. A failure to receive a response

3332

# constitutes a failed execution. For a redirected request, the response

3333

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3334

"httpMethod": "A String", # Which HTTP method to use for the request.

3335

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3336

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3337

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3338

"oauthToken": { # Contains information needed for generating an # If specified, an

3339

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3340

# will be generated and attached as an `Authorization` header in the HTTP

3341

# request.

3342

#

3343

# This type of authorization should generally only be used when calling

3344

# Google APIs hosted on *.googleapis.com.

3345

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3346

# This type of authorization should generally only be used when calling Google

3347

# APIs hosted on *.googleapis.com.

3348

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3349

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3350

# will be used.

3351

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3352

# to be used for generating OAuth token.

3353

# The service account must be within the same project as the job. The caller

3354

# must have iam.serviceAccounts.actAs permission for the service account.

3355

},

3356

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3357

# must begin with either "http://" or "https://". Some examples of

3358

# valid values for uri are:

3359

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3360

# encode some characters for safety and compatibility. The maximum allowed

3361

# URL length is 2083 characters after encoding.

3362

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3363

# HTTP request. This map contains the header field names and

3364

# values. Repeated headers are not supported, but a header value can

3365

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3366

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3367

# headers will be ignored or replaced. A partial list of headers that

3368

# will be ignored or replaced is below:

3369

# - Host: This will be computed by Cloud Scheduler and derived from

3370

# uri.

3371

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3372

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3373

# * `X-Google-*`: Google internal use only.

3374

# * `X-AppEngine-*`: Google internal use only.

3375

#

3376

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3377

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3378

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3379

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3380

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3381

# token will be generated and attached as an `Authorization` header in the

3382

# HTTP request.

3383

#

3384

# This type of authorization can be used for many scenarios, including

3385

# calling Cloud Run, or endpoints where you intend to validate the token

3386

# yourself.

3387

# [OpenID Connect

3388

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3389

# This type of authorization can be used for many scenarios, including

3390

# calling Cloud Run, or endpoints where you intend to validate the token

3391

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3392

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3393

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3394

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3395

# to be used for generating OIDC token.

3396

# The service account must be within the same project as the job. The caller

3397

# must have iam.serviceAccounts.actAs permission for the service account.

3398

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3399

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3400

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3401

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3402

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3403

#

3404

# Pubsub message must contain either non-empty data, or at least one

3405

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3406

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3407

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3408

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3409

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3410

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3411

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3412

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3413

#

3414

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3415

"data": "A String", # The message payload for PubsubMessage.

3416

#

3417

# Pubsub message must contain either non-empty data, or at least one

3418

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3419

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="run">run(name, body=None, x__xgafv=None)</code>

3425

<pre>Forces a job to run now.

3426

3427

When this method is called, Cloud Scheduler will dispatch the job, even

3428

if the job is already running.

3429

3430

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3431

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3432

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3433

body: object, The request body.

3434

The object takes the form of:

3435

3436

{ # Request message for forcing a job to run now using

# RunJob.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3447

3448

{ # Configuration for a job.

3449

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3450

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3451

# schedule. The value of this field must be a time

3452

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3453

#

3454

# Note that some time zones include a provision for

3455

# daylight savings time. The rules for daylight saving time are

3456

# determined by the chosen tz. For UTC use the string "utc". If a

3457

# time zone is not specified, the default will be in UTC (also known

3458

# as GMT).

3459

"description": "A String", # Optionally caller-specified in CreateJob or

3460

# UpdateJob.

3461

#

3462

# A human-readable description for the job. This string must not contain

3463

# more than 500 characters.

3464

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3465

# of an HTTP request via an http_method such

3466

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3467

# HTTP response code in the range [200 - 299]. Error 503 is

3468

# considered an App Engine system error instead of an application

3469

# error. Requests returning error 503 will be retried regardless of

3470

# retry configuration and not counted against retry counts. Any other

3471

# response code, or a failure to receive a response before the

3472

# deadline, constitutes a failed attempt.

3473

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3474

# permitted.

3475

"body": "A String", # Body.

3476

#

3477

# HTTP request body. A request body is allowed only if the HTTP method is

3478

# POST or PUT. It will result in invalid argument error to set a body on a

3479

# job with an incompatible HttpMethod.

3480

"relativeUri": "A String", # The relative URI.

3481

#

3482

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3483

# It can contain a path, query string arguments, and `#` fragments.

3484

# If the relative URL is empty, then the root path "/" will be used.

3485

# No spaces are allowed, and the maximum length allowed is 2083 characters.

3486

"headers": { # HTTP request headers.

3487

#

3488

# This map contains the header field names and values. Headers can be set

3489

# when the job is created.

3490

#

3491

# Cloud Scheduler sets some headers to default values:

3492

#

3493

# * `User-Agent`: By default, this header is

3494

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3495

# This header can be modified, but Cloud Scheduler will append

3496

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3497

# modified `User-Agent`.

3498

# * `X-CloudScheduler`: This header will be set to true.

3499

#

3500

# If the job has an body, Cloud Scheduler sets

3501

# the following headers:

3502

#

3503

# * `Content-Type`: By default, the `Content-Type` header is set to

3504

# `"application/octet-stream"`. The default can be overridden by explictly

3505

# setting `Content-Type` to a particular media type when the job is

3506

# created.

3507

# For example, `Content-Type` can be set to `"application/json"`.

3508

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3509

# output only. It cannot be changed.

3510

#

3511

# The headers below are output only. They cannot be set or overridden:

3512

#

3513

# * `X-Google-*`: For Google internal use only.

3514

# * `X-AppEngine-*`: For Google internal use only.

3515

#

3516

# In addition, some App Engine headers, which contain

3517

# job-specific information, are also be sent to the job handler.

3518

"a_key": "A String",

3519

},

3520

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3521

#

3522

# For more information about services, versions, and instances see

3523

# [An Overview of App

3524

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3525

# [Microservices Architecture on Google App

3526

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3527

# [App Engine Standard request

3528

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3529

# and [App Engine Flex request

3530

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

3531

"version": "A String", # App version.

3532

#

3533

# By default, the job is sent to the version which is the default

3534

# version when the job is attempted.

3535

"host": "A String", # Output only. The host that the job is sent to.

3536

#

3537

# For more information about how App Engine requests are routed, see

3538

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3539

#

3540

# The host is constructed as:

3541

#

3542

#

3543

# * `host = [application_domain_name]`</br>

3544

# `| [service] + '.' + [application_domain_name]`</br>

3545

# `| [version] + '.' + [application_domain_name]`</br>

3546

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3547

# `| [instance] + '.' + [application_domain_name]`</br>

3548

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3549

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3550

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3551

#

3552

# * `application_domain_name` = The domain name of the app, for

3553

# example <app-id>.appspot.com, which is associated with the

3554

# job's project ID.

3555

#

3556

# * `service =` service

3557

#

3558

# * `version =` version

3559

#

3560

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3565

#

3566

# * `instance_dot_service =`

# instance `+ '.' +`

# service

#

# * `instance_dot_version =`

# instance `+ '.' +`

# version

#

# * `instance_dot_version_dot_service =`

# instance `+ '.' +`

# version `+ '.' +`

# service

#

#

# If service is empty, then the job will be sent

3581

# to the service which is the default service when the job is attempted.

3582

#

3583

# If version is empty, then the job will be sent

3584

# to the version which is the default version when the job is attempted.

3585

#

3586

# If instance is empty, then the job will be

3587

# sent to an instance which is available when the job is attempted.

#

# If service,

# version, or

# instance is invalid, then the job will be sent

3592

# to the default version of the default service when the job is attempted.

3593

"service": "A String", # App service.

3594

#

3595

# By default, the job is sent to the service which is the default

3596

# service when the job is attempted.

3597

"instance": "A String", # App instance.

3598

#

3599

# By default, the job is sent to an instance which is available when

3600

# the job is attempted.

3601

#

3602

# Requests can only be sent to a specific instance if

3603

# [manual scaling is used in App Engine

3604

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3605

# App Engine Flex does not support instances. For more information, see

3606

# [App Engine Standard request

3607

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3608

# and [App Engine Flex request

3609

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

3610

},

3611

},

3612

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3613

# different programming environments, including REST APIs and RPC APIs. It is

3614

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3615

# three pieces of data: error code, error message, and error details.

3616

#

3617

# You can find out more about this error model and how to work with it in the

3618

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3619

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

3620

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3621

# user-facing error message should be localized and sent in the

3622

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3623

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3624

# message types for APIs to use.

3625

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3626

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3627

},

3628

],

3629

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3631

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3632

# By default, if a job does not complete successfully (meaning that

3633

# an acknowledgement is not received from the handler, then it will be retried

3634

# with exponential backoff according to the settings in RetryConfig.

3635

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3636

# execution was first attempted. If specified with

3637

# retry_count, the job will be retried until both

3638

# limits are reached.

3639

#

3640

# The default value for max_retry_duration is zero, which means retry

3641

# duration is unlimited.

3642

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3643

# exponential backoff procedure described by

3644

# max_doublings.

3645

#

3646

# The default value of retry_count is zero.

3647

#

3648

# If retry_count is zero, a job attempt will *not* be retried if

3649

# it fails. Instead the Cloud Scheduler system will wait for the

3650

# next scheduled execution time.

3651

#

3652

# If retry_count is set to a non-zero number then Cloud Scheduler

3653

# will retry failed attempts, using exponential backoff,

3654

# retry_count times, or until the next scheduled execution time,

3655

# whichever comes first.

3656

#

3657

# Values greater than 5 and negative values are not allowed.

3658

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3659

#

3660

# A job's retry interval starts at

3661

# min_backoff_duration, then doubles

3662

# `max_doublings` times, then increases linearly, and finally

3663

# retries at intervals of

3664

# max_backoff_duration up to

3665

# retry_count times.

3666

#

3667

# For example, if min_backoff_duration is

3668

# 10s, max_backoff_duration is 300s, and

3669

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3670

# retry interval will double three times, and then increase linearly by

3671

# 2^3 * 10s. Finally, the job will retry at intervals of

3672

# max_backoff_duration until the job has

3673

# been attempted retry_count times. Thus, the

3674

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3675

#

3676

# The default value of this field is 5.

3677

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3678

# it fails.

3679

#

3680

# The default value of this field is 1 hour.

3681

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3682

# it fails.

3683

#

3684

# The default value of this field is 5 seconds.

3685

},

3686

"state": "A String", # Output only. State of the job.

3687

"name": "A String", # Optionally caller-specified in CreateJob, after

3688

# which it becomes output only.

3689

#

3690

# The job name. For example:

3691

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3692

#

3693

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3694

# hyphens (-), colons (:), or periods (.).

3695

# For more information, see

3696

# [Identifying

3697

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3698

# * `LOCATION_ID` is the canonical ID for the job's location.

3699

# The list of available locations can be obtained by calling

3700

# ListLocations.

3701

# For more information, see https://cloud.google.com/about/locations/.

3702

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3703

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3704

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3705

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3706

# retry of a previously failed attempt or the next execution time

3707

# according to the schedule.

3708

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3709

#

3710

# Describes the schedule on which the job will be executed.

3711

#

3712

# The schedule can be either of the following types:

3713

#

3714

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3715

# * English-like

3716

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3717

#

3718

# As a general rule, execution `n + 1` of a job will not begin

3719

# until execution `n` has finished. Cloud Scheduler will never

3720

# allow two simultaneously outstanding executions. For example,

3721

# this implies that if the `n+1`th execution is scheduled to run at

3722

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3723

# execution will not start until `16:15`.

3724

# A scheduled start time will be delayed if the previous

3725

# execution has not ended when its scheduled time occurs.

3726

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3727

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3728

# the job will be tried a total of retry_count

3729

# times, with exponential backoff, until the next scheduled start

3730

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

"userUpdateTime": "A String", # Output only. The creation time of the job.

3732

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3733

# this deadline then the request is cancelled and the attempt is marked as a

3734

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3735

# execution logs. Cloud Scheduler will retry the job according

3736

# to the RetryConfig.

3737

#

3738

# The allowed duration for this deadline is:

3739

# * For HTTP targets, between 15 seconds and 30 minutes.

3740

# * For App Engine HTTP targets, between 15

3741

# seconds and 24 hours.

3742

"httpTarget": { # Http target. The job will be pushed to the job handler by means of # HTTP target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3743

# an HTTP request via an http_method such as HTTP

3744

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3745

# response code in the range [200 - 299]. A failure to receive a response

3746

# constitutes a failed execution. For a redirected request, the response

3747

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3748

"httpMethod": "A String", # Which HTTP method to use for the request.

3749

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3750

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3751

# incompatible HttpMethod.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3752

"oauthToken": { # Contains information needed for generating an # If specified, an

3753

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3754

# will be generated and attached as an `Authorization` header in the HTTP

3755

# request.

3756

#

3757

# This type of authorization should generally only be used when calling

3758

# Google APIs hosted on *.googleapis.com.

3759

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3760

# This type of authorization should generally only be used when calling Google

3761

# APIs hosted on *.googleapis.com.

3762

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3763

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3764

# will be used.

3765

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3766

# to be used for generating OAuth token.

3767

# The service account must be within the same project as the job. The caller

3768

# must have iam.serviceAccounts.actAs permission for the service account.

3769

},

3770

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3771

# must begin with either "http://" or "https://". Some examples of

3772

# valid values for uri are:

3773

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3774

# encode some characters for safety and compatibility. The maximum allowed

3775

# URL length is 2083 characters after encoding.

3776

"headers": { # The user can specify HTTP request headers to send with the job's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3777

# HTTP request. This map contains the header field names and

3778

# values. Repeated headers are not supported, but a header value can

3779

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3780

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3781

# headers will be ignored or replaced. A partial list of headers that

3782

# will be ignored or replaced is below:

3783

# - Host: This will be computed by Cloud Scheduler and derived from

3784

# uri.

3785

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3786

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3787

# * `X-Google-*`: Google internal use only.

3788

# * `X-AppEngine-*`: Google internal use only.

3789

#

3790

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3791

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3792

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3793

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3794

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3795

# token will be generated and attached as an `Authorization` header in the

3796

# HTTP request.

3797

#

3798

# This type of authorization can be used for many scenarios, including

3799

# calling Cloud Run, or endpoints where you intend to validate the token

3800

# yourself.

3801

# [OpenID Connect

3802

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3803

# This type of authorization can be used for many scenarios, including

3804

# calling Cloud Run, or endpoints where you intend to validate the token

3805

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3806

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3807

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3808

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3809

# to be used for generating OIDC token.

3810

# The service account must be within the same project as the job. The caller

3811

# must have iam.serviceAccounts.actAs permission for the service account.

3812

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3813

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3814

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3815

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3816

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3817

#

3818

# Pubsub message must contain either non-empty data, or at least one

3819

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3820

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3821

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3822

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3823

# be published when a job is delivered. The topic name must be in the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3824

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3825

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3826

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3827

#

3828

# The topic must be in the same project as the Cloud Scheduler job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3829

"data": "A String", # The message payload for PubsubMessage.

3830

#

3831

# Pubsub message must contain either non-empty data, or at least one

3832

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3833

},

Bu Sun Kim