Blame - docs/dyn/cloudscheduler_v1beta1.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-27 12:20:54 -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.

Bu Sun Kim

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

[diff] [blame]

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

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

141

#

142

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

143

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

144

# job with an incompatible HttpMethod.

145

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

146

#

147

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

148

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

149

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

150

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

151

"headers": { # HTTP request headers.

152

#

153

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

154

# when the job is created.

155

#

156

# Cloud Scheduler sets some headers to default values:

157

#

158

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

159

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

160

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

161

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

162

# modified `User-Agent`.

163

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

164

#

165

# If the job has an body, Cloud Scheduler sets

166

# the following headers:

167

#

168

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

169

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

170

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

171

# created.

172

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

173

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

174

# output only. It cannot be changed.

175

#

176

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

177

#

178

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

179

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

180

#

181

# In addition, some App Engine headers, which contain

182

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

183

"a_key": "A String",

184

},

185

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

186

#

187

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

188

# [An Overview of App

189

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

190

# [Microservices Architecture on Google App

191

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

192

# [App Engine Standard request

193

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

194

# and [App Engine Flex request

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

197

#

198

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

199

# version when the job is attempted.

200

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

201

#

202

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

203

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

204

#

205

# The host is constructed as:

206

#

207

#

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

#

217

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

218

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

219

# job's project ID.

220

#

221

# * `service =` service

222

#

223

# * `version =` version

224

#

225

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

230

#

231

# * `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

246

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

247

#

248

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

249

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

250

#

251

# If instance is empty, then the job will be

252

# 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

257

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

258

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

259

#

260

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

261

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

262

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

263

#

264

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

265

# the job is attempted.

266

#

267

# Requests can only be sent to a specific instance if

268

# [manual scaling is used in App Engine

269

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

270

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

271

# [App Engine Standard request

272

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

273

# and [App Engine Flex request

274

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

Bu Sun Kim

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

[diff] [blame]

275

},

276

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

277

# permitted.

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-27 12:20:54 -0700

[diff] [blame^]

286

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

287

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

288

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

Bu Sun Kim

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

[diff] [blame]

289

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

290

# message types for APIs to use.

291

{

Bu Sun Kim

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

[diff] [blame]

292

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

Bu Sun Kim

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

[diff] [blame]

293

},

294

],

Bu Sun Kim

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

[diff] [blame]

295

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

Bu Sun Kim

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

[diff] [blame]

296

},

Bu Sun Kim

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

[diff] [blame]

297

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

298

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

299

#

300

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

301

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

302

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame]

303

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

304

# execution was first attempted. If specified with

305

# retry_count, the job will be retried until both

306

# limits are reached.

307

#

308

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

309

# duration is unlimited.

310

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

311

# exponential backoff procedure described by

312

# max_doublings.

313

#

314

# The default value of retry_count is zero.

315

#

316

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

317

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

318

# next scheduled execution time.

319

#

320

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

321

# will retry failed attempts, using exponential backoff,

322

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

323

# whichever comes first.

324

#

325

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

326

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

327

#

328

# A job's retry interval starts at

329

# min_backoff_duration, then doubles

330

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

331

# retries at intervals of

332

# max_backoff_duration up to

333

# retry_count times.

334

#

335

# For example, if min_backoff_duration is

336

# 10s, max_backoff_duration is 300s, and

337

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

338

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

339

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

340

# max_backoff_duration until the job has

341

# been attempted retry_count times. Thus, the

342

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

343

#

344

# The default value of this field is 5.

345

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

346

# it fails.

347

#

348

# The default value of this field is 5 seconds.

349

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

350

# it fails.

351

#

352

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

353

},

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

#

407

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

408

# * For App Engine HTTP targets, between 15

409

# seconds and 24 hours.

410

# * For PubSub targets, this field is ignored.

411

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

412

# an HTTP request via an http_method such as HTTP

413

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

414

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

415

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

416

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

417

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

418

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

419

# incompatible HttpMethod.

420

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

Bu Sun Kim

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

[diff] [blame]

421

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

422

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

423

# request.

424

#

425

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

426

# Google APIs hosted on *.googleapis.com.

427

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

428

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

429

# APIs hosted on *.googleapis.com.

Bu Sun Kim

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

[diff] [blame]

430

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

431

# to be used for generating OAuth token.

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

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

435

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

436

# will be used.

Bu Sun Kim

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

[diff] [blame]

437

},

Bu Sun Kim

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

[diff] [blame]

438

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

439

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

440

# valid values for uri are:

441

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

442

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

443

# URL length is 2083 characters after encoding.

444

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

445

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

446

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

447

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

Bu Sun Kim

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

[diff] [blame]

448

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

Bu Sun Kim

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

[diff] [blame]

449

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

450

# will be ignored or replaced is below:

451

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

452

# uri.

453

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

Bu Sun Kim

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

[diff] [blame]

454

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

Bu Sun Kim

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

[diff] [blame]

455

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

456

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

457

#

458

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

Bu Sun Kim

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

[diff] [blame]

459

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

460

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

461

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

462

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

463

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

464

# HTTP request.

465

#

466

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

467

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

468

# yourself.

469

# [OpenID Connect

470

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

471

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

472

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

473

# yourself.

474

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

475

# specified in target will be used.

476

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

477

# to be used for generating OIDC token.

478

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

479

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

480

},

481

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

Bu Sun Kim

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

[diff] [blame]

482

},

Bu Sun Kim

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

[diff] [blame]

483

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

484

# the given Pub/Sub topic.

Bu Sun Kim

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

[diff] [blame]

485

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

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

[diff] [blame]

486

#

487

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

488

# attribute.

Bu Sun Kim

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

[diff] [blame]

489

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

490

},

Bu Sun Kim

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

[diff] [blame]

491

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

492

# 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]

493

# same format as required by PubSub's

Bu Sun Kim

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

[diff] [blame]

494

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

495

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

496

#

497

# 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]

498

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

499

#

500

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

501

# attribute.

Bu Sun Kim

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

[diff] [blame]

502

},

Bu Sun Kim

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

[diff] [blame]

503

}

504

505

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

512

513

{ # Configuration for a job.

514

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

515

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

516

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

517

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

518

#

519

# Note that some time zones include a provision for

520

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

521

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

522

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

523

# as GMT).

524

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

525

# UpdateJob.

526

#

527

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

528

# more than 500 characters.

Bu Sun Kim

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

[diff] [blame]

529

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

530

# of an HTTP request via an http_method such

531

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

532

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

533

# considered an App Engine system error instead of an application

534

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

535

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

536

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

537

# deadline, constitutes a failed attempt.

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

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

Bu Sun Kim

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

[diff] [blame]

673

},

674

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

675

# permitted.

676

},

677

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

678

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

679

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

680

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

681

#

682

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

683

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

684

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

685

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

686

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

Bu Sun Kim

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

[diff] [blame]

687

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

688

# message types for APIs to use.

689

{

Bu Sun Kim

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

[diff] [blame]

690

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

Bu Sun Kim

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

[diff] [blame]

691

},

692

],

Bu Sun Kim

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

[diff] [blame]

693

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

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

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

696

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

697

#

Bu Sun Kim

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

[diff] [blame]

698

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

699

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

700

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame]

701

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

702

# execution was first attempted. If specified with

703

# retry_count, the job will be retried until both

704

# limits are reached.

705

#

706

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

707

# duration is unlimited.

708

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

709

# exponential backoff procedure described by

710

# max_doublings.

711

#

712

# The default value of retry_count is zero.

713

#

714

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

715

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

716

# next scheduled execution time.

717

#

718

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

719

# will retry failed attempts, using exponential backoff,

720

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

721

# whichever comes first.

722

#

723

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

724

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

725

#

726

# A job's retry interval starts at

727

# min_backoff_duration, then doubles

728

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

729

# retries at intervals of

730

# max_backoff_duration up to

731

# retry_count times.

732

#

733

# For example, if min_backoff_duration is

734

# 10s, max_backoff_duration is 300s, and

735

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

736

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

737

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

738

# max_backoff_duration until the job has

739

# been attempted retry_count times. Thus, the

740

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

741

#

742

# The default value of this field is 5.

743

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

744

# it fails.

745

#

746

# The default value of this field is 5 seconds.

747

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

748

# it fails.

749

#

750

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

751

},

752

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

753

# which it becomes output only.

754

#

755

# The job name. For example:

756

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

757

#

758

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

759

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

760

# For more information, see

761

# [Identifying

762

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

763

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

764

# The list of available locations can be obtained by calling

765

# ListLocations.

766

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

767

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

768

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

769

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

770

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

771

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

772

# according to the schedule.

773

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

Bu Sun Kim

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

[diff] [blame]

774

#

775

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

776

#

777

# The schedule can be either of the following types:

778

#

779

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

780

# * English-like

781

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

782

#

783

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

784

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

785

# allow two simultaneously outstanding executions. For example,

786

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

787

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

788

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

789

# A scheduled start time will be delayed if the previous

790

# execution has not ended when its scheduled time occurs.

791

#

Dan O'Meara

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

[diff] [blame]

792

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

793

# the job will be tried a total of retry_count

794

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

795

# time.

Bu Sun Kim

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

[diff] [blame]

796

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

797

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

798

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

799

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

800

# execution logs. Cloud Scheduler will retry the job according

801

# to the RetryConfig.

802

#

803

# The allowed duration for this deadline is:

804

#

805

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

806

# * For App Engine HTTP targets, between 15

807

# seconds and 24 hours.

808

# * For PubSub targets, this field is ignored.

809

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

810

# an HTTP request via an http_method such as HTTP

811

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

812

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

813

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

814

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

815

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

816

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

817

# incompatible HttpMethod.

818

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

Bu Sun Kim

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

[diff] [blame]

819

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

820

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

821

# request.

822

#

823

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

824

# Google APIs hosted on *.googleapis.com.

825

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

826

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

827

# APIs hosted on *.googleapis.com.

Bu Sun Kim

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

[diff] [blame]

828

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

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.

Bu Sun Kim

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

[diff] [blame]

832

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

833

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

834

# will be used.

Bu Sun Kim

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

[diff] [blame]

835

},

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

# valid values for uri are:

839

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

840

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

841

# URL length is 2083 characters after encoding.

842

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

843

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

844

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

845

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

Bu Sun Kim

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

[diff] [blame]

846

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

Bu Sun Kim

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

[diff] [blame]

847

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

848

# will be ignored or replaced is below:

849

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

850

# uri.

851

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

Bu Sun Kim

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

[diff] [blame]

852

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

Bu Sun Kim

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

[diff] [blame]

853

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

854

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

855

#

856

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

Bu Sun Kim

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

[diff] [blame]

857

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

858

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

859

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

860

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

861

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

862

# HTTP request.

863

#

864

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

865

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

866

# yourself.

867

# [OpenID Connect

868

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

869

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

870

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

871

# yourself.

872

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

873

# specified in target will be used.

874

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

875

# to be used for generating OIDC token.

876

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

877

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

878

},

879

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

Bu Sun Kim

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

[diff] [blame]

880

},

Bu Sun Kim

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

[diff] [blame]

881

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

882

# the given Pub/Sub topic.

Bu Sun Kim

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

[diff] [blame]

883

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

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

[diff] [blame]

884

#

885

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

886

# attribute.

Bu Sun Kim

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

[diff] [blame]

887

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

888

},

Bu Sun Kim

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

[diff] [blame]

889

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

890

# 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]

891

# same format as required by PubSub's

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

#

895

# 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]

896

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

897

#

898

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

899

# attribute.

Bu Sun Kim

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

[diff] [blame]

900

},

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>

906

<pre>Deletes a job.

907

908

Args:

Dan O'Meara

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

[diff] [blame]

909

Bu Sun Kim

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

[diff] [blame]

910

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

911

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

918

919

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

920

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

921

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

922

#

923

# service Foo {

924

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

925

# }

926

#

927

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

}</pre>

</div>

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

933

<pre>Gets a job.

934

935

Args:

Dan O'Meara

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

[diff] [blame]

936

Bu Sun Kim

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

[diff] [blame]

937

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

938

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

945

946

{ # Configuration for a job.

947

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

948

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

949

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

950

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

951

#

952

# Note that some time zones include a provision for

953

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

954

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

955

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

956

# as GMT).

957

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

958

# UpdateJob.

959

#

960

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

961

# more than 500 characters.

Bu Sun Kim

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

[diff] [blame]

962

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

963

# of an HTTP request via an http_method such

964

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

965

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

966

# considered an App Engine system error instead of an application

967

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

968

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

969

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

970

# deadline, constitutes a failed attempt.

971

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

972

#

973

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

974

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

975

# job with an incompatible HttpMethod.

976

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

977

#

978

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

979

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

980

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

981

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

982

"headers": { # HTTP request headers.

983

#

984

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

985

# when the job is created.

986

#

987

# Cloud Scheduler sets some headers to default values:

988

#

989

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

990

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

991

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

992

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

993

# modified `User-Agent`.

994

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

995

#

996

# If the job has an body, Cloud Scheduler sets

997

# the following headers:

998

#

999

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

1000

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

1001

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

1002

# created.

1003

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

1004

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

1005

# output only. It cannot be changed.

1006

#

1007

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

1008

#

1009

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

1010

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

1011

#

1012

# In addition, some App Engine headers, which contain

1013

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

1014

"a_key": "A String",

1015

},

1016

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

1017

#

1018

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

1019

# [An Overview of App

1020

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

1021

# [Microservices Architecture on Google App

1022

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

1023

# [App Engine Standard request

1024

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

1025

# and [App Engine Flex request

1026

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

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

#

1029

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

1030

# version when the job is attempted.

1031

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

1032

#

1033

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

1034

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

1035

#

1036

# The host is constructed as:

1037

#

1038

#

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

#

1048

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

1049

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

1050

# job's project ID.

1051

#

1052

# * `service =` service

1053

#

1054

# * `version =` version

1055

#

1056

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1061

#

1062

# * `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

1077

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

1078

#

1079

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

1080

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

1081

#

1082

# If instance is empty, then the job will be

1083

# 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

1088

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

1089

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

1090

#

1091

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

1092

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1093

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

1094

#

1095

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

1096

# the job is attempted.

1097

#

1098

# Requests can only be sent to a specific instance if

1099

# [manual scaling is used in App Engine

1100

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

1101

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

1102

# [App Engine Standard request

1103

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

1104

# and [App Engine Flex request

1105

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

Bu Sun Kim

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

[diff] [blame]

1106

},

1107

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

1108

# permitted.

1109

},

1110

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

1111

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

1112

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

1113

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

1114

#

1115

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

1116

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1117

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

1118

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

1119

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

Bu Sun Kim

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

[diff] [blame]

1120

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

1121

# message types for APIs to use.

1122

{

Bu Sun Kim

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

[diff] [blame]

1123

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

Bu Sun Kim

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

[diff] [blame]

1124

},

1125

],

Bu Sun Kim

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

[diff] [blame]

1126

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

Bu Sun Kim

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

[diff] [blame]

1127

},

Bu Sun Kim

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

[diff] [blame]

1128

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

1129

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

1130

#

Bu Sun Kim

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

[diff] [blame]

1131

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

1132

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

1133

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame]

1134

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

1135

# execution was first attempted. If specified with

1136

# retry_count, the job will be retried until both

1137

# limits are reached.

1138

#

1139

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

1140

# duration is unlimited.

1141

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

1142

# exponential backoff procedure described by

1143

# max_doublings.

1144

#

1145

# The default value of retry_count is zero.

1146

#

1147

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

1148

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

1149

# next scheduled execution time.

1150

#

1151

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

1152

# will retry failed attempts, using exponential backoff,

1153

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

1154

# whichever comes first.

1155

#

1156

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1157

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

1158

#

1159

# A job's retry interval starts at

1160

# min_backoff_duration, then doubles

1161

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

1162

# retries at intervals of

1163

# max_backoff_duration up to

1164

# retry_count times.

1165

#

1166

# For example, if min_backoff_duration is

1167

# 10s, max_backoff_duration is 300s, and

1168

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

1169

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

1170

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

1171

# max_backoff_duration until the job has

1172

# been attempted retry_count times. Thus, the

1173

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

1174

#

1175

# The default value of this field is 5.

1176

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

1177

# it fails.

1178

#

1179

# The default value of this field is 5 seconds.

1180

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

1181

# it fails.

1182

#

1183

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

1184

},

1185

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

1186

# which it becomes output only.

1187

#

1188

# The job name. For example:

1189

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

1190

#

1191

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

1192

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

1193

# For more information, see

1194

# [Identifying

1195

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

1196

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

1197

# The list of available locations can be obtained by calling

1198

# ListLocations.

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

# according to the schedule.

1206

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

Bu Sun Kim

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

[diff] [blame]

1207

#

1208

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

1209

#

1210

# The schedule can be either of the following types:

1211

#

1212

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

1213

# * English-like

1214

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

1215

#

1216

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

1217

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

1218

# allow two simultaneously outstanding executions. For example,

1219

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

1220

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

1221

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

1222

# A scheduled start time will be delayed if the previous

1223

# execution has not ended when its scheduled time occurs.

1224

#

Dan O'Meara

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

[diff] [blame]

1225

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

1226

# the job will be tried a total of retry_count

1227

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

1228

# time.

Bu Sun Kim

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

[diff] [blame]

1229

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

1230

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

1231

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

1232

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

1233

# execution logs. Cloud Scheduler will retry the job according

1234

# to the RetryConfig.

1235

#

1236

# The allowed duration for this deadline is:

1237

#

1238

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

1239

# * For App Engine HTTP targets, between 15

1240

# seconds and 24 hours.

1241

# * For PubSub targets, this field is ignored.

1242

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

1243

# an HTTP request via an http_method such as HTTP

1244

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

1245

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

1246

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

1247

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

1248

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

1249

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

1250

# incompatible HttpMethod.

1251

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

Bu Sun Kim

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

[diff] [blame]

1252

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

1253

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

1254

# request.

1255

#

1256

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

1257

# Google APIs hosted on *.googleapis.com.

1258

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

1259

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

1260

# APIs hosted on *.googleapis.com.

Bu Sun Kim

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

[diff] [blame]

1261

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

1262

# to be used for generating OAuth token.

1263

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

1264

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

Bu Sun Kim

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

[diff] [blame]

1265

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

1266

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

1267

# will be used.

Bu Sun Kim

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

[diff] [blame]

1268

},

Bu Sun Kim

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

[diff] [blame]

1269

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

1270

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

1271

# valid values for uri are:

1272

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

1273

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

1274

# URL length is 2083 characters after encoding.

1275

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

1276

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

1277

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

1278

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

Bu Sun Kim

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

[diff] [blame]

1279

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

Bu Sun Kim

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

[diff] [blame]

1280

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

1281

# will be ignored or replaced is below:

1282

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

1283

# uri.

1284

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

Bu Sun Kim

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

[diff] [blame]

1285

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

Bu Sun Kim

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

[diff] [blame]

1286

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

1287

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

1288

#

1289

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

Bu Sun Kim

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

[diff] [blame]

1290

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1291

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1292

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

1293

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

1294

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

1295

# HTTP request.

1296

#

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.

1300

# [OpenID Connect

1301

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

1302

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

1303

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

1304

# yourself.

1305

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

1306

# specified in target will be used.

1307

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

1308

# to be used for generating OIDC token.

1309

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

1310

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

1311

},

1312

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

Bu Sun Kim

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

[diff] [blame]

1313

},

Bu Sun Kim

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

[diff] [blame]

1314

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

1315

# the given Pub/Sub topic.

Bu Sun Kim

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

[diff] [blame]

1316

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

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

[diff] [blame]

1317

#

1318

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

1319

# attribute.

Bu Sun Kim

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

[diff] [blame]

1320

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1321

},

Bu Sun Kim

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

[diff] [blame]

1322

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

1323

# 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]

1324

# same format as required by PubSub's

Bu Sun Kim

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

[diff] [blame]

1325

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

1326

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

1327

#

1328

# 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]

1329

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

1330

#

1331

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

1332

# attribute.

Bu Sun Kim

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

[diff] [blame]

1333

},

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]

1338

<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]

1339

<pre>Lists jobs.

1340

1341

Args:

Dan O'Meara

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

[diff] [blame]

1342

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

Bu Sun Kim

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

[diff] [blame]

1343

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

Bu Sun Kim

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

[diff] [blame]

1344

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

1345

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

1346

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

1347

next_page_token returned from

1348

the previous call to ListJobs. It is an error to

1349

switch the value of filter or

1350

order_by while iterating through pages.

Dan O'Meara

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

[diff] [blame]

1351

pageSize: integer, Requested page size.

1352

1353

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

1354

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

1355

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

1356

jobs exist.

Bu Sun Kim

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

[diff] [blame]

1357

x__xgafv: string, V1 error format.

1358

Allowed values

1359

1 - v1 error format

1360

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

1361

1362

Returns:

1363

An object of the form:

1364

1365

{ # Response message for listing jobs using ListJobs.

Bu Sun Kim

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

[diff] [blame]

1366

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the

Bu Sun Kim

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

[diff] [blame]

1367

# page_token field in the subsequent call to

1368

# ListJobs to retrieve the next page of results.

1369

# If this is empty it indicates that there are no more results

1370

# through which to paginate.

1371

#

1372

# The page token is valid for only 2 hours.

Bu Sun Kim

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

[diff] [blame]

1373

"jobs": [ # The list of jobs.

Bu Sun Kim

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

[diff] [blame]

1374

{ # Configuration for a job.

1375

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1376

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

1377

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

1378

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

1379

#

1380

# Note that some time zones include a provision for

1381

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

1382

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

1383

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

1384

# as GMT).

1385

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

1386

# UpdateJob.

1387

#

1388

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

1389

# more than 500 characters.

Bu Sun Kim

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

[diff] [blame]

1390

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

1391

# of an HTTP request via an http_method such

1392

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

1393

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

1394

# considered an App Engine system error instead of an application

1395

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

1396

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

1397

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

1398

# deadline, constitutes a failed attempt.

1399

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

1400

#

1401

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

1402

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

1403

# job with an incompatible HttpMethod.

1404

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

1405

#

1406

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

1407

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

1408

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

1409

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

1410

"headers": { # HTTP request headers.

1411

#

1412

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

1413

# when the job is created.

1414

#

1415

# Cloud Scheduler sets some headers to default values:

1416

#

1417

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

1418

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

1419

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

1420

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

1421

# modified `User-Agent`.

1422

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

1423

#

1424

# If the job has an body, Cloud Scheduler sets

1425

# the following headers:

1426

#

1427

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

1428

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

1429

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

1430

# created.

1431

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

1432

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

1433

# output only. It cannot be changed.

1434

#

1435

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

1436

#

1437

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

1438

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

1439

#

1440

# In addition, some App Engine headers, which contain

1441

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

1442

"a_key": "A String",

1443

},

1444

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

1445

#

1446

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

1447

# [An Overview of App

1448

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

1449

# [Microservices Architecture on Google App

1450

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

1451

# [App Engine Standard request

1452

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

1453

# and [App Engine Flex request

1454

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

Bu Sun Kim

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

[diff] [blame]

1455

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

1456

#

1457

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

1458

# version when the job is attempted.

1459

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

1460

#

1461

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

1462

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

1463

#

1464

# The host is constructed as:

1465

#

1466

#

1467

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

1468

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

1469

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

1470

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

1471

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

1472

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

1473

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

1474

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

1475

#

1476

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

1477

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

1478

# job's project ID.

1479

#

1480

# * `service =` service

1481

#

1482

# * `version =` version

1483

#

1484

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1489

#

1490

# * `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

1505

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

1506

#

1507

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

1508

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

1509

#

1510

# If instance is empty, then the job will be

1511

# 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

1516

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

1517

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

1518

#

1519

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

1520

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1521

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

1522

#

1523

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

1524

# the job is attempted.

1525

#

1526

# Requests can only be sent to a specific instance if

1527

# [manual scaling is used in App Engine

1528

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

1529

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

1530

# [App Engine Standard request

1531

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

1532

# and [App Engine Flex request

1533

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

Bu Sun Kim

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

[diff] [blame]

1534

},

1535

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

1536

# permitted.

1537

},

1538

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

1539

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

1540

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

1541

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

1542

#

1543

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

1544

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1545

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

1546

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

1547

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

Bu Sun Kim

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

[diff] [blame]

1548

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

1549

# message types for APIs to use.

1550

{

Bu Sun Kim

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

[diff] [blame]

1551

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

Bu Sun Kim

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

[diff] [blame]

1552

},

1553

],

Bu Sun Kim

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

[diff] [blame]

1554

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

Bu Sun Kim

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

[diff] [blame]

1555

},

Bu Sun Kim

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

[diff] [blame]

1556

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

1557

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

1558

#

Bu Sun Kim

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

[diff] [blame]

1559

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

1560

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

1561

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame]

1562

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

1563

# execution was first attempted. If specified with

1564

# retry_count, the job will be retried until both

1565

# limits are reached.

1566

#

1567

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

1568

# duration is unlimited.

1569

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

1570

# exponential backoff procedure described by

1571

# max_doublings.

1572

#

1573

# The default value of retry_count is zero.

1574

#

1575

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

1576

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

1577

# next scheduled execution time.

1578

#

1579

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

1580

# will retry failed attempts, using exponential backoff,

1581

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

1582

# whichever comes first.

1583

#

1584

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1585

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

1586

#

1587

# A job's retry interval starts at

1588

# min_backoff_duration, then doubles

1589

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

1590

# retries at intervals of

1591

# max_backoff_duration up to

1592

# retry_count times.

1593

#

1594

# For example, if min_backoff_duration is

1595

# 10s, max_backoff_duration is 300s, and

1596

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

1597

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

1598

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

1599

# max_backoff_duration until the job has

1600

# been attempted retry_count times. Thus, the

1601

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

1602

#

1603

# The default value of this field is 5.

1604

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

1605

# it fails.

1606

#

1607

# The default value of this field is 5 seconds.

1608

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

1609

# it fails.

1610

#

1611

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

1612

},

1613

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

1614

# which it becomes output only.

1615

#

1616

# The job name. For example:

1617

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

1618

#

1619

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

1620

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

1621

# For more information, see

1622

# [Identifying

1623

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

1624

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

1625

# The list of available locations can be obtained by calling

1626

# ListLocations.

1627

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

1628

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

1629

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

1630

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

1631

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

1632

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

1633

# according to the schedule.

1634

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

Bu Sun Kim

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

[diff] [blame]

1635

#

1636

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

1637

#

1638

# The schedule can be either of the following types:

1639

#

1640

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

1641

# * English-like

1642

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

1643

#

1644

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

1645

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

1646

# allow two simultaneously outstanding executions. For example,

1647

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

1648

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

1649

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

1650

# A scheduled start time will be delayed if the previous

1651

# execution has not ended when its scheduled time occurs.

1652

#

Dan O'Meara

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

[diff] [blame]

1653

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

1654

# the job will be tried a total of retry_count

1655

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

1656

# time.

Bu Sun Kim

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

[diff] [blame]

1657

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

1658

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

1659

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

1660

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

1661

# execution logs. Cloud Scheduler will retry the job according

1662

# to the RetryConfig.

1663

#

1664

# The allowed duration for this deadline is:

1665

#

1666

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

1667

# * For App Engine HTTP targets, between 15

1668

# seconds and 24 hours.

1669

# * For PubSub targets, this field is ignored.

1670

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

1671

# an HTTP request via an http_method such as HTTP

1672

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

1673

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

1674

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

1675

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

1676

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

1677

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

1678

# incompatible HttpMethod.

1679

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

Bu Sun Kim

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

[diff] [blame]

1680

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

1681

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

1682

# request.

1683

#

1684

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

1685

# Google APIs hosted on *.googleapis.com.

1686

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

1687

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

1688

# APIs hosted on *.googleapis.com.

Bu Sun Kim

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

[diff] [blame]

1689

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

1690

# to be used for generating OAuth token.

1691

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

1692

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

Bu Sun Kim

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

[diff] [blame]

1693

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

1694

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

1695

# will be used.

Bu Sun Kim

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

[diff] [blame]

1696

},

Bu Sun Kim

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

[diff] [blame]

1697

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

1698

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

1699

# valid values for uri are:

1700

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

1701

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

1702

# URL length is 2083 characters after encoding.

1703

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

1704

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

1705

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

1706

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

Bu Sun Kim

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

[diff] [blame]

1707

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

Bu Sun Kim

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

[diff] [blame]

1708

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

1709

# will be ignored or replaced is below:

1710

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

1711

# uri.

1712

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

Bu Sun Kim

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

[diff] [blame]

1713

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

Bu Sun Kim

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

[diff] [blame]

1714

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

1715

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

1716

#

1717

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

Bu Sun Kim

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

[diff] [blame]

1718

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1719

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1720

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

1721

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

1722

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

1723

# HTTP request.

1724

#

1725

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

1726

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

1727

# yourself.

1728

# [OpenID Connect

1729

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

1730

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

1731

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

1732

# yourself.

1733

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

1734

# specified in target will be used.

1735

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

1736

# to be used for generating OIDC token.

1737

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

1738

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

1739

},

1740

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

Bu Sun Kim

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

[diff] [blame]

1741

},

Bu Sun Kim

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

[diff] [blame]

1742

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

1743

# the given Pub/Sub topic.

Bu Sun Kim

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

[diff] [blame]

1744

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

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

[diff] [blame]

1745

#

1746

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

1747

# attribute.

Bu Sun Kim

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

[diff] [blame]

1748

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1749

},

Bu Sun Kim

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

[diff] [blame]

1750

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

1751

# 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]

1752

# same format as required by PubSub's

Bu Sun Kim

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

[diff] [blame]

1753

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

1754

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

1755

#

1756

# 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]

1757

"data": "A String", # The message payload for PubsubMessage.

1758

#

1759

# Pubsub message must contain either non-empty data, or at least one

1760

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1761

},

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>

1769

<pre>Retrieves the next page of results.

1770

1771

Args:

1772

previous_request: The request for the previous page. (required)

1773

previous_response: The response from the request for the previous page. (required)

1774

1775

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1776

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]

1777

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]

1782

<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]

1783

<pre>Updates a job.

1784

1785

If successful, the updated Job is returned. If the job does

1786

not exist, `NOT_FOUND` is returned.

1787

1788

If UpdateJob does not successfully return, it is possible for the

1789

job to be in an Job.State.UPDATE_FAILED state. A job in this state may

1790

not be executed. If this happens, retry the UpdateJob request

1791

until a successful response is received.

Args:

which it becomes output only.

1796

1797

The job name. For example:

1798

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1799

1800

* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1801

hyphens (-), colons (:), or periods (.).

1802

For more information, see

1803

[Identifying

1804

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]

1805

* `LOCATION_ID` is the canonical ID for the job's location.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1806

The list of available locations can be obtained by calling

1807

ListLocations.

1808

For more information, see https://cloud.google.com/about/locations/.

1809

* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1810

hyphens (-), or underscores (_). The maximum length is 500 characters. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1811

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1812

The object takes the form of:

1813

1814

{ # Configuration for a job.

1815

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1816

"timeZone": "A String", # Specifies the time zone to be used in interpreting

1817

# schedule. The value of this field must be a time

1818

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

1819

#

1820

# Note that some time zones include a provision for

1821

# daylight savings time. The rules for daylight saving time are

1822

# determined by the chosen tz. For UTC use the string "utc". If a

1823

# time zone is not specified, the default will be in UTC (also known

1824

# as GMT).

1825

"description": "A String", # Optionally caller-specified in CreateJob or

1826

# UpdateJob.

1827

#

1828

# A human-readable description for the job. This string must not contain

1829

# more than 500 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1830

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

1831

# of an HTTP request via an http_method such

1832

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

1833

# HTTP response code in the range [200 - 299]. Error 503 is

1834

# considered an App Engine system error instead of an application

1835

# error. Requests returning error 503 will be retried regardless of

1836

# retry configuration and not counted against retry counts. Any other

1837

# response code, or a failure to receive a response before the

1838

# deadline, constitutes a failed attempt.

1839

"body": "A String", # Body.

1840

#

1841

# HTTP request body. A request body is allowed only if the HTTP method is

1842

# POST or PUT. It will result in invalid argument error to set a body on a

1843

# job with an incompatible HttpMethod.

1844

"relativeUri": "A String", # The relative URI.

1845

#

1846

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

1847

# It can contain a path, query string arguments, and `#` fragments.

1848

# If the relative URL is empty, then the root path "/" will be used.

1849

# No spaces are allowed, and the maximum length allowed is 2083 characters.

1850

"headers": { # HTTP request headers.

1851

#

1852

# This map contains the header field names and values. Headers can be set

1853

# when the job is created.

1854

#

1855

# Cloud Scheduler sets some headers to default values:

1856

#

1857

# * `User-Agent`: By default, this header is

1858

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

1859

# This header can be modified, but Cloud Scheduler will append

1860

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

1861

# modified `User-Agent`.

1862

# * `X-CloudScheduler`: This header will be set to true.

1863

#

1864

# If the job has an body, Cloud Scheduler sets

1865

# the following headers:

1866

#

1867

# * `Content-Type`: By default, the `Content-Type` header is set to

1868

# `"application/octet-stream"`. The default can be overridden by explictly

1869

# setting `Content-Type` to a particular media type when the job is

1870

# created.

1871

# For example, `Content-Type` can be set to `"application/json"`.

1872

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

1873

# output only. It cannot be changed.

1874

#

1875

# The headers below are output only. They cannot be set or overridden:

1876

#

1877

# * `X-Google-*`: For Google internal use only.

1878

# * `X-AppEngine-*`: For Google internal use only.

1879

#

1880

# In addition, some App Engine headers, which contain

1881

# job-specific information, are also be sent to the job handler.

1882

"a_key": "A String",

1883

},

1884

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

1885

#

1886

# For more information about services, versions, and instances see

1887

# [An Overview of App

1888

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

1889

# [Microservices Architecture on Google App

1890

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

1891

# [App Engine Standard request

1892

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

1893

# and [App Engine Flex request

1894

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1895

"version": "A String", # App version.

1896

#

1897

# By default, the job is sent to the version which is the default

1898

# version when the job is attempted.

1899

"host": "A String", # Output only. The host that the job is sent to.

1900

#

1901

# For more information about how App Engine requests are routed, see

1902

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1903

#

1904

# The host is constructed as:

1905

#

1906

#

1907

# * `host = [application_domain_name]`</br>

1908

# `| [service] + '.' + [application_domain_name]`</br>

1909

# `| [version] + '.' + [application_domain_name]`</br>

1910

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1911

# `| [instance] + '.' + [application_domain_name]`</br>

1912

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1913

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1914

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1915

#

1916

# * `application_domain_name` = The domain name of the app, for

1917

# example <app-id>.appspot.com, which is associated with the

1918

# job's project ID.

1919

#

1920

# * `service =` service

1921

#

1922

# * `version =` version

1923

#

1924

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1929

#

1930

# * `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

1945

# to the service which is the default service when the job is attempted.

1946

#

1947

# If version is empty, then the job will be sent

1948

# to the version which is the default version when the job is attempted.

1949

#

1950

# If instance is empty, then the job will be

1951

# 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

1956

# to the default version of the default service when the job is attempted.

1957

"service": "A String", # App service.

1958

#

1959

# By default, the job is sent to the service which is the default

1960

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1961

"instance": "A String", # App instance.

1962

#

1963

# By default, the job is sent to an instance which is available when

1964

# the job is attempted.

1965

#

1966

# Requests can only be sent to a specific instance if

1967

# [manual scaling is used in App Engine

1968

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

1969

# App Engine Flex does not support instances. For more information, see

1970

# [App Engine Standard request

1971

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

1972

# and [App Engine Flex request

1973

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1974

},

1975

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

1976

# permitted.

1977

},

1978

"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]

1979

# different programming environments, including REST APIs and RPC APIs. It is

1980

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1981

# three pieces of data: error code, error message, and error details.

1982

#

1983

# You can find out more about this error model and how to work with it in the

1984

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1985

"message": "A String", # A developer-facing error message, which should be in English. Any

1986

# user-facing error message should be localized and sent in the

1987

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

"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]

1989

# message types for APIs to use.

1990

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1991

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1992

},

1993

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1994

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1995

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1996

"state": "A String", # Output only. State of the job.

1997

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

1998

#

1999

# By default, if a job does not complete successfully (meaning that

2000

# an acknowledgement is not received from the handler, then it will be retried

2001

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2002

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2003

# execution was first attempted. If specified with

2004

# retry_count, the job will be retried until both

2005

# limits are reached.

2006

#

2007

# The default value for max_retry_duration is zero, which means retry

2008

# duration is unlimited.

2009

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2010

# exponential backoff procedure described by

2011

# max_doublings.

2012

#

2013

# The default value of retry_count is zero.

2014

#

2015

# If retry_count is zero, a job attempt will *not* be retried if

2016

# it fails. Instead the Cloud Scheduler system will wait for the

2017

# next scheduled execution time.

2018

#

2019

# If retry_count is set to a non-zero number then Cloud Scheduler

2020

# will retry failed attempts, using exponential backoff,

2021

# retry_count times, or until the next scheduled execution time,

2022

# whichever comes first.

2023

#

2024

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2025

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2026

#

2027

# A job's retry interval starts at

2028

# min_backoff_duration, then doubles

2029

# `max_doublings` times, then increases linearly, and finally

2030

# retries at intervals of

2031

# max_backoff_duration up to

2032

# retry_count times.

2033

#

2034

# For example, if min_backoff_duration is

2035

# 10s, max_backoff_duration is 300s, and

2036

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2037

# retry interval will double three times, and then increase linearly by

2038

# 2^3 * 10s. Finally, the job will retry at intervals of

2039

# max_backoff_duration until the job has

2040

# been attempted retry_count times. Thus, the

2041

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2042

#

2043

# The default value of this field is 5.

2044

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2045

# it fails.

2046

#

2047

# The default value of this field is 5 seconds.

2048

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2049

# it fails.

2050

#

2051

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

},

2053

"name": "A String", # Optionally caller-specified in CreateJob, after

2054

# which it becomes output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2055

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2056

# The job name. For example:

2057

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2058

#

2059

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2060

# hyphens (-), colons (:), or periods (.).

2061

# For more information, see

2062

# [Identifying

2063

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2064

# * `LOCATION_ID` is the canonical ID for the job's location.

2065

# The list of available locations can be obtained by calling

2066

# ListLocations.

2067

# For more information, see https://cloud.google.com/about/locations/.

2068

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2069

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2070

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2071

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2072

# retry of a previously failed attempt or the next execution time

2073

# according to the schedule.

2074

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2075

#

2076

# Describes the schedule on which the job will be executed.

2077

#

2078

# The schedule can be either of the following types:

2079

#

2080

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2081

# * English-like

2082

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2083

#

2084

# As a general rule, execution `n + 1` of a job will not begin

2085

# until execution `n` has finished. Cloud Scheduler will never

2086

# allow two simultaneously outstanding executions. For example,

2087

# this implies that if the `n+1`th execution is scheduled to run at

2088

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2089

# execution will not start until `16:15`.

2090

# A scheduled start time will be delayed if the previous

2091

# execution has not ended when its scheduled time occurs.

2092

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2093

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2094

# the job will be tried a total of retry_count

2095

# times, with exponential backoff, until the next scheduled start

2096

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2097

"userUpdateTime": "A String", # Output only. The creation time of the job.

2098

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2099

# this deadline then the request is cancelled and the attempt is marked as a

2100

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2101

# execution logs. Cloud Scheduler will retry the job according

2102

# to the RetryConfig.

2103

#

2104

# The allowed duration for this deadline is:

2105

#

2106

# * For HTTP targets, between 15 seconds and 30 minutes.

2107

# * For App Engine HTTP targets, between 15

2108

# seconds and 24 hours.

2109

# * For PubSub targets, this field is ignored.

2110

"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]

2111

# an HTTP request via an http_method such as HTTP

2112

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2113

# response code in the range [200 - 299]. A failure to receive a response

2114

# constitutes a failed execution. For a redirected request, the response

2115

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2116

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2117

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2118

# incompatible HttpMethod.

2119

"oauthToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2120

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2121

# will be generated and attached as an `Authorization` header in the HTTP

2122

# request.

2123

#

2124

# This type of authorization should generally only be used when calling

2125

# Google APIs hosted on *.googleapis.com.

2126

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2127

# This type of authorization should generally only be used when calling Google

2128

# APIs hosted on *.googleapis.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

"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]

2130

# to be used for generating OAuth token.

2131

# The service account must be within the same project as the job. The caller

2132

# must have iam.serviceAccounts.actAs permission for the service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2133

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2134

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2135

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2136

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2137

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2138

# must begin with either "http://" or "https://". Some examples of

2139

# valid values for uri are:

2140

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2141

# encode some characters for safety and compatibility. The maximum allowed

2142

# URL length is 2083 characters after encoding.

2143

"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]

2144

# HTTP request. This map contains the header field names and

2145

# values. Repeated headers are not supported, but a header value can

2146

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2147

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2148

# headers will be ignored or replaced. A partial list of headers that

2149

# will be ignored or replaced is below:

2150

# - Host: This will be computed by Cloud Scheduler and derived from

2151

# uri.

2152

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2153

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2154

# * `X-Google-*`: Google internal use only.

2155

# * `X-AppEngine-*`: Google internal use only.

2156

#

2157

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2158

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2159

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2160

"oidcToken": { # Contains information needed for generating an # If specified, an

2161

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2162

# token will be generated and attached as an `Authorization` header in the

2163

# HTTP request.

2164

#

2165

# This type of authorization can be used for many scenarios, including

2166

# calling Cloud Run, or endpoints where you intend to validate the token

2167

# yourself.

2168

# [OpenID Connect

2169

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2170

# This type of authorization can be used for many scenarios, including

2171

# calling Cloud Run, or endpoints where you intend to validate the token

2172

# yourself.

2173

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

2174

# specified in target will be used.

2175

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2176

# to be used for generating OIDC token.

2177

# The service account must be within the same project as the job. The caller

2178

# must have iam.serviceAccounts.actAs permission for the service account.

2179

},

2180

"httpMethod": "A String", # Which HTTP method to use for the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2182

"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]

2183

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2184

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2185

#

2186

# Pubsub message must contain either non-empty data, or at least one

2187

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2188

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2189

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2190

"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]

2191

# 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]

2192

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2193

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2194

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2195

#

2196

# 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]

2197

"data": "A String", # The message payload for PubsubMessage.

2198

#

2199

# Pubsub message must contain either non-empty data, or at least one

2200

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2201

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2202

}

2203

2204

updateMask: string, A mask used to specify which fields of the job are being updated.

2205

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2212

2213

{ # Configuration for a job.

2214

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2215

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2216

# schedule. The value of this field must be a time

2217

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2218

#

2219

# Note that some time zones include a provision for

2220

# daylight savings time. The rules for daylight saving time are

2221

# determined by the chosen tz. For UTC use the string "utc". If a

2222

# time zone is not specified, the default will be in UTC (also known

2223

# as GMT).

2224

"description": "A String", # Optionally caller-specified in CreateJob or

2225

# UpdateJob.

2226

#

2227

# A human-readable description for the job. This string must not contain

2228

# more than 500 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2229

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2230

# of an HTTP request via an http_method such

2231

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2232

# HTTP response code in the range [200 - 299]. Error 503 is

2233

# considered an App Engine system error instead of an application

2234

# error. Requests returning error 503 will be retried regardless of

2235

# retry configuration and not counted against retry counts. Any other

2236

# response code, or a failure to receive a response before the

2237

# deadline, constitutes a failed attempt.

2238

"body": "A String", # Body.

2239

#

2240

# HTTP request body. A request body is allowed only if the HTTP method is

2241

# POST or PUT. It will result in invalid argument error to set a body on a

2242

# job with an incompatible HttpMethod.

2243

"relativeUri": "A String", # The relative URI.

2244

#

2245

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2246

# It can contain a path, query string arguments, and `#` fragments.

2247

# If the relative URL is empty, then the root path "/" will be used.

2248

# No spaces are allowed, and the maximum length allowed is 2083 characters.

2249

"headers": { # HTTP request headers.

2250

#

2251

# This map contains the header field names and values. Headers can be set

2252

# when the job is created.

2253

#

2254

# Cloud Scheduler sets some headers to default values:

2255

#

2256

# * `User-Agent`: By default, this header is

2257

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2258

# This header can be modified, but Cloud Scheduler will append

2259

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2260

# modified `User-Agent`.

2261

# * `X-CloudScheduler`: This header will be set to true.

2262

#

2263

# If the job has an body, Cloud Scheduler sets

2264

# the following headers:

2265

#

2266

# * `Content-Type`: By default, the `Content-Type` header is set to

2267

# `"application/octet-stream"`. The default can be overridden by explictly

2268

# setting `Content-Type` to a particular media type when the job is

2269

# created.

2270

# For example, `Content-Type` can be set to `"application/json"`.

2271

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2272

# output only. It cannot be changed.

2273

#

2274

# The headers below are output only. They cannot be set or overridden:

2275

#

2276

# * `X-Google-*`: For Google internal use only.

2277

# * `X-AppEngine-*`: For Google internal use only.

2278

#

2279

# In addition, some App Engine headers, which contain

2280

# job-specific information, are also be sent to the job handler.

2281

"a_key": "A String",

2282

},

2283

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2284

#

2285

# For more information about services, versions, and instances see

2286

# [An Overview of App

2287

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2288

# [Microservices Architecture on Google App

2289

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2290

# [App Engine Standard request

2291

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2292

# and [App Engine Flex request

2293

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2294

"version": "A String", # App version.

2295

#

2296

# By default, the job is sent to the version which is the default

2297

# version when the job is attempted.

2298

"host": "A String", # Output only. The host that the job is sent to.

2299

#

2300

# For more information about how App Engine requests are routed, see

2301

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2302

#

2303

# The host is constructed as:

2304

#

2305

#

2306

# * `host = [application_domain_name]`</br>

2307

# `| [service] + '.' + [application_domain_name]`</br>

2308

# `| [version] + '.' + [application_domain_name]`</br>

2309

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2310

# `| [instance] + '.' + [application_domain_name]`</br>

2311

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2312

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2313

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2314

#

2315

# * `application_domain_name` = The domain name of the app, for

2316

# example <app-id>.appspot.com, which is associated with the

2317

# job's project ID.

2318

#

2319

# * `service =` service

2320

#

2321

# * `version =` version

2322

#

2323

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2328

#

2329

# * `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

2344

# to the service which is the default service when the job is attempted.

2345

#

2346

# If version is empty, then the job will be sent

2347

# to the version which is the default version when the job is attempted.

2348

#

2349

# If instance is empty, then the job will be

2350

# 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

2355

# to the default version of the default service when the job is attempted.

2356

"service": "A String", # App service.

2357

#

2358

# By default, the job is sent to the service which is the default

2359

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2360

"instance": "A String", # App instance.

2361

#

2362

# By default, the job is sent to an instance which is available when

2363

# the job is attempted.

2364

#

2365

# Requests can only be sent to a specific instance if

2366

# [manual scaling is used in App Engine

2367

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2368

# App Engine Flex does not support instances. For more information, see

2369

# [App Engine Standard request

2370

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2371

# and [App Engine Flex request

2372

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2373

},

2374

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2375

# permitted.

2376

},

2377

"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]

2378

# different programming environments, including REST APIs and RPC APIs. It is

2379

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2380

# three pieces of data: error code, error message, and error details.

2381

#

2382

# You can find out more about this error model and how to work with it in the

2383

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2384

"message": "A String", # A developer-facing error message, which should be in English. Any

2385

# user-facing error message should be localized and sent in the

2386

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2387

"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]

2388

# message types for APIs to use.

2389

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2390

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2391

},

2392

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2393

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2394

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2395

"state": "A String", # Output only. State of the job.

2396

"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]

2397

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2398

# By default, if a job does not complete successfully (meaning that

2399

# an acknowledgement is not received from the handler, then it will be retried

2400

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2401

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2402

# execution was first attempted. If specified with

2403

# retry_count, the job will be retried until both

2404

# limits are reached.

2405

#

2406

# The default value for max_retry_duration is zero, which means retry

2407

# duration is unlimited.

2408

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2409

# exponential backoff procedure described by

2410

# max_doublings.

2411

#

2412

# The default value of retry_count is zero.

2413

#

2414

# If retry_count is zero, a job attempt will *not* be retried if

2415

# it fails. Instead the Cloud Scheduler system will wait for the

2416

# next scheduled execution time.

2417

#

2418

# If retry_count is set to a non-zero number then Cloud Scheduler

2419

# will retry failed attempts, using exponential backoff,

2420

# retry_count times, or until the next scheduled execution time,

2421

# whichever comes first.

2422

#

2423

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2424

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2425

#

2426

# A job's retry interval starts at

2427

# min_backoff_duration, then doubles

2428

# `max_doublings` times, then increases linearly, and finally

2429

# retries at intervals of

2430

# max_backoff_duration up to

2431

# retry_count times.

2432

#

2433

# For example, if min_backoff_duration is

2434

# 10s, max_backoff_duration is 300s, and

2435

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2436

# retry interval will double three times, and then increase linearly by

2437

# 2^3 * 10s. Finally, the job will retry at intervals of

2438

# max_backoff_duration until the job has

2439

# been attempted retry_count times. Thus, the

2440

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2441

#

2442

# The default value of this field is 5.

2443

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2444

# it fails.

2445

#

2446

# The default value of this field is 5 seconds.

2447

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2448

# it fails.

2449

#

2450

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

},

2452

"name": "A String", # Optionally caller-specified in CreateJob, after

2453

# which it becomes output only.

2454

#

2455

# The job name. For example:

2456

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2457

#

2458

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2459

# hyphens (-), colons (:), or periods (.).

2460

# For more information, see

2461

# [Identifying

2462

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2463

# * `LOCATION_ID` is the canonical ID for the job's location.

2464

# The list of available locations can be obtained by calling

2465

# ListLocations.

2466

# For more information, see https://cloud.google.com/about/locations/.

2467

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2468

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2469

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2470

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2471

# retry of a previously failed attempt or the next execution time

2472

# according to the schedule.

2473

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2474

#

2475

# Describes the schedule on which the job will be executed.

2476

#

2477

# The schedule can be either of the following types:

2478

#

2479

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2480

# * English-like

2481

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2482

#

2483

# As a general rule, execution `n + 1` of a job will not begin

2484

# until execution `n` has finished. Cloud Scheduler will never

2485

# allow two simultaneously outstanding executions. For example,

2486

# this implies that if the `n+1`th execution is scheduled to run at

2487

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2488

# execution will not start until `16:15`.

2489

# A scheduled start time will be delayed if the previous

2490

# execution has not ended when its scheduled time occurs.

2491

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2492

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2493

# the job will be tried a total of retry_count

2494

# times, with exponential backoff, until the next scheduled start

2495

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

"userUpdateTime": "A String", # Output only. The creation time of the job.

2497

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2498

# this deadline then the request is cancelled and the attempt is marked as a

2499

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2500

# execution logs. Cloud Scheduler will retry the job according

2501

# to the RetryConfig.

2502

#

2503

# The allowed duration for this deadline is:

2504

#

2505

# * For HTTP targets, between 15 seconds and 30 minutes.

2506

# * For App Engine HTTP targets, between 15

2507

# seconds and 24 hours.

2508

# * For PubSub targets, this field is ignored.

2509

"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]

2510

# an HTTP request via an http_method such as HTTP

2511

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2512

# response code in the range [200 - 299]. A failure to receive a response

2513

# constitutes a failed execution. For a redirected request, the response

2514

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2515

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2516

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2517

# incompatible HttpMethod.

2518

"oauthToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2519

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2520

# will be generated and attached as an `Authorization` header in the HTTP

2521

# request.

2522

#

2523

# This type of authorization should generally only be used when calling

2524

# Google APIs hosted on *.googleapis.com.

2525

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2526

# This type of authorization should generally only be used when calling Google

2527

# APIs hosted on *.googleapis.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2528

"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]

2529

# to be used for generating OAuth token.

2530

# The service account must be within the same project as the job. The caller

2531

# must have iam.serviceAccounts.actAs permission for the service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2532

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2533

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2534

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2535

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2536

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2537

# must begin with either "http://" or "https://". Some examples of

2538

# valid values for uri are:

2539

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2540

# encode some characters for safety and compatibility. The maximum allowed

2541

# URL length is 2083 characters after encoding.

2542

"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]

2543

# HTTP request. This map contains the header field names and

2544

# values. Repeated headers are not supported, but a header value can

2545

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2546

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2547

# headers will be ignored or replaced. A partial list of headers that

2548

# will be ignored or replaced is below:

2549

# - Host: This will be computed by Cloud Scheduler and derived from

2550

# uri.

2551

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2552

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2553

# * `X-Google-*`: Google internal use only.

2554

# * `X-AppEngine-*`: Google internal use only.

2555

#

2556

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2557

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2558

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2559

"oidcToken": { # Contains information needed for generating an # If specified, an

2560

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2561

# token will be generated and attached as an `Authorization` header in the

2562

# HTTP request.

2563

#

2564

# This type of authorization can be used for many scenarios, including

2565

# calling Cloud Run, or endpoints where you intend to validate the token

2566

# yourself.

2567

# [OpenID Connect

2568

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2569

# This type of authorization can be used for many scenarios, including

2570

# calling Cloud Run, or endpoints where you intend to validate the token

2571

# yourself.

2572

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

2573

# specified in target will be used.

2574

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2575

# to be used for generating OIDC token.

2576

# The service account must be within the same project as the job. The caller

2577

# must have iam.serviceAccounts.actAs permission for the service account.

2578

},

2579

"httpMethod": "A String", # Which HTTP method to use for the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2580

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2581

"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]

2582

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2583

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2584

#

2585

# Pubsub message must contain either non-empty data, or at least one

2586

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2587

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2588

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2589

"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]

2590

# 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]

2591

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2592

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2593

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2594

#

2595

# 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]

2596

"data": "A String", # The message payload for PubsubMessage.

2597

#

2598

# Pubsub message must contain either non-empty data, or at least one

2599

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2600

},

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>

2606

<pre>Pauses a job.

2607

2608

If a job is paused then the system will stop executing the job

2609

until it is re-enabled via ResumeJob. The

2610

state of the job is stored in state; if paused it

2611

will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED

2612

to be paused.

2613

2614

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2615

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2616

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

2617

body: object, The request body.

2618

The object takes the form of:

2619

2620

{ # Request message for PauseJob.

2621

}

2622

2623

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2630

2631

{ # Configuration for a job.

2632

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2633

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2634

# schedule. The value of this field must be a time

2635

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2636

#

2637

# Note that some time zones include a provision for

2638

# daylight savings time. The rules for daylight saving time are

2639

# determined by the chosen tz. For UTC use the string "utc". If a

2640

# time zone is not specified, the default will be in UTC (also known

2641

# as GMT).

2642

"description": "A String", # Optionally caller-specified in CreateJob or

2643

# UpdateJob.

2644

#

2645

# A human-readable description for the job. This string must not contain

2646

# more than 500 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2647

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2648

# of an HTTP request via an http_method such

2649

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2650

# HTTP response code in the range [200 - 299]. Error 503 is

2651

# considered an App Engine system error instead of an application

2652

# error. Requests returning error 503 will be retried regardless of

2653

# retry configuration and not counted against retry counts. Any other

2654

# response code, or a failure to receive a response before the

2655

# deadline, constitutes a failed attempt.

2656

"body": "A String", # Body.

2657

#

2658

# HTTP request body. A request body is allowed only if the HTTP method is

2659

# POST or PUT. It will result in invalid argument error to set a body on a

2660

# job with an incompatible HttpMethod.

2661

"relativeUri": "A String", # The relative URI.

2662

#

2663

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2664

# It can contain a path, query string arguments, and `#` fragments.

2665

# If the relative URL is empty, then the root path "/" will be used.

2666

# No spaces are allowed, and the maximum length allowed is 2083 characters.

2667

"headers": { # HTTP request headers.

2668

#

2669

# This map contains the header field names and values. Headers can be set

2670

# when the job is created.

2671

#

2672

# Cloud Scheduler sets some headers to default values:

2673

#

2674

# * `User-Agent`: By default, this header is

2675

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2676

# This header can be modified, but Cloud Scheduler will append

2677

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2678

# modified `User-Agent`.

2679

# * `X-CloudScheduler`: This header will be set to true.

2680

#

2681

# If the job has an body, Cloud Scheduler sets

2682

# the following headers:

2683

#

2684

# * `Content-Type`: By default, the `Content-Type` header is set to

2685

# `"application/octet-stream"`. The default can be overridden by explictly

2686

# setting `Content-Type` to a particular media type when the job is

2687

# created.

2688

# For example, `Content-Type` can be set to `"application/json"`.

2689

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2690

# output only. It cannot be changed.

2691

#

2692

# The headers below are output only. They cannot be set or overridden:

2693

#

2694

# * `X-Google-*`: For Google internal use only.

2695

# * `X-AppEngine-*`: For Google internal use only.

2696

#

2697

# In addition, some App Engine headers, which contain

2698

# job-specific information, are also be sent to the job handler.

2699

"a_key": "A String",

2700

},

2701

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2702

#

2703

# For more information about services, versions, and instances see

2704

# [An Overview of App

2705

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2706

# [Microservices Architecture on Google App

2707

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2708

# [App Engine Standard request

2709

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2710

# and [App Engine Flex request

2711

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2712

"version": "A String", # App version.

2713

#

2714

# By default, the job is sent to the version which is the default

2715

# version when the job is attempted.

2716

"host": "A String", # Output only. The host that the job is sent to.

2717

#

2718

# For more information about how App Engine requests are routed, see

2719

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2720

#

2721

# The host is constructed as:

2722

#

2723

#

2724

# * `host = [application_domain_name]`</br>

2725

# `| [service] + '.' + [application_domain_name]`</br>

2726

# `| [version] + '.' + [application_domain_name]`</br>

2727

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2728

# `| [instance] + '.' + [application_domain_name]`</br>

2729

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2730

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2731

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2732

#

2733

# * `application_domain_name` = The domain name of the app, for

2734

# example <app-id>.appspot.com, which is associated with the

2735

# job's project ID.

2736

#

2737

# * `service =` service

2738

#

2739

# * `version =` version

2740

#

2741

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2746

#

2747

# * `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

2762

# to the service which is the default service when the job is attempted.

2763

#

2764

# If version is empty, then the job will be sent

2765

# to the version which is the default version when the job is attempted.

2766

#

2767

# If instance is empty, then the job will be

2768

# 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

2773

# to the default version of the default service when the job is attempted.

2774

"service": "A String", # App service.

2775

#

2776

# By default, the job is sent to the service which is the default

2777

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2778

"instance": "A String", # App instance.

2779

#

2780

# By default, the job is sent to an instance which is available when

2781

# the job is attempted.

2782

#

2783

# Requests can only be sent to a specific instance if

2784

# [manual scaling is used in App Engine

2785

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2786

# App Engine Flex does not support instances. For more information, see

2787

# [App Engine Standard request

2788

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2789

# and [App Engine Flex request

2790

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2791

},

2792

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2793

# permitted.

2794

},

2795

"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]

2796

# different programming environments, including REST APIs and RPC APIs. It is

2797

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2798

# three pieces of data: error code, error message, and error details.

2799

#

2800

# You can find out more about this error model and how to work with it in the

2801

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2802

"message": "A String", # A developer-facing error message, which should be in English. Any

2803

# user-facing error message should be localized and sent in the

2804

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2805

"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]

2806

# message types for APIs to use.

2807

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2808

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2809

},

2810

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2811

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2812

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2813

"state": "A String", # Output only. State of the job.

2814

"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]

2815

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2816

# By default, if a job does not complete successfully (meaning that

2817

# an acknowledgement is not received from the handler, then it will be retried

2818

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2819

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2820

# execution was first attempted. If specified with

2821

# retry_count, the job will be retried until both

2822

# limits are reached.

2823

#

2824

# The default value for max_retry_duration is zero, which means retry

2825

# duration is unlimited.

2826

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2827

# exponential backoff procedure described by

2828

# max_doublings.

2829

#

2830

# The default value of retry_count is zero.

2831

#

2832

# If retry_count is zero, a job attempt will *not* be retried if

2833

# it fails. Instead the Cloud Scheduler system will wait for the

2834

# next scheduled execution time.

2835

#

2836

# If retry_count is set to a non-zero number then Cloud Scheduler

2837

# will retry failed attempts, using exponential backoff,

2838

# retry_count times, or until the next scheduled execution time,

2839

# whichever comes first.

2840

#

2841

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2842

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2843

#

2844

# A job's retry interval starts at

2845

# min_backoff_duration, then doubles

2846

# `max_doublings` times, then increases linearly, and finally

2847

# retries at intervals of

2848

# max_backoff_duration up to

2849

# retry_count times.

2850

#

2851

# For example, if min_backoff_duration is

2852

# 10s, max_backoff_duration is 300s, and

2853

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2854

# retry interval will double three times, and then increase linearly by

2855

# 2^3 * 10s. Finally, the job will retry at intervals of

2856

# max_backoff_duration until the job has

2857

# been attempted retry_count times. Thus, the

2858

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2859

#

2860

# The default value of this field is 5.

2861

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2862

# it fails.

2863

#

2864

# The default value of this field is 5 seconds.

2865

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2866

# it fails.

2867

#

2868

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2869

},

2870

"name": "A String", # Optionally caller-specified in CreateJob, after

2871

# which it becomes output only.

2872

#

2873

# The job name. For example:

2874

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2875

#

2876

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2877

# hyphens (-), colons (:), or periods (.).

2878

# For more information, see

2879

# [Identifying

2880

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2881

# * `LOCATION_ID` is the canonical ID for the job's location.

2882

# The list of available locations can be obtained by calling

2883

# ListLocations.

2884

# For more information, see https://cloud.google.com/about/locations/.

2885

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2886

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2887

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2888

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2889

# retry of a previously failed attempt or the next execution time

2890

# according to the schedule.

2891

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2892

#

2893

# Describes the schedule on which the job will be executed.

2894

#

2895

# The schedule can be either of the following types:

2896

#

2897

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2898

# * English-like

2899

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2900

#

2901

# As a general rule, execution `n + 1` of a job will not begin

2902

# until execution `n` has finished. Cloud Scheduler will never

2903

# allow two simultaneously outstanding executions. For example,

2904

# this implies that if the `n+1`th execution is scheduled to run at

2905

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2906

# execution will not start until `16:15`.

2907

# A scheduled start time will be delayed if the previous

2908

# execution has not ended when its scheduled time occurs.

2909

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2910

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2911

# the job will be tried a total of retry_count

2912

# times, with exponential backoff, until the next scheduled start

2913

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2914

"userUpdateTime": "A String", # Output only. The creation time of the job.

2915

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2916

# this deadline then the request is cancelled and the attempt is marked as a

2917

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2918

# execution logs. Cloud Scheduler will retry the job according

2919

# to the RetryConfig.

2920

#

2921

# The allowed duration for this deadline is:

2922

#

2923

# * For HTTP targets, between 15 seconds and 30 minutes.

2924

# * For App Engine HTTP targets, between 15

2925

# seconds and 24 hours.

2926

# * For PubSub targets, this field is ignored.

2927

"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]

2928

# an HTTP request via an http_method such as HTTP

2929

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2930

# response code in the range [200 - 299]. A failure to receive a response

2931

# constitutes a failed execution. For a redirected request, the response

2932

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2933

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2934

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2935

# incompatible HttpMethod.

2936

"oauthToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2937

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2938

# will be generated and attached as an `Authorization` header in the HTTP

2939

# request.

2940

#

2941

# This type of authorization should generally only be used when calling

2942

# Google APIs hosted on *.googleapis.com.

2943

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2944

# This type of authorization should generally only be used when calling Google

2945

# APIs hosted on *.googleapis.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

"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]

2947

# to be used for generating OAuth token.

2948

# The service account must be within the same project as the job. The caller

2949

# must have iam.serviceAccounts.actAs permission for the service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2950

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2951

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2952

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2953

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2954

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2955

# must begin with either "http://" or "https://". Some examples of

2956

# valid values for uri are:

2957

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2958

# encode some characters for safety and compatibility. The maximum allowed

2959

# URL length is 2083 characters after encoding.

2960

"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]

2961

# HTTP request. This map contains the header field names and

2962

# values. Repeated headers are not supported, but a header value can

2963

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2964

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2965

# headers will be ignored or replaced. A partial list of headers that

2966

# will be ignored or replaced is below:

2967

# - Host: This will be computed by Cloud Scheduler and derived from

2968

# uri.

2969

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2970

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2971

# * `X-Google-*`: Google internal use only.

2972

# * `X-AppEngine-*`: Google internal use only.

2973

#

2974

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2975

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2976

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2977

"oidcToken": { # Contains information needed for generating an # If specified, an

2978

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2979

# token will be generated and attached as an `Authorization` header in the

2980

# HTTP request.

2981

#

2982

# This type of authorization can be used for many scenarios, including

2983

# calling Cloud Run, or endpoints where you intend to validate the token

2984

# yourself.

2985

# [OpenID Connect

2986

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2987

# This type of authorization can be used for many scenarios, including

2988

# calling Cloud Run, or endpoints where you intend to validate the token

2989

# yourself.

2990

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

2991

# specified in target will be used.

2992

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2993

# to be used for generating OIDC token.

2994

# The service account must be within the same project as the job. The caller

2995

# must have iam.serviceAccounts.actAs permission for the service account.

2996

},

2997

"httpMethod": "A String", # Which HTTP method to use for the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2998

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2999

"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]

3000

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3001

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3002

#

3003

# Pubsub message must contain either non-empty data, or at least one

3004

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3005

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3006

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

"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]

3008

# 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]

3009

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3010

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3011

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3012

#

3013

# 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]

3014

"data": "A String", # The message payload for PubsubMessage.

3015

#

3016

# Pubsub message must contain either non-empty data, or at least one

3017

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3018

},

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>

3024

<pre>Resume a job.

3025

3026

This method reenables a job after it has been Job.State.PAUSED. The

3027

state of a job is stored in Job.state; after calling this method it

3028

will be set to Job.State.ENABLED. A job must be in

3029

Job.State.PAUSED to be resumed.

3030

3031

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3032

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3033

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3034

body: object, The request body.

3035

The object takes the form of:

3036

3037

{ # Request message for ResumeJob.

3038

}

3039

3040

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3047

3048

{ # Configuration for a job.

3049

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3050

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3051

# schedule. The value of this field must be a time

3052

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3053

#

3054

# Note that some time zones include a provision for

3055

# daylight savings time. The rules for daylight saving time are

3056

# determined by the chosen tz. For UTC use the string "utc". If a

3057

# time zone is not specified, the default will be in UTC (also known

3058

# as GMT).

3059

"description": "A String", # Optionally caller-specified in CreateJob or

3060

# UpdateJob.

3061

#

3062

# A human-readable description for the job. This string must not contain

3063

# more than 500 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3064

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3065

# of an HTTP request via an http_method such

3066

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3067

# HTTP response code in the range [200 - 299]. Error 503 is

3068

# considered an App Engine system error instead of an application

3069

# error. Requests returning error 503 will be retried regardless of

3070

# retry configuration and not counted against retry counts. Any other

3071

# response code, or a failure to receive a response before the

3072

# deadline, constitutes a failed attempt.

3073

"body": "A String", # Body.

3074

#

3075

# HTTP request body. A request body is allowed only if the HTTP method is

3076

# POST or PUT. It will result in invalid argument error to set a body on a

3077

# job with an incompatible HttpMethod.

3078

"relativeUri": "A String", # The relative URI.

3079

#

3080

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3081

# It can contain a path, query string arguments, and `#` fragments.

3082

# If the relative URL is empty, then the root path "/" will be used.

3083

# No spaces are allowed, and the maximum length allowed is 2083 characters.

3084

"headers": { # HTTP request headers.

3085

#

3086

# This map contains the header field names and values. Headers can be set

3087

# when the job is created.

3088

#

3089

# Cloud Scheduler sets some headers to default values:

3090

#

3091

# * `User-Agent`: By default, this header is

3092

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3093

# This header can be modified, but Cloud Scheduler will append

3094

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3095

# modified `User-Agent`.

3096

# * `X-CloudScheduler`: This header will be set to true.

3097

#

3098

# If the job has an body, Cloud Scheduler sets

3099

# the following headers:

3100

#

3101

# * `Content-Type`: By default, the `Content-Type` header is set to

3102

# `"application/octet-stream"`. The default can be overridden by explictly

3103

# setting `Content-Type` to a particular media type when the job is

3104

# created.

3105

# For example, `Content-Type` can be set to `"application/json"`.

3106

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3107

# output only. It cannot be changed.

3108

#

3109

# The headers below are output only. They cannot be set or overridden:

3110

#

3111

# * `X-Google-*`: For Google internal use only.

3112

# * `X-AppEngine-*`: For Google internal use only.

3113

#

3114

# In addition, some App Engine headers, which contain

3115

# job-specific information, are also be sent to the job handler.

3116

"a_key": "A String",

3117

},

3118

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3119

#

3120

# For more information about services, versions, and instances see

3121

# [An Overview of App

3122

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3123

# [Microservices Architecture on Google App

3124

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3125

# [App Engine Standard request

3126

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3127

# and [App Engine Flex request

3128

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3129

"version": "A String", # App version.

3130

#

3131

# By default, the job is sent to the version which is the default

3132

# version when the job is attempted.

3133

"host": "A String", # Output only. The host that the job is sent to.

3134

#

3135

# For more information about how App Engine requests are routed, see

3136

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3137

#

3138

# The host is constructed as:

3139

#

3140

#

3141

# * `host = [application_domain_name]`</br>

3142

# `| [service] + '.' + [application_domain_name]`</br>

3143

# `| [version] + '.' + [application_domain_name]`</br>

3144

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3145

# `| [instance] + '.' + [application_domain_name]`</br>

3146

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3147

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3148

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3149

#

3150

# * `application_domain_name` = The domain name of the app, for

3151

# example <app-id>.appspot.com, which is associated with the

3152

# job's project ID.

3153

#

3154

# * `service =` service

3155

#

3156

# * `version =` version

3157

#

3158

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3163

#

3164

# * `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

3179

# to the service which is the default service when the job is attempted.

3180

#

3181

# If version is empty, then the job will be sent

3182

# to the version which is the default version when the job is attempted.

3183

#

3184

# If instance is empty, then the job will be

3185

# 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

3190

# to the default version of the default service when the job is attempted.

3191

"service": "A String", # App service.

3192

#

3193

# By default, the job is sent to the service which is the default

3194

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3195

"instance": "A String", # App instance.

3196

#

3197

# By default, the job is sent to an instance which is available when

3198

# the job is attempted.

3199

#

3200

# Requests can only be sent to a specific instance if

3201

# [manual scaling is used in App Engine

3202

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3203

# App Engine Flex does not support instances. For more information, see

3204

# [App Engine Standard request

3205

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3206

# and [App Engine Flex request

3207

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3208

},

3209

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3210

# permitted.

3211

},

3212

"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]

3213

# different programming environments, including REST APIs and RPC APIs. It is

3214

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3215

# three pieces of data: error code, error message, and error details.

3216

#

3217

# You can find out more about this error model and how to work with it in the

3218

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3219

"message": "A String", # A developer-facing error message, which should be in English. Any

3220

# user-facing error message should be localized and sent in the

3221

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3222

"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]

3223

# message types for APIs to use.

3224

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3225

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3226

},

3227

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3228

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3229

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"state": "A String", # Output only. State of the job.

3231

"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]

3232

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3233

# By default, if a job does not complete successfully (meaning that

3234

# an acknowledgement is not received from the handler, then it will be retried

3235

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3236

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3237

# execution was first attempted. If specified with

3238

# retry_count, the job will be retried until both

3239

# limits are reached.

3240

#

3241

# The default value for max_retry_duration is zero, which means retry

3242

# duration is unlimited.

3243

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3244

# exponential backoff procedure described by

3245

# max_doublings.

3246

#

3247

# The default value of retry_count is zero.

3248

#

3249

# If retry_count is zero, a job attempt will *not* be retried if

3250

# it fails. Instead the Cloud Scheduler system will wait for the

3251

# next scheduled execution time.

3252

#

3253

# If retry_count is set to a non-zero number then Cloud Scheduler

3254

# will retry failed attempts, using exponential backoff,

3255

# retry_count times, or until the next scheduled execution time,

3256

# whichever comes first.

3257

#

3258

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3259

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3260

#

3261

# A job's retry interval starts at

3262

# min_backoff_duration, then doubles

3263

# `max_doublings` times, then increases linearly, and finally

3264

# retries at intervals of

3265

# max_backoff_duration up to

3266

# retry_count times.

3267

#

3268

# For example, if min_backoff_duration is

3269

# 10s, max_backoff_duration is 300s, and

3270

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3271

# retry interval will double three times, and then increase linearly by

3272

# 2^3 * 10s. Finally, the job will retry at intervals of

3273

# max_backoff_duration until the job has

3274

# been attempted retry_count times. Thus, the

3275

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3276

#

3277

# The default value of this field is 5.

3278

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3279

# it fails.

3280

#

3281

# The default value of this field is 5 seconds.

3282

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3283

# it fails.

3284

#

3285

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3286

},

3287

"name": "A String", # Optionally caller-specified in CreateJob, after

3288

# which it becomes output only.

3289

#

3290

# The job name. For example:

3291

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3292

#

3293

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3294

# hyphens (-), colons (:), or periods (.).

3295

# For more information, see

3296

# [Identifying

3297

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3298

# * `LOCATION_ID` is the canonical ID for the job's location.

3299

# The list of available locations can be obtained by calling

3300

# ListLocations.

3301

# For more information, see https://cloud.google.com/about/locations/.

3302

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3303

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3304

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3305

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3306

# retry of a previously failed attempt or the next execution time

3307

# according to the schedule.

3308

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3309

#

3310

# Describes the schedule on which the job will be executed.

3311

#

3312

# The schedule can be either of the following types:

3313

#

3314

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3315

# * English-like

3316

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3317

#

3318

# As a general rule, execution `n + 1` of a job will not begin

3319

# until execution `n` has finished. Cloud Scheduler will never

3320

# allow two simultaneously outstanding executions. For example,

3321

# this implies that if the `n+1`th execution is scheduled to run at

3322

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3323

# execution will not start until `16:15`.

3324

# A scheduled start time will be delayed if the previous

3325

# execution has not ended when its scheduled time occurs.

3326

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3327

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3328

# the job will be tried a total of retry_count

3329

# times, with exponential backoff, until the next scheduled start

3330

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

"userUpdateTime": "A String", # Output only. The creation time of the job.

3332

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3333

# this deadline then the request is cancelled and the attempt is marked as a

3334

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3335

# execution logs. Cloud Scheduler will retry the job according

3336

# to the RetryConfig.

3337

#

3338

# The allowed duration for this deadline is:

3339

#

3340

# * For HTTP targets, between 15 seconds and 30 minutes.

3341

# * For App Engine HTTP targets, between 15

3342

# seconds and 24 hours.

3343

# * For PubSub targets, this field is ignored.

3344

"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]

3345

# an HTTP request via an http_method such as HTTP

3346

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3347

# response code in the range [200 - 299]. A failure to receive a response

3348

# constitutes a failed execution. For a redirected request, the response

3349

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3350

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

3351

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3352

# incompatible HttpMethod.

3353

"oauthToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3354

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3355

# will be generated and attached as an `Authorization` header in the HTTP

3356

# request.

3357

#

3358

# This type of authorization should generally only be used when calling

3359

# Google APIs hosted on *.googleapis.com.

3360

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3361

# This type of authorization should generally only be used when calling Google

3362

# APIs hosted on *.googleapis.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3363

"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]

3364

# to be used for generating OAuth token.

3365

# The service account must be within the same project as the job. The caller

3366

# must have iam.serviceAccounts.actAs permission for the service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3367

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3368

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3369

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3370

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3371

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3372

# must begin with either "http://" or "https://". Some examples of

3373

# valid values for uri are:

3374

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3375

# encode some characters for safety and compatibility. The maximum allowed

3376

# URL length is 2083 characters after encoding.

3377

"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]

3378

# HTTP request. This map contains the header field names and

3379

# values. Repeated headers are not supported, but a header value can

3380

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3381

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3382

# headers will be ignored or replaced. A partial list of headers that

3383

# will be ignored or replaced is below:

3384

# - Host: This will be computed by Cloud Scheduler and derived from

3385

# uri.

3386

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3387

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3388

# * `X-Google-*`: Google internal use only.

3389

# * `X-AppEngine-*`: Google internal use only.

3390

#

3391

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3392

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3393

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3394

"oidcToken": { # Contains information needed for generating an # If specified, an

3395

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3396

# token will be generated and attached as an `Authorization` header in the

3397

# HTTP request.

3398

#

3399

# This type of authorization can be used for many scenarios, including

3400

# calling Cloud Run, or endpoints where you intend to validate the token

3401

# yourself.

3402

# [OpenID Connect

3403

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3404

# This type of authorization can be used for many scenarios, including

3405

# calling Cloud Run, or endpoints where you intend to validate the token

3406

# yourself.

3407

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

3408

# specified in target will be used.

3409

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3410

# to be used for generating OIDC token.

3411

# The service account must be within the same project as the job. The caller

3412

# must have iam.serviceAccounts.actAs permission for the service account.

3413

},

3414

"httpMethod": "A String", # Which HTTP method to use for the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3415

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3416

"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]

3417

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3418

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3419

#

3420

# Pubsub message must contain either non-empty data, or at least one

3421

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3422

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3423

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3424

"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]

3425

# 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]

3426

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3427

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3428

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3429

#

3430

# 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]

3431

"data": "A String", # The message payload for PubsubMessage.

3432

#

3433

# Pubsub message must contain either non-empty data, or at least one

3434

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3435

},

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>

3441

<pre>Forces a job to run now.

3442

3443

When this method is called, Cloud Scheduler will dispatch the job, even

3444

if the job is already running.

3445

3446

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3447

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3448

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3449

body: object, The request body.

3450

The object takes the form of:

3451

3452

{ # 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:

3463

3464

{ # Configuration for a job.

3465

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3466

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3467

# schedule. The value of this field must be a time

3468

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3469

#

3470

# Note that some time zones include a provision for

3471

# daylight savings time. The rules for daylight saving time are

3472

# determined by the chosen tz. For UTC use the string "utc". If a

3473

# time zone is not specified, the default will be in UTC (also known

3474

# as GMT).

3475

"description": "A String", # Optionally caller-specified in CreateJob or

3476

# UpdateJob.

3477

#

3478

# A human-readable description for the job. This string must not contain

3479

# more than 500 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3480

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3481

# of an HTTP request via an http_method such

3482

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3483

# HTTP response code in the range [200 - 299]. Error 503 is

3484

# considered an App Engine system error instead of an application

3485

# error. Requests returning error 503 will be retried regardless of

3486

# retry configuration and not counted against retry counts. Any other

3487

# response code, or a failure to receive a response before the

3488

# deadline, constitutes a failed attempt.

3489

"body": "A String", # Body.

3490

#

3491

# HTTP request body. A request body is allowed only if the HTTP method is

3492

# POST or PUT. It will result in invalid argument error to set a body on a

3493

# job with an incompatible HttpMethod.

3494

"relativeUri": "A String", # The relative URI.

3495

#

3496

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3497

# It can contain a path, query string arguments, and `#` fragments.

3498

# If the relative URL is empty, then the root path "/" will be used.

3499

# No spaces are allowed, and the maximum length allowed is 2083 characters.

3500

"headers": { # HTTP request headers.

3501

#

3502

# This map contains the header field names and values. Headers can be set

3503

# when the job is created.

3504

#

3505

# Cloud Scheduler sets some headers to default values:

3506

#

3507

# * `User-Agent`: By default, this header is

3508

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3509

# This header can be modified, but Cloud Scheduler will append

3510

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3511

# modified `User-Agent`.

3512

# * `X-CloudScheduler`: This header will be set to true.

3513

#

3514

# If the job has an body, Cloud Scheduler sets

3515

# the following headers:

3516

#

3517

# * `Content-Type`: By default, the `Content-Type` header is set to

3518

# `"application/octet-stream"`. The default can be overridden by explictly

3519

# setting `Content-Type` to a particular media type when the job is

3520

# created.

3521

# For example, `Content-Type` can be set to `"application/json"`.

3522

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3523

# output only. It cannot be changed.

3524

#

3525

# The headers below are output only. They cannot be set or overridden:

3526

#

3527

# * `X-Google-*`: For Google internal use only.

3528

# * `X-AppEngine-*`: For Google internal use only.

3529

#

3530

# In addition, some App Engine headers, which contain

3531

# job-specific information, are also be sent to the job handler.

3532

"a_key": "A String",

3533

},

3534

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3535

#

3536

# For more information about services, versions, and instances see

3537

# [An Overview of App

3538

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3539

# [Microservices Architecture on Google App

3540

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3541

# [App Engine Standard request

3542

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3543

# and [App Engine Flex request

3544

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3545

"version": "A String", # App version.

3546

#

3547

# By default, the job is sent to the version which is the default

3548

# version when the job is attempted.

3549

"host": "A String", # Output only. The host that the job is sent to.

3550

#

3551

# For more information about how App Engine requests are routed, see

3552

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3553

#

3554

# The host is constructed as:

3555

#

3556

#

3557

# * `host = [application_domain_name]`</br>

3558

# `| [service] + '.' + [application_domain_name]`</br>

3559

# `| [version] + '.' + [application_domain_name]`</br>

3560

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3561

# `| [instance] + '.' + [application_domain_name]`</br>

3562

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3563

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3564

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3565

#

3566

# * `application_domain_name` = The domain name of the app, for

3567

# example <app-id>.appspot.com, which is associated with the

3568

# job's project ID.

3569

#

3570

# * `service =` service

3571

#

3572

# * `version =` version

3573

#

3574

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3579

#

3580

# * `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

3595

# to the service which is the default service when the job is attempted.

3596

#

3597

# If version is empty, then the job will be sent

3598

# to the version which is the default version when the job is attempted.

3599

#

3600

# If instance is empty, then the job will be

3601

# 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

3606

# to the default version of the default service when the job is attempted.

3607

"service": "A String", # App service.

3608

#

3609

# By default, the job is sent to the service which is the default

3610

# service when the job is attempted.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3611

"instance": "A String", # App instance.

3612

#

3613

# By default, the job is sent to an instance which is available when

3614

# the job is attempted.

3615

#

3616

# Requests can only be sent to a specific instance if

3617

# [manual scaling is used in App Engine

3618

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3619

# App Engine Flex does not support instances. For more information, see

3620

# [App Engine Standard request

3621

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3622

# and [App Engine Flex request

3623

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3624

},

3625

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3626

# permitted.

3627

},

3628

"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]

3629

# different programming environments, including REST APIs and RPC APIs. It is

3630

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3631

# three pieces of data: error code, error message, and error details.

3632

#

3633

# You can find out more about this error model and how to work with it in the

3634

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3635

"message": "A String", # A developer-facing error message, which should be in English. Any

3636

# user-facing error message should be localized and sent in the

3637

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3638

"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]

3639

# message types for APIs to use.

3640

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3641

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3642

},

3643

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3644

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3645

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3646

"state": "A String", # Output only. State of the job.

3647

"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]

3648

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3649

# By default, if a job does not complete successfully (meaning that

3650

# an acknowledgement is not received from the handler, then it will be retried

3651

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3652

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3653

# execution was first attempted. If specified with

3654

# retry_count, the job will be retried until both

3655

# limits are reached.

3656

#

3657

# The default value for max_retry_duration is zero, which means retry

3658

# duration is unlimited.

3659

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3660

# exponential backoff procedure described by

3661

# max_doublings.

3662

#

3663

# The default value of retry_count is zero.

3664

#

3665

# If retry_count is zero, a job attempt will *not* be retried if

3666

# it fails. Instead the Cloud Scheduler system will wait for the

3667

# next scheduled execution time.

3668

#

3669

# If retry_count is set to a non-zero number then Cloud Scheduler

3670

# will retry failed attempts, using exponential backoff,

3671

# retry_count times, or until the next scheduled execution time,

3672

# whichever comes first.

3673

#

3674

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3675

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3676

#

3677

# A job's retry interval starts at

3678

# min_backoff_duration, then doubles

3679

# `max_doublings` times, then increases linearly, and finally

3680

# retries at intervals of

3681

# max_backoff_duration up to

3682

# retry_count times.

3683

#

3684

# For example, if min_backoff_duration is

3685

# 10s, max_backoff_duration is 300s, and

3686

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3687

# retry interval will double three times, and then increase linearly by

3688

# 2^3 * 10s. Finally, the job will retry at intervals of

3689

# max_backoff_duration until the job has

3690

# been attempted retry_count times. Thus, the

3691

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3692

#

3693

# The default value of this field is 5.

3694

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3695

# it fails.

3696

#

3697

# The default value of this field is 5 seconds.

3698

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3699

# it fails.

3700

#

3701

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3702

},

3703

"name": "A String", # Optionally caller-specified in CreateJob, after

3704

# which it becomes output only.

3705

#

3706

# The job name. For example:

3707

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3708

#

3709

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3710

# hyphens (-), colons (:), or periods (.).

3711

# For more information, see

3712

# [Identifying

3713

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3714

# * `LOCATION_ID` is the canonical ID for the job's location.

3715

# The list of available locations can be obtained by calling

3716

# ListLocations.

3717

# For more information, see https://cloud.google.com/about/locations/.

3718

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3719

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3720

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3721

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3722

# retry of a previously failed attempt or the next execution time

3723

# according to the schedule.

3724

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3725

#

3726

# Describes the schedule on which the job will be executed.

3727

#

3728

# The schedule can be either of the following types:

3729

#

3730

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3731

# * English-like

3732

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3733

#

3734

# As a general rule, execution `n + 1` of a job will not begin

3735

# until execution `n` has finished. Cloud Scheduler will never

3736

# allow two simultaneously outstanding executions. For example,

3737

# this implies that if the `n+1`th execution is scheduled to run at

3738

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3739

# execution will not start until `16:15`.

3740

# A scheduled start time will be delayed if the previous

3741

# execution has not ended when its scheduled time occurs.

3742

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3743

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3744

# the job will be tried a total of retry_count

3745

# times, with exponential backoff, until the next scheduled start

3746

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3747

"userUpdateTime": "A String", # Output only. The creation time of the job.

3748

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3749

# this deadline then the request is cancelled and the attempt is marked as a

3750

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3751

# execution logs. Cloud Scheduler will retry the job according

3752

# to the RetryConfig.

3753

#

3754

# The allowed duration for this deadline is:

3755

#

3756

# * For HTTP targets, between 15 seconds and 30 minutes.

3757

# * For App Engine HTTP targets, between 15

3758

# seconds and 24 hours.

3759

# * For PubSub targets, this field is ignored.

3760

"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]

3761

# an HTTP request via an http_method such as HTTP

3762

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3763

# response code in the range [200 - 299]. A failure to receive a response

3764

# constitutes a failed execution. For a redirected request, the response

3765

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3766

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

3767

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3768

# incompatible HttpMethod.

3769

"oauthToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3770

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3771

# will be generated and attached as an `Authorization` header in the HTTP

3772

# request.

3773

#

3774

# This type of authorization should generally only be used when calling

3775

# Google APIs hosted on *.googleapis.com.

3776

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3777

# This type of authorization should generally only be used when calling Google

3778

# APIs hosted on *.googleapis.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3779

"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]

3780

# to be used for generating OAuth token.

3781

# The service account must be within the same project as the job. The caller

3782

# must have iam.serviceAccounts.actAs permission for the service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3783

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3784

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3785

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3786

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3787

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3788

# must begin with either "http://" or "https://". Some examples of

3789

# valid values for uri are:

3790

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3791

# encode some characters for safety and compatibility. The maximum allowed

3792

# URL length is 2083 characters after encoding.

3793

"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]

3794

# HTTP request. This map contains the header field names and

3795

# values. Repeated headers are not supported, but a header value can

3796

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3797

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3798

# headers will be ignored or replaced. A partial list of headers that

3799

# will be ignored or replaced is below:

3800

# - Host: This will be computed by Cloud Scheduler and derived from

3801

# uri.

3802

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3803

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3804

# * `X-Google-*`: Google internal use only.

3805

# * `X-AppEngine-*`: Google internal use only.

3806

#

3807

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3808

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3809

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3810

"oidcToken": { # Contains information needed for generating an # If specified, an

3811

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3812

# token will be generated and attached as an `Authorization` header in the

3813

# HTTP request.

3814

#

3815

# This type of authorization can be used for many scenarios, including

3816

# calling Cloud Run, or endpoints where you intend to validate the token

3817

# yourself.

3818

# [OpenID Connect

3819

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3820

# This type of authorization can be used for many scenarios, including

3821

# calling Cloud Run, or endpoints where you intend to validate the token

3822

# yourself.

3823

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

3824

# specified in target will be used.

3825

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3826

# to be used for generating OIDC token.

3827

# The service account must be within the same project as the job. The caller

3828

# must have iam.serviceAccounts.actAs permission for the service account.

3829

},

3830

"httpMethod": "A String", # Which HTTP method to use for the request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3831

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3832

"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]

3833

# the given Pub/Sub topic.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3834

"attributes": { # Attributes for PubsubMessage.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3835

#

3836

# Pubsub message must contain either non-empty data, or at least one

3837

# attribute.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3838

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3839

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3840

"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]

3841

# 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]

3842

# same format as required by PubSub's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3843

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3844

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3845

#

3846

# 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]

3847

"data": "A String", # The message payload for PubsubMessage.

3848

#

3849

# Pubsub message must contain either non-empty data, or at least one

3850

# attribute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3851

},

Bu Sun Kim