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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

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

80

81

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

82

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

83

84

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

85

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

96

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

97

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

98

99

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

100

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

101

102

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

103

<p class="firstline">Forces a job to run now.</p>

104

<h3>Method Details</h3>

105

Dan O'Meara

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

<pre>Creates a job.

108

109

Args:

Dan O'Meara

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

[diff] [blame]

110

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

Bu Sun Kim

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

[diff] [blame]

111

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

Dan O'Meara

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

[diff] [blame]

112

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

113

The object takes the form of:

114

115

{ # Configuration for a job.

116

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

Bu Sun Kim

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

[diff] [blame]

117

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

118

# UpdateJob.

119

#

120

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

121

# more than 500 characters.

122

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

123

# of an HTTP request via an http_method such

124

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

125

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

126

# considered an App Engine system error instead of an application

127

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

128

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

129

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

130

# deadline, constitutes a failed attempt.

Bu Sun Kim

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

[diff] [blame]

131

"headers": { # HTTP request headers.

132

#

133

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

134

# when the job is created.

135

#

136

# Cloud Scheduler sets some headers to default values:

137

#

138

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

139

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

140

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

141

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

142

# modified `User-Agent`.

143

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

144

#

145

# If the job has an body, Cloud Scheduler sets

146

# the following headers:

147

#

148

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

149

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

150

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

151

# created.

152

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

153

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

154

# output only. It cannot be changed.

155

#

156

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

157

#

158

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

159

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

160

#

161

# In addition, some App Engine headers, which contain

162

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

163

"a_key": "A String",

164

},

165

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

166

#

167

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

168

# [An Overview of App

169

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

170

# [Microservices Architecture on Google App

171

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

172

# [App Engine Standard request

173

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

174

# and [App Engine Flex request

175

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

Bu Sun Kim

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

[diff] [blame^]

176

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

177

#

178

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

179

# service when the job is attempted.

180

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

181

#

182

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

183

# the job is attempted.

184

#

185

# Requests can only be sent to a specific instance if

186

# [manual scaling is used in App Engine

187

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

188

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

189

# [App Engine Standard request

190

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

191

# and [App Engine Flex request

192

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

193

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

194

#

195

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

196

# version when the job is attempted.

197

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

198

#

199

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

200

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

201

#

202

# The host is constructed as:

203

#

204

#

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

#

214

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

215

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

216

# job's project ID.

217

#

218

# * `service =` service

219

#

220

# * `version =` version

221

#

222

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

227

#

228

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

243

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

244

#

245

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

246

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

247

#

248

# If instance is empty, then the job will be

249

# 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

254

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

Bu Sun Kim

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

[diff] [blame]

255

},

Bu Sun Kim

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

[diff] [blame^]

256

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

257

# permitted.

258

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

259

#

260

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

261

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

262

# job with an incompatible HttpMethod.

263

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

264

#

265

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

266

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

267

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

268

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

Bu Sun Kim

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

[diff] [blame]

269

},

270

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

271

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

272

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

273

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

274

#

275

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

276

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

Bu Sun Kim

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

[diff] [blame]

277

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

Bu Sun Kim

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

[diff] [blame]

278

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

279

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

Bu Sun Kim

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

[diff] [blame]

280

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

281

# message types for APIs to use.

282

{

Bu Sun Kim

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

[diff] [blame]

283

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

Bu Sun Kim

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

[diff] [blame]

284

},

285

],

Bu Sun Kim

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

[diff] [blame^]

286

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

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

289

#

290

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

291

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

292

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame^]

293

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

294

#

295

# A job's retry interval starts at

296

# min_backoff_duration, then doubles

297

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

298

# retries at intervals of

299

# max_backoff_duration up to

300

# retry_count times.

301

#

302

# For example, if min_backoff_duration is

303

# 10s, max_backoff_duration is 300s, and

304

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

305

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

306

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

307

# max_backoff_duration until the job has

308

# been attempted retry_count times. Thus, the

309

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

310

#

311

# The default value of this field is 5.

312

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

313

# it fails.

314

#

315

# The default value of this field is 5 seconds.

316

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

317

# it fails.

318

#

319

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

320

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

321

# execution was first attempted. If specified with

322

# retry_count, the job will be retried until both

323

# limits are reached.

324

#

325

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

326

# duration is unlimited.

327

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

328

# exponential backoff procedure described by

329

# max_doublings.

330

#

331

# The default value of retry_count is zero.

332

#

333

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

334

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

335

# next scheduled execution time.

336

#

337

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

338

# will retry failed attempts, using exponential backoff,

339

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

340

# whichever comes first.

341

#

342

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

Bu Sun Kim

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

[diff] [blame]

343

},

344

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

345

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

346

# which it becomes output only.

Bu Sun Kim

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

[diff] [blame]

347

#

Bu Sun Kim

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

[diff] [blame]

348

# The job name. For example:

349

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

350

#

351

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

352

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

353

# For more information, see

354

# [Identifying

355

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

356

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

357

# The list of available locations can be obtained by calling

358

# ListLocations.

359

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

360

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

361

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

362

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

363

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

364

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

365

# according to the schedule.

Bu Sun Kim

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

[diff] [blame^]

366

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

Bu Sun Kim

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

[diff] [blame]

367

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

Bu Sun Kim

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

[diff] [blame]

368

#

369

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

370

#

371

# The schedule can be either of the following types:

372

#

373

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

374

# * English-like

375

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

376

#

377

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

378

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

379

# allow two simultaneously outstanding executions. For example,

380

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

381

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

382

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

383

# A scheduled start time will be delayed if the previous

384

# execution has not ended when its scheduled time occurs.

385

#

Dan O'Meara

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

[diff] [blame]

386

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

387

# the job will be tried a total of retry_count

388

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

389

# time.

Bu Sun Kim

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

[diff] [blame]

390

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

391

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

392

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

393

# execution logs. Cloud Scheduler will retry the job according

394

# to the RetryConfig.

395

#

396

# The allowed duration for this deadline is:

397

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

398

# * For App Engine HTTP targets, between 15

399

# seconds and 24 hours.

Bu Sun Kim

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

[diff] [blame^]

400

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

401

# the given Pub/Sub topic.

402

"attributes": { # Attributes for PubsubMessage.

403

#

404

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

# attribute.

"a_key": "A String",

},

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

409

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

410

# same format as required by PubSub's

411

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

412

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

413

#

414

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

415

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

416

#

417

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

418

# attribute.

419

},

Bu Sun Kim

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

[diff] [blame]

420

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

421

# an HTTP request via an http_method such as HTTP

422

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

423

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

424

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

425

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

426

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

427

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

428

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

429

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

Bu Sun Kim

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

[diff] [blame]

430

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

Bu Sun Kim

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

[diff] [blame]

431

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

432

# will be ignored or replaced is below:

433

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

434

# uri.

435

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

Bu Sun Kim

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

[diff] [blame]

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

439

#

440

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

Bu Sun Kim

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

[diff] [blame]

441

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

442

},

Bu Sun Kim

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

[diff] [blame]

443

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

Bu Sun Kim

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

[diff] [blame]

444

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

445

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

446

# HTTP request.

447

#

448

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

449

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

450

# yourself.

451

# [OpenID Connect

452

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

453

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

454

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

455

# yourself.

Bu Sun Kim

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

[diff] [blame]

456

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

Bu Sun Kim

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

[diff] [blame]

457

# specified in target will be used.

Bu Sun Kim

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

[diff] [blame]

458

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

459

# to be used for generating OIDC token.

460

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

461

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

462

},

Bu Sun Kim

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

[diff] [blame^]

463

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

464

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

465

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

466

# incompatible HttpMethod.

467

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

468

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

469

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

470

# request.

Bu Sun Kim

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

[diff] [blame]

471

#

Bu Sun Kim

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

[diff] [blame^]

472

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

473

# Google APIs hosted on *.googleapis.com.

474

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

475

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

476

# APIs hosted on *.googleapis.com.

477

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

478

# to be used for generating OAuth token.

479

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

480

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

481

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

482

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

483

# will be used.

Bu Sun Kim

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

[diff] [blame]

484

},

Bu Sun Kim

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

[diff] [blame^]

485

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

486

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

487

# valid values for uri are:

488

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

489

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

490

# URL length is 2083 characters after encoding.

Bu Sun Kim

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

[diff] [blame]

491

},

Bu Sun Kim

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

[diff] [blame^]

492

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

493

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

494

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

495

#

496

# Note that some time zones include a provision for

497

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

498

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

499

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

500

# as GMT).

Bu Sun Kim

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

[diff] [blame]

501

}

502

503

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

510

511

{ # Configuration for a job.

512

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

Bu Sun Kim

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

[diff] [blame]

513

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

514

# UpdateJob.

515

#

516

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

517

# more than 500 characters.

518

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

519

# of an HTTP request via an http_method such

520

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

521

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

522

# considered an App Engine system error instead of an application

523

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

524

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

525

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

526

# deadline, constitutes a failed attempt.

Bu Sun Kim

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

[diff] [blame]

527

"headers": { # HTTP request headers.

528

#

529

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

530

# when the job is created.

531

#

532

# Cloud Scheduler sets some headers to default values:

533

#

534

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

535

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

536

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

537

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

538

# modified `User-Agent`.

539

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

540

#

541

# If the job has an body, Cloud Scheduler sets

542

# the following headers:

543

#

544

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

545

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

546

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

547

# created.

548

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

549

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

550

# output only. It cannot be changed.

551

#

552

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

553

#

554

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

555

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

556

#

557

# In addition, some App Engine headers, which contain

558

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

559

"a_key": "A String",

560

},

561

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

562

#

563

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

564

# [An Overview of App

565

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

566

# [Microservices Architecture on Google App

567

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

568

# [App Engine Standard request

569

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

570

# and [App Engine Flex request

571

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

Bu Sun Kim

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

[diff] [blame^]

572

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

573

#

574

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

575

# service when the job is attempted.

576

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

577

#

578

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

579

# the job is attempted.

580

#

581

# Requests can only be sent to a specific instance if

582

# [manual scaling is used in App Engine

583

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

584

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

585

# [App Engine Standard request

586

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

587

# and [App Engine Flex request

588

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

589

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

590

#

591

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

592

# version when the job is attempted.

593

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

594

#

595

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

596

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

597

#

598

# The host is constructed as:

599

#

600

#

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

#

610

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

611

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

612

# job's project ID.

613

#

614

# * `service =` service

615

#

616

# * `version =` version

617

#

618

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

623

#

624

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

639

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

640

#

641

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

642

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

643

#

644

# If instance is empty, then the job will be

645

# 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

650

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

Bu Sun Kim

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

[diff] [blame]

651

},

Bu Sun Kim

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

[diff] [blame^]

652

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

653

# permitted.

654

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

655

#

656

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

657

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

658

# job with an incompatible HttpMethod.

659

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

660

#

661

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

662

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

663

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

664

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

Bu Sun Kim

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

[diff] [blame]

665

},

666

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

667

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

668

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

669

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

670

#

671

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

672

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

Bu Sun Kim

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

[diff] [blame]

673

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

Bu Sun Kim

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

[diff] [blame]

674

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

675

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

Bu Sun Kim

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

[diff] [blame]

676

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

677

# message types for APIs to use.

678

{

Bu Sun Kim

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

[diff] [blame]

679

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

Bu Sun Kim

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

[diff] [blame]

680

},

681

],

Bu Sun Kim

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

[diff] [blame^]

682

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

683

},

Bu Sun Kim

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

[diff] [blame]

684

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

685

#

Bu Sun Kim

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

[diff] [blame]

686

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

687

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

688

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame^]

689

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

690

#

691

# A job's retry interval starts at

692

# min_backoff_duration, then doubles

693

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

694

# retries at intervals of

695

# max_backoff_duration up to

696

# retry_count times.

697

#

698

# For example, if min_backoff_duration is

699

# 10s, max_backoff_duration is 300s, and

700

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

701

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

702

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

703

# max_backoff_duration until the job has

704

# been attempted retry_count times. Thus, the

705

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

706

#

707

# The default value of this field is 5.

708

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

709

# it fails.

710

#

711

# The default value of this field is 5 seconds.

712

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

713

# it fails.

714

#

715

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

716

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

717

# execution was first attempted. If specified with

718

# retry_count, the job will be retried until both

719

# limits are reached.

720

#

721

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

722

# duration is unlimited.

723

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

724

# exponential backoff procedure described by

725

# max_doublings.

726

#

727

# The default value of retry_count is zero.

728

#

729

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

730

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

731

# next scheduled execution time.

732

#

733

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

734

# will retry failed attempts, using exponential backoff,

735

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

736

# whichever comes first.

737

#

738

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

Bu Sun Kim

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

[diff] [blame]

739

},

740

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

741

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

742

# which it becomes output only.

743

#

744

# The job name. For example:

745

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

746

#

747

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

748

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

749

# For more information, see

750

# [Identifying

751

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

752

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

753

# The list of available locations can be obtained by calling

754

# ListLocations.

755

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

756

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

757

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

758

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

759

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

760

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

761

# according to the schedule.

Bu Sun Kim

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

[diff] [blame^]

762

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

Bu Sun Kim

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

[diff] [blame]

763

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

Bu Sun Kim

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

[diff] [blame]

764

#

765

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

766

#

767

# The schedule can be either of the following types:

768

#

769

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

770

# * English-like

771

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

772

#

773

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

774

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

775

# allow two simultaneously outstanding executions. For example,

776

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

777

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

778

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

779

# A scheduled start time will be delayed if the previous

780

# execution has not ended when its scheduled time occurs.

781

#

Dan O'Meara

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

[diff] [blame]

782

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

783

# the job will be tried a total of retry_count

784

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

785

# time.

Bu Sun Kim

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

[diff] [blame]

786

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

787

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

788

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

789

# execution logs. Cloud Scheduler will retry the job according

790

# to the RetryConfig.

791

#

792

# The allowed duration for this deadline is:

793

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

794

# * For App Engine HTTP targets, between 15

795

# seconds and 24 hours.

Bu Sun Kim

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

[diff] [blame^]

796

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

797

# the given Pub/Sub topic.

798

"attributes": { # Attributes for PubsubMessage.

799

#

800

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

# attribute.

"a_key": "A String",

},

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

805

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

806

# same format as required by PubSub's

807

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

808

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

809

#

810

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

811

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

812

#

813

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

814

# attribute.

815

},

Bu Sun Kim

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

[diff] [blame]

816

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

817

# an HTTP request via an http_method such as HTTP

818

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

819

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

820

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

821

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

825

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

Bu Sun Kim

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

[diff] [blame]

826

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

Bu Sun Kim

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

[diff] [blame]

827

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

828

# will be ignored or replaced is below:

829

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

830

# uri.

831

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

Bu Sun Kim

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

[diff] [blame]

832

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

Bu Sun Kim

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

[diff] [blame]

833

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

834

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

835

#

836

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

Bu Sun Kim

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

[diff] [blame]

837

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

838

},

Bu Sun Kim

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

[diff] [blame]

839

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

Bu Sun Kim

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

[diff] [blame]

840

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

841

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

842

# HTTP request.

843

#

844

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

845

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

846

# yourself.

847

# [OpenID Connect

848

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

849

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

850

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

851

# yourself.

Bu Sun Kim

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

[diff] [blame]

852

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

Bu Sun Kim

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

[diff] [blame]

853

# specified in target will be used.

Bu Sun Kim

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

[diff] [blame]

854

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

855

# to be used for generating OIDC token.

856

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

857

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

858

},

Bu Sun Kim

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

[diff] [blame^]

859

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

860

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

861

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

862

# incompatible HttpMethod.

863

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

864

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

865

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

866

# request.

Bu Sun Kim

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

[diff] [blame]

867

#

Bu Sun Kim

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

[diff] [blame^]

868

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

869

# Google APIs hosted on *.googleapis.com.

870

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

871

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

872

# APIs hosted on *.googleapis.com.

873

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

874

# to be used for generating OAuth token.

875

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

876

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

877

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

878

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

879

# will be used.

Bu Sun Kim

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

[diff] [blame]

880

},

Bu Sun Kim

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

[diff] [blame^]

881

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

882

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

883

# valid values for uri are:

884

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

885

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

886

# URL length is 2083 characters after encoding.

Bu Sun Kim

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

[diff] [blame]

887

},

Bu Sun Kim

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

[diff] [blame^]

888

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

889

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

890

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

891

#

892

# Note that some time zones include a provision for

893

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

894

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

895

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

896

# as GMT).

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

902

<pre>Deletes a job.

903

904

Args:

Dan O'Meara

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

[diff] [blame]

905

Bu Sun Kim

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

[diff] [blame]

906

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

907

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

914

915

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

916

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

917

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

918

#

919

# service Foo {

920

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

921

# }

922

#

923

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

}</pre>

</div>

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

929

<pre>Gets a job.

930

931

Args:

Dan O'Meara

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

[diff] [blame]

932

Bu Sun Kim

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

[diff] [blame]

933

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

934

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

941

942

{ # Configuration for a job.

943

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

Bu Sun Kim

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

[diff] [blame]

944

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

945

# UpdateJob.

946

#

947

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

948

# more than 500 characters.

949

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

950

# of an HTTP request via an http_method such

951

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

952

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

953

# considered an App Engine system error instead of an application

954

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

955

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

956

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

957

# deadline, constitutes a failed attempt.

Bu Sun Kim

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

[diff] [blame]

958

"headers": { # HTTP request headers.

959

#

960

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

961

# when the job is created.

962

#

963

# Cloud Scheduler sets some headers to default values:

964

#

965

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

966

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

967

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

968

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

969

# modified `User-Agent`.

970

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

971

#

972

# If the job has an body, Cloud Scheduler sets

973

# the following headers:

974

#

975

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

976

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

977

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

978

# created.

979

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

980

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

981

# output only. It cannot be changed.

982

#

983

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

984

#

985

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

986

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

987

#

988

# In addition, some App Engine headers, which contain

989

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

990

"a_key": "A String",

991

},

992

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

993

#

994

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

995

# [An Overview of App

996

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

997

# [Microservices Architecture on Google App

998

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

999

# [App Engine Standard request

1000

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

1001

# and [App Engine Flex request

1002

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

Bu Sun Kim

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

[diff] [blame^]

1003

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

1004

#

1005

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

1006

# service when the job is attempted.

1007

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

1008

#

1009

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

1010

# the job is attempted.

1011

#

1012

# Requests can only be sent to a specific instance if

1013

# [manual scaling is used in App Engine

1014

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

1015

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

1016

# [App Engine Standard request

1017

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

1018

# and [App Engine Flex request

1019

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

1020

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

1021

#

1022

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

1023

# version when the job is attempted.

1024

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

1025

#

1026

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

1027

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

1028

#

1029

# The host is constructed as:

1030

#

1031

#

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

#

1041

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

1042

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

1043

# job's project ID.

1044

#

1045

# * `service =` service

1046

#

1047

# * `version =` version

1048

#

1049

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1054

#

1055

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

1070

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

1071

#

1072

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

1073

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

1074

#

1075

# If instance is empty, then the job will be

1076

# 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

1081

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

Bu Sun Kim

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

[diff] [blame]

1082

},

Bu Sun Kim

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

[diff] [blame^]

1083

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

1084

# permitted.

1085

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

1086

#

1087

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

1088

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

1089

# job with an incompatible HttpMethod.

1090

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

1091

#

1092

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

1093

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

1094

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

1095

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

Bu Sun Kim

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

[diff] [blame]

1096

},

1097

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

1098

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

1099

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

1100

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

1101

#

1102

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

1103

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

Bu Sun Kim

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

[diff] [blame]

1104

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

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

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

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

# message types for APIs to use.

1109

{

Bu Sun Kim

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

[diff] [blame]

1110

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

Bu Sun Kim

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

[diff] [blame]

1111

},

1112

],

Bu Sun Kim

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

[diff] [blame^]

1113

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

1114

},

Bu Sun Kim

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

[diff] [blame]

1115

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

1116

#

Bu Sun Kim

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

[diff] [blame]

1117

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

1118

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

1119

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

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

[diff] [blame^]

1120

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

1121

#

1122

# A job's retry interval starts at

1123

# min_backoff_duration, then doubles

1124

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

1125

# retries at intervals of

1126

# max_backoff_duration up to

1127

# retry_count times.

1128

#

1129

# For example, if min_backoff_duration is

1130

# 10s, max_backoff_duration is 300s, and

1131

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

1132

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

1133

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

1134

# max_backoff_duration until the job has

1135

# been attempted retry_count times. Thus, the

1136

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

1137

#

1138

# The default value of this field is 5.

1139

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

1140

# it fails.

1141

#

1142

# The default value of this field is 5 seconds.

1143

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

1144

# it fails.

1145

#

1146

# The default value of this field is 1 hour.

Bu Sun Kim

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

[diff] [blame]

1147

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

1148

# execution was first attempted. If specified with

1149

# retry_count, the job will be retried until both

1150

# limits are reached.

1151

#

1152

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

1153

# duration is unlimited.

1154

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

1155

# exponential backoff procedure described by

1156

# max_doublings.

1157

#

1158

# The default value of retry_count is zero.

1159

#

1160

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

1161

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

1162

# next scheduled execution time.

1163

#

1164

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

1165

# will retry failed attempts, using exponential backoff,

1166

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

1167

# whichever comes first.

1168

#

1169

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

Bu Sun Kim

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

[diff] [blame]

1170

},

1171

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

1172

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

1173

# which it becomes output only.

1174

#

1175

# The job name. For example:

1176

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

1177

#

1178

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

1179

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

1180

# For more information, see

1181

# [Identifying

1182

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

1183

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

1184

# The list of available locations can be obtained by calling

1185

# ListLocations.

1186

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

1187

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

1188

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

1189

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

1190

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

1191

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

1192

# according to the schedule.

Bu Sun Kim

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

[diff] [blame^]

1193

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

Bu Sun Kim

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

[diff] [blame]

1194

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

Bu Sun Kim

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

[diff] [blame]

1195

#

1196

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

1197

#

1198

# The schedule can be either of the following types:

1199

#

1200

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

1201

# * English-like

1202

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

1203

#

1204

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

1205

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

1206

# allow two simultaneously outstanding executions. For example,

1207

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

1208

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

1209

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

1210

# A scheduled start time will be delayed if the previous

1211

# execution has not ended when its scheduled time occurs.

1212

#

Dan O'Meara

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

[diff] [blame]

1213

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

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

[diff] [blame]

1214

# the job will be tried a total of retry_count

1215

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

1216

# time.

Bu Sun Kim

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

[diff] [blame]

1217

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

1218

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

1219

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

1220

# execution logs. Cloud Scheduler will retry the job according

1221

# to the RetryConfig.

1222

#

1223

# The allowed duration for this deadline is:

1224

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

1225

# * For App Engine HTTP targets, between 15

1226

# seconds and 24 hours.

Bu Sun Kim

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

[diff] [blame^]

1227

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

1228

# the given Pub/Sub topic.

1229

"attributes": { # Attributes for PubsubMessage.

1230

#

1231

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

# attribute.

"a_key": "A String",

},

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

1236

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

1237

# same format as required by PubSub's

1238

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

1239

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

1240

#

1241

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

1242

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

1243

#

1244

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

1245

# attribute.

1246

},

Bu Sun Kim

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

[diff] [blame]

1247

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

1248

# an HTTP request via an http_method such as HTTP

1249

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

1250

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

1251

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

1252

# returned by the redirected request is considered.

Bu Sun Kim

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

[diff] [blame]

1253

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

1254

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

1255

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

1256

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

Bu Sun Kim

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

[diff] [blame]

1257

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

Bu Sun Kim

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

[diff] [blame]

1258

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

1259

# will be ignored or replaced is below:

1260

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

1261

# uri.

1262

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

Bu Sun Kim

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

[diff] [blame]

1263

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

Bu Sun Kim

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

[diff] [blame]

1264

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

1265

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

1266

#

1267

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

Bu Sun Kim

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

[diff] [blame]

1268

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1269

},

Bu Sun Kim

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

[diff] [blame]

1270

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

Bu Sun Kim

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

[diff] [blame]

1271

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

1272

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

1273

# HTTP request.

1274

#

1275

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

1276

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

1277

# yourself.

1278

# [OpenID Connect

1279

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

1280

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

1281

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

1282

# yourself.

Bu Sun Kim

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

[diff] [blame]

1283

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

Bu Sun Kim

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

[diff] [blame]

1284

# specified in target will be used.

Bu Sun Kim

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

[diff] [blame]

1285

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

1286

# to be used for generating OIDC token.

1287

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

1288

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

1289

},

Bu Sun Kim

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

[diff] [blame^]

1290

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

1291

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

1292

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

1293

# incompatible HttpMethod.

1294

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

1295

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

1296

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

1297

# request.

Bu Sun Kim

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

[diff] [blame]

1298

#

Bu Sun Kim

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

[diff] [blame^]

1299

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

1300

# Google APIs hosted on *.googleapis.com.

1301

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

1302

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

1303

# APIs hosted on *.googleapis.com.

1304

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

1305

# to be used for generating OAuth token.

1306

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

1307

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

1308

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

1309

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

1310

# will be used.

Bu Sun Kim

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

[diff] [blame]

1311

},

Bu Sun Kim

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

[diff] [blame^]

1312

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

1313

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

1314

# valid values for uri are:

1315

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

1316

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

1317

# URL length is 2083 characters after encoding.

Bu Sun Kim

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

[diff] [blame]

1318

},

Bu Sun Kim

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

[diff] [blame^]

1319

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

1320

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

1321

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

1322

#

1323

# Note that some time zones include a provision for

1324

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

1325

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

1326

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

1327

# as GMT).

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1332

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

Bu Sun Kim

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

[diff] [blame]

1333

<pre>Lists jobs.

1334

1335

Args:

Dan O'Meara

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

[diff] [blame]

1336

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

Bu Sun Kim

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

[diff] [blame]

1337

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

1338

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

1339

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

1340

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

1341

next_page_token returned from

1342

the previous call to ListJobs. It is an error to

1343

switch the value of filter or

1344

order_by while iterating through pages.

Bu Sun Kim

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

[diff] [blame]

1345

pageSize: integer, Requested page size.

1346

1347

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

1348

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

1349

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

1350

jobs exist.

Bu Sun Kim

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

[diff] [blame]

1351

x__xgafv: string, V1 error format.

1352

Allowed values

1353

1 - v1 error format

1354

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

1355

1356

Returns:

1357

An object of the form:

1358

1359

{ # Response message for listing jobs using ListJobs.

Bu Sun Kim

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

[diff] [blame]

1360

"jobs": [ # The list of jobs.

Bu Sun Kim

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

[diff] [blame]

1361

{ # Configuration for a job.

1362

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

Bu Sun Kim

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

[diff] [blame]

1363

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

1364

# UpdateJob.

1365

#

1366

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

1367

# more than 500 characters.

1368

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

1369

# of an HTTP request via an http_method such

1370

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

1371

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

1372

# considered an App Engine system error instead of an application

1373

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

1374

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

1375

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

1376

# deadline, constitutes a failed attempt.

Bu Sun Kim

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

[diff] [blame]

1377

"headers": { # HTTP request headers.

1378

#

1379

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

1380

# when the job is created.

1381

#

1382

# Cloud Scheduler sets some headers to default values:

1383

#

1384

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

1385

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

1386

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

1387

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

1388

# modified `User-Agent`.

1389

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

1390

#

1391

# If the job has an body, Cloud Scheduler sets

1392

# the following headers:

1393

#

1394

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

1395

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

1396

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

1397

# created.

1398

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

1399

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

1400

# output only. It cannot be changed.

1401

#

1402

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

1403

#

1404

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

1405

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

1406

#

1407

# In addition, some App Engine headers, which contain

1408

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

1409

"a_key": "A String",

1410

},

1411

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

1412

#

1413

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

1414

# [An Overview of App

1415

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

1416

# [Microservices Architecture on Google App

1417

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

1418

# [App Engine Standard request

1419

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

1420

# and [App Engine Flex request

1421

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

Bu Sun Kim

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

[diff] [blame^]

1422

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

1423

#

1424

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

1425

# service when the job is attempted.

1426

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

1427

#

1428

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

1429

# the job is attempted.

1430

#

1431

# Requests can only be sent to a specific instance if

1432

# [manual scaling is used in App Engine

1433

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

1434

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

1435

# [App Engine Standard request

1436

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

1437

# and [App Engine Flex request

1438

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

1439

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

1440

#

1441

# By default, the job is sent to the version which is the default

1442

# version when the job is attempted.

1443

"host": "A String", # Output only. The host that the job is sent to.

1444

#

1445

# For more information about how App Engine requests are routed, see

1446

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1447

#

1448

# The host is constructed as:

1449

#

1450

#

1451

# * `host = [application_domain_name]`</br>

1452

# `| [service] + '.' + [application_domain_name]`</br>

1453

# `| [version] + '.' + [application_domain_name]`</br>

1454

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1455

# `| [instance] + '.' + [application_domain_name]`</br>

1456

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1457

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1458

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1459

#

1460

# * `application_domain_name` = The domain name of the app, for

1461

# example <app-id>.appspot.com, which is associated with the

1462

# job's project ID.

1463

#

1464

# * `service =` service

1465

#

1466

# * `version =` version

1467

#

1468

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1473

#

1474

# * `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

1489

# to the service which is the default service when the job is attempted.

1490

#

1491

# If version is empty, then the job will be sent

1492

# to the version which is the default version when the job is attempted.

1493

#

1494

# If instance is empty, then the job will be

1495

# 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

1500

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1501

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1502

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

1503

# permitted.

1504

"body": "A String", # Body.

1505

#

1506

# HTTP request body. A request body is allowed only if the HTTP method is

1507

# POST or PUT. It will result in invalid argument error to set a body on a

1508

# job with an incompatible HttpMethod.

1509

"relativeUri": "A String", # The relative URI.

1510

#

1511

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

1512

# It can contain a path, query string arguments, and `#` fragments.

1513

# If the relative URL is empty, then the root path "/" will be used.

1514

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1515

},

1516

"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]

1517

# different programming environments, including REST APIs and RPC APIs. It is

1518

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1519

# three pieces of data: error code, error message, and error details.

1520

#

1521

# You can find out more about this error model and how to work with it in the

1522

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1523

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1524

# user-facing error message should be localized and sent in the

1525

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1526

"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]

1527

# message types for APIs to use.

1528

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1529

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1530

},

1531

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1532

"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]

1533

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

"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]

1535

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1536

# By default, if a job does not complete successfully (meaning that

1537

# an acknowledgement is not received from the handler, then it will be retried

1538

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1539

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

1540

#

1541

# A job's retry interval starts at

1542

# min_backoff_duration, then doubles

1543

# `max_doublings` times, then increases linearly, and finally

1544

# retries at intervals of

1545

# max_backoff_duration up to

1546

# retry_count times.

1547

#

1548

# For example, if min_backoff_duration is

1549

# 10s, max_backoff_duration is 300s, and

1550

# `max_doublings` is 3, then the a job will first be retried in 10s. The

1551

# retry interval will double three times, and then increase linearly by

1552

# 2^3 * 10s. Finally, the job will retry at intervals of

1553

# max_backoff_duration until the job has

1554

# been attempted retry_count times. Thus, the

1555

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

1556

#

1557

# The default value of this field is 5.

1558

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

1559

# it fails.

1560

#

1561

# The default value of this field is 5 seconds.

1562

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

1563

# it fails.

1564

#

1565

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1566

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

1567

# execution was first attempted. If specified with

1568

# retry_count, the job will be retried until both

1569

# limits are reached.

1570

#

1571

# The default value for max_retry_duration is zero, which means retry

1572

# duration is unlimited.

1573

"retryCount": 42, # The number of attempts that the system will make to run a job using the

1574

# exponential backoff procedure described by

1575

# max_doublings.

1576

#

1577

# The default value of retry_count is zero.

1578

#

1579

# If retry_count is zero, a job attempt will *not* be retried if

1580

# it fails. Instead the Cloud Scheduler system will wait for the

1581

# next scheduled execution time.

1582

#

1583

# If retry_count is set to a non-zero number then Cloud Scheduler

1584

# will retry failed attempts, using exponential backoff,

1585

# retry_count times, or until the next scheduled execution time,

1586

# whichever comes first.

1587

#

1588

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1589

},

1590

"state": "A String", # Output only. State of the job.

1591

"name": "A String", # Optionally caller-specified in CreateJob, after

1592

# which it becomes output only.

1593

#

1594

# The job name. For example:

1595

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1596

#

1597

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1598

# hyphens (-), colons (:), or periods (.).

1599

# For more information, see

1600

# [Identifying

1601

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

1602

# * `LOCATION_ID` is the canonical ID for the job's location.

1603

# The list of available locations can be obtained by calling

1604

# ListLocations.

1605

# For more information, see https://cloud.google.com/about/locations/.

1606

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1607

# hyphens (-), or underscores (_). The maximum length is 500 characters.

1608

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

1609

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

1610

# retry of a previously failed attempt or the next execution time

1611

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1612

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1613

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1614

#

1615

# Describes the schedule on which the job will be executed.

1616

#

1617

# The schedule can be either of the following types:

1618

#

1619

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

1620

# * English-like

1621

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

1622

#

1623

# As a general rule, execution `n + 1` of a job will not begin

1624

# until execution `n` has finished. Cloud Scheduler will never

1625

# allow two simultaneously outstanding executions. For example,

1626

# this implies that if the `n+1`th execution is scheduled to run at

1627

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

1628

# execution will not start until `16:15`.

1629

# A scheduled start time will be delayed if the previous

1630

# execution has not ended when its scheduled time occurs.

1631

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1632

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1633

# the job will be tried a total of retry_count

1634

# times, with exponential backoff, until the next scheduled start

1635

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1636

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

1637

# this deadline then the request is cancelled and the attempt is marked as a

1638

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

1639

# execution logs. Cloud Scheduler will retry the job according

1640

# to the RetryConfig.

1641

#

1642

# The allowed duration for this deadline is:

1643

# * For HTTP targets, between 15 seconds and 30 minutes.

1644

# * For App Engine HTTP targets, between 15

1645

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1646

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

1647

# the given Pub/Sub topic.

1648

"attributes": { # Attributes for PubsubMessage.

1649

#

1650

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

1655

# be published when a job is delivered. The topic name must be in the

1656

# same format as required by PubSub's

1657

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

1658

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

1659

#

1660

# The topic must be in the same project as the Cloud Scheduler job.

1661

"data": "A String", # The message payload for PubsubMessage.

1662

#

1663

# Pubsub message must contain either non-empty data, or at least one

1664

# attribute.

1665

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1666

"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]

1667

# an HTTP request via an http_method such as HTTP

1668

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

1669

# response code in the range [200 - 299]. A failure to receive a response

1670

# constitutes a failed execution. For a redirected request, the response

1671

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1672

"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]

1673

# HTTP request. This map contains the header field names and

1674

# values. Repeated headers are not supported, but a header value can

1675

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1677

# headers will be ignored or replaced. A partial list of headers that

1678

# will be ignored or replaced is below:

1679

# - Host: This will be computed by Cloud Scheduler and derived from

1680

# uri.

1681

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1682

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1683

# * `X-Google-*`: Google internal use only.

1684

# * `X-AppEngine-*`: Google internal use only.

1685

#

1686

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1687

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1688

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1689

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1690

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

1691

# token will be generated and attached as an `Authorization` header in the

1692

# HTTP request.

1693

#

1694

# This type of authorization can be used for many scenarios, including

1695

# calling Cloud Run, or endpoints where you intend to validate the token

1696

# yourself.

1697

# [OpenID Connect

1698

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

1699

# This type of authorization can be used for many scenarios, including

1700

# calling Cloud Run, or endpoints where you intend to validate the token

1701

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1702

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1703

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

"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]

1705

# to be used for generating OIDC token.

1706

# The service account must be within the same project as the job. The caller

1707

# must have iam.serviceAccounts.actAs permission for the service account.

1708

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1709

"httpMethod": "A String", # Which HTTP method to use for the request.

1710

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

1711

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

1712

# incompatible HttpMethod.

1713

"oauthToken": { # Contains information needed for generating an # If specified, an

1714

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

1715

# will be generated and attached as an `Authorization` header in the HTTP

1716

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1717

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1718

# This type of authorization should generally only be used when calling

1719

# Google APIs hosted on *.googleapis.com.

1720

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

1721

# This type of authorization should generally only be used when calling Google

1722

# APIs hosted on *.googleapis.com.

1723

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

1724

# to be used for generating OAuth token.

1725

# The service account must be within the same project as the job. The caller

1726

# must have iam.serviceAccounts.actAs permission for the service account.

1727

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

1728

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

1729

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1730

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1731

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

1732

# must begin with either "http://" or "https://". Some examples of

1733

# valid values for uri are:

1734

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

1735

# encode some characters for safety and compatibility. The maximum allowed

1736

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1737

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1738

"timeZone": "A String", # Specifies the time zone to be used in interpreting

1739

# schedule. The value of this field must be a time

1740

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

1741

#

1742

# Note that some time zones include a provision for

1743

# daylight savings time. The rules for daylight saving time are

1744

# determined by the chosen tz. For UTC use the string "utc". If a

1745

# time zone is not specified, the default will be in UTC (also known

1746

# as GMT).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1747

},

1748

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the

1750

# page_token field in the subsequent call to

1751

# ListJobs to retrieve the next page of results.

1752

# If this is empty it indicates that there are no more results

1753

# through which to paginate.

1754

#

1755

# The page token is valid for only 2 hours.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1761

<pre>Retrieves the next page of results.

1762

1763

Args:

1764

previous_request: The request for the previous page. (required)

1765

previous_response: The response from the request for the previous page. (required)

1766

1767

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1769

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1774

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1775

<pre>Updates a job.

1776

1777

If successful, the updated Job is returned. If the job does

1778

not exist, `NOT_FOUND` is returned.

1779

1780

If UpdateJob does not successfully return, it is possible for the

1781

job to be in an Job.State.UPDATE_FAILED state. A job in this state may

1782

not be executed. If this happens, retry the UpdateJob request

1783

until a successful response is received.

Args:

which it becomes output only.

1788

1789

The job name. For example:

1790

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

1791

1792

* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

1793

hyphens (-), colons (:), or periods (.).

1794

For more information, see

1795

[Identifying

1796

projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1797

* `LOCATION_ID` is the canonical ID for the job's location.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1798

The list of available locations can be obtained by calling

1799

ListLocations.

1800

For more information, see https://cloud.google.com/about/locations/.

1801

* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

1802

hyphens (-), or underscores (_). The maximum length is 500 characters. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1803

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1804

The object takes the form of:

1805

1806

{ # Configuration for a job.

1807

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1808

"description": "A String", # Optionally caller-specified in CreateJob or

1809

# UpdateJob.

1810

#

1811

# A human-readable description for the job. This string must not contain

1812

# more than 500 characters.

1813

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

1814

# of an HTTP request via an http_method such

1815

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

1816

# HTTP response code in the range [200 - 299]. Error 503 is

1817

# considered an App Engine system error instead of an application

1818

# error. Requests returning error 503 will be retried regardless of

1819

# retry configuration and not counted against retry counts. Any other

1820

# response code, or a failure to receive a response before the

1821

# deadline, constitutes a failed attempt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"headers": { # HTTP request headers.

1823

#

1824

# This map contains the header field names and values. Headers can be set

1825

# when the job is created.

1826

#

1827

# Cloud Scheduler sets some headers to default values:

1828

#

1829

# * `User-Agent`: By default, this header is

1830

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

1831

# This header can be modified, but Cloud Scheduler will append

1832

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

1833

# modified `User-Agent`.

1834

# * `X-CloudScheduler`: This header will be set to true.

1835

#

1836

# If the job has an body, Cloud Scheduler sets

1837

# the following headers:

1838

#

1839

# * `Content-Type`: By default, the `Content-Type` header is set to

1840

# `"application/octet-stream"`. The default can be overridden by explictly

1841

# setting `Content-Type` to a particular media type when the job is

1842

# created.

1843

# For example, `Content-Type` can be set to `"application/json"`.

1844

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

1845

# output only. It cannot be changed.

1846

#

1847

# The headers below are output only. They cannot be set or overridden:

1848

#

1849

# * `X-Google-*`: For Google internal use only.

1850

# * `X-AppEngine-*`: For Google internal use only.

1851

#

1852

# In addition, some App Engine headers, which contain

1853

# job-specific information, are also be sent to the job handler.

1854

"a_key": "A String",

1855

},

1856

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

1857

#

1858

# For more information about services, versions, and instances see

1859

# [An Overview of App

1860

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

1861

# [Microservices Architecture on Google App

1862

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

1863

# [App Engine Standard request

1864

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

1865

# and [App Engine Flex request

1866

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1867

"service": "A String", # App service.

1868

#

1869

# By default, the job is sent to the service which is the default

1870

# service when the job is attempted.

1871

"instance": "A String", # App instance.

1872

#

1873

# By default, the job is sent to an instance which is available when

1874

# the job is attempted.

1875

#

1876

# Requests can only be sent to a specific instance if

1877

# [manual scaling is used in App Engine

1878

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

1879

# App Engine Flex does not support instances. For more information, see

1880

# [App Engine Standard request

1881

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

1882

# and [App Engine Flex request

1883

# 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]

1884

"version": "A String", # App version.

1885

#

1886

# By default, the job is sent to the version which is the default

1887

# version when the job is attempted.

1888

"host": "A String", # Output only. The host that the job is sent to.

1889

#

1890

# For more information about how App Engine requests are routed, see

1891

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

1892

#

1893

# The host is constructed as:

1894

#

1895

#

1896

# * `host = [application_domain_name]`</br>

1897

# `| [service] + '.' + [application_domain_name]`</br>

1898

# `| [version] + '.' + [application_domain_name]`</br>

1899

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

1900

# `| [instance] + '.' + [application_domain_name]`</br>

1901

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

1902

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

1903

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

1904

#

1905

# * `application_domain_name` = The domain name of the app, for

1906

# example <app-id>.appspot.com, which is associated with the

1907

# job's project ID.

1908

#

1909

# * `service =` service

1910

#

1911

# * `version =` version

1912

#

1913

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

1918

#

1919

# * `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

1934

# to the service which is the default service when the job is attempted.

1935

#

1936

# If version is empty, then the job will be sent

1937

# to the version which is the default version when the job is attempted.

1938

#

1939

# If instance is empty, then the job will be

1940

# 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

1945

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1946

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1947

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

1948

# permitted.

1949

"body": "A String", # Body.

1950

#

1951

# HTTP request body. A request body is allowed only if the HTTP method is

1952

# POST or PUT. It will result in invalid argument error to set a body on a

1953

# job with an incompatible HttpMethod.

1954

"relativeUri": "A String", # The relative URI.

1955

#

1956

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

1957

# It can contain a path, query string arguments, and `#` fragments.

1958

# If the relative URL is empty, then the root path "/" will be used.

1959

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1960

},

1961

"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]

1962

# different programming environments, including REST APIs and RPC APIs. It is

1963

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

1964

# three pieces of data: error code, error message, and error details.

1965

#

1966

# You can find out more about this error model and how to work with it in the

1967

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1968

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1969

# user-facing error message should be localized and sent in the

1970

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1971

"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]

1972

# message types for APIs to use.

1973

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1974

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1975

},

1976

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1977

"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]

1978

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1979

"retryConfig": { # Settings that determine the retry behavior. # Settings that determine the retry behavior.

1980

#

1981

# By default, if a job does not complete successfully (meaning that

1982

# an acknowledgement is not received from the handler, then it will be retried

1983

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1984

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

1985

#

1986

# A job's retry interval starts at

1987

# min_backoff_duration, then doubles

1988

# `max_doublings` times, then increases linearly, and finally

1989

# retries at intervals of

1990

# max_backoff_duration up to

1991

# retry_count times.

1992

#

1993

# For example, if min_backoff_duration is

1994

# 10s, max_backoff_duration is 300s, and

1995

# `max_doublings` is 3, then the a job will first be retried in 10s. The

1996

# retry interval will double three times, and then increase linearly by

1997

# 2^3 * 10s. Finally, the job will retry at intervals of

1998

# max_backoff_duration until the job has

1999

# been attempted retry_count times. Thus, the

2000

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2001

#

2002

# The default value of this field is 5.

2003

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2004

# it fails.

2005

#

2006

# The default value of this field is 5 seconds.

2007

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2008

# it fails.

2009

#

2010

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2011

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2012

# execution was first attempted. If specified with

2013

# retry_count, the job will be retried until both

2014

# limits are reached.

2015

#

2016

# The default value for max_retry_duration is zero, which means retry

2017

# duration is unlimited.

2018

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2019

# exponential backoff procedure described by

2020

# max_doublings.

2021

#

2022

# The default value of retry_count is zero.

2023

#

2024

# If retry_count is zero, a job attempt will *not* be retried if

2025

# it fails. Instead the Cloud Scheduler system will wait for the

2026

# next scheduled execution time.

2027

#

2028

# If retry_count is set to a non-zero number then Cloud Scheduler

2029

# will retry failed attempts, using exponential backoff,

2030

# retry_count times, or until the next scheduled execution time,

2031

# whichever comes first.

2032

#

2033

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2034

},

2035

"state": "A String", # Output only. State of the job.

2036

"name": "A String", # Optionally caller-specified in CreateJob, after

2037

# which it becomes output only.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2038

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2039

# The job name. For example:

2040

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2041

#

2042

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2043

# hyphens (-), colons (:), or periods (.).

2044

# For more information, see

2045

# [Identifying

2046

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2047

# * `LOCATION_ID` is the canonical ID for the job's location.

2048

# The list of available locations can be obtained by calling

2049

# ListLocations.

2050

# For more information, see https://cloud.google.com/about/locations/.

2051

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2052

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2053

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2054

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2055

# retry of a previously failed attempt or the next execution time

2056

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2057

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2058

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2059

#

2060

# Describes the schedule on which the job will be executed.

2061

#

2062

# The schedule can be either of the following types:

2063

#

2064

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2065

# * English-like

2066

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2067

#

2068

# As a general rule, execution `n + 1` of a job will not begin

2069

# until execution `n` has finished. Cloud Scheduler will never

2070

# allow two simultaneously outstanding executions. For example,

2071

# this implies that if the `n+1`th execution is scheduled to run at

2072

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2073

# execution will not start until `16:15`.

2074

# A scheduled start time will be delayed if the previous

2075

# execution has not ended when its scheduled time occurs.

2076

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2077

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2078

# the job will be tried a total of retry_count

2079

# times, with exponential backoff, until the next scheduled start

2080

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2081

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2082

# this deadline then the request is cancelled and the attempt is marked as a

2083

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2084

# execution logs. Cloud Scheduler will retry the job according

2085

# to the RetryConfig.

2086

#

2087

# The allowed duration for this deadline is:

2088

# * For HTTP targets, between 15 seconds and 30 minutes.

2089

# * For App Engine HTTP targets, between 15

2090

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2091

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

2092

# the given Pub/Sub topic.

2093

"attributes": { # Attributes for PubsubMessage.

2094

#

2095

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

2100

# be published when a job is delivered. The topic name must be in the

2101

# same format as required by PubSub's

2102

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2103

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2104

#

2105

# The topic must be in the same project as the Cloud Scheduler job.

2106

"data": "A String", # The message payload for PubsubMessage.

2107

#

2108

# Pubsub message must contain either non-empty data, or at least one

2109

# attribute.

2110

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2111

"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]

2112

# an HTTP request via an http_method such as HTTP

2113

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2114

# response code in the range [200 - 299]. A failure to receive a response

2115

# constitutes a failed execution. For a redirected request, the response

2116

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2117

"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]

2118

# HTTP request. This map contains the header field names and

2119

# values. Repeated headers are not supported, but a header value can

2120

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2121

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2122

# headers will be ignored or replaced. A partial list of headers that

2123

# will be ignored or replaced is below:

2124

# - Host: This will be computed by Cloud Scheduler and derived from

2125

# uri.

2126

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2127

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2128

# * `X-Google-*`: Google internal use only.

2129

# * `X-AppEngine-*`: Google internal use only.

2130

#

2131

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2133

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2134

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2135

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2136

# token will be generated and attached as an `Authorization` header in the

2137

# HTTP request.

2138

#

2139

# This type of authorization can be used for many scenarios, including

2140

# calling Cloud Run, or endpoints where you intend to validate the token

2141

# yourself.

2142

# [OpenID Connect

2143

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2144

# This type of authorization can be used for many scenarios, including

2145

# calling Cloud Run, or endpoints where you intend to validate the token

2146

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2147

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2148

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2149

"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]

2150

# to be used for generating OIDC token.

2151

# The service account must be within the same project as the job. The caller

2152

# must have iam.serviceAccounts.actAs permission for the service account.

2153

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2154

"httpMethod": "A String", # Which HTTP method to use for the request.

2155

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2156

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2157

# incompatible HttpMethod.

2158

"oauthToken": { # Contains information needed for generating an # If specified, an

2159

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2160

# will be generated and attached as an `Authorization` header in the HTTP

2161

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2162

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2163

# This type of authorization should generally only be used when calling

2164

# Google APIs hosted on *.googleapis.com.

2165

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2166

# This type of authorization should generally only be used when calling Google

2167

# APIs hosted on *.googleapis.com.

2168

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2169

# to be used for generating OAuth token.

2170

# The service account must be within the same project as the job. The caller

2171

# must have iam.serviceAccounts.actAs permission for the service account.

2172

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2173

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2174

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2175

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2176

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2177

# must begin with either "http://" or "https://". Some examples of

2178

# valid values for uri are:

2179

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2180

# encode some characters for safety and compatibility. The maximum allowed

2181

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2182

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2183

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2184

# schedule. The value of this field must be a time

2185

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2186

#

2187

# Note that some time zones include a provision for

2188

# daylight savings time. The rules for daylight saving time are

2189

# determined by the chosen tz. For UTC use the string "utc". If a

2190

# time zone is not specified, the default will be in UTC (also known

2191

# as GMT).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2192

}

2193

2194

updateMask: string, A mask used to specify which fields of the job are being updated.

2195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2202

2203

{ # Configuration for a job.

2204

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2205

"description": "A String", # Optionally caller-specified in CreateJob or

2206

# UpdateJob.

2207

#

2208

# A human-readable description for the job. This string must not contain

2209

# more than 500 characters.

2210

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2211

# of an HTTP request via an http_method such

2212

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2213

# HTTP response code in the range [200 - 299]. Error 503 is

2214

# considered an App Engine system error instead of an application

2215

# error. Requests returning error 503 will be retried regardless of

2216

# retry configuration and not counted against retry counts. Any other

2217

# response code, or a failure to receive a response before the

2218

# deadline, constitutes a failed attempt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2219

"headers": { # HTTP request headers.

2220

#

2221

# This map contains the header field names and values. Headers can be set

2222

# when the job is created.

2223

#

2224

# Cloud Scheduler sets some headers to default values:

2225

#

2226

# * `User-Agent`: By default, this header is

2227

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2228

# This header can be modified, but Cloud Scheduler will append

2229

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2230

# modified `User-Agent`.

2231

# * `X-CloudScheduler`: This header will be set to true.

2232

#

2233

# If the job has an body, Cloud Scheduler sets

2234

# the following headers:

2235

#

2236

# * `Content-Type`: By default, the `Content-Type` header is set to

2237

# `"application/octet-stream"`. The default can be overridden by explictly

2238

# setting `Content-Type` to a particular media type when the job is

2239

# created.

2240

# For example, `Content-Type` can be set to `"application/json"`.

2241

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2242

# output only. It cannot be changed.

2243

#

2244

# The headers below are output only. They cannot be set or overridden:

2245

#

2246

# * `X-Google-*`: For Google internal use only.

2247

# * `X-AppEngine-*`: For Google internal use only.

2248

#

2249

# In addition, some App Engine headers, which contain

2250

# job-specific information, are also be sent to the job handler.

2251

"a_key": "A String",

2252

},

2253

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2254

#

2255

# For more information about services, versions, and instances see

2256

# [An Overview of App

2257

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2258

# [Microservices Architecture on Google App

2259

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2260

# [App Engine Standard request

2261

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2262

# and [App Engine Flex request

2263

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2264

"service": "A String", # App service.

2265

#

2266

# By default, the job is sent to the service which is the default

2267

# service when the job is attempted.

2268

"instance": "A String", # App instance.

2269

#

2270

# By default, the job is sent to an instance which is available when

2271

# the job is attempted.

2272

#

2273

# Requests can only be sent to a specific instance if

2274

# [manual scaling is used in App Engine

2275

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2276

# App Engine Flex does not support instances. For more information, see

2277

# [App Engine Standard request

2278

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2279

# and [App Engine Flex request

2280

# 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]

2281

"version": "A String", # App version.

2282

#

2283

# By default, the job is sent to the version which is the default

2284

# version when the job is attempted.

2285

"host": "A String", # Output only. The host that the job is sent to.

2286

#

2287

# For more information about how App Engine requests are routed, see

2288

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2289

#

2290

# The host is constructed as:

2291

#

2292

#

2293

# * `host = [application_domain_name]`</br>

2294

# `| [service] + '.' + [application_domain_name]`</br>

2295

# `| [version] + '.' + [application_domain_name]`</br>

2296

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2297

# `| [instance] + '.' + [application_domain_name]`</br>

2298

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2299

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2300

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2301

#

2302

# * `application_domain_name` = The domain name of the app, for

2303

# example <app-id>.appspot.com, which is associated with the

2304

# job's project ID.

2305

#

2306

# * `service =` service

2307

#

2308

# * `version =` version

2309

#

2310

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2315

#

2316

# * `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

2331

# to the service which is the default service when the job is attempted.

2332

#

2333

# If version is empty, then the job will be sent

2334

# to the version which is the default version when the job is attempted.

2335

#

2336

# If instance is empty, then the job will be

2337

# 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

2342

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2343

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2344

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2345

# permitted.

2346

"body": "A String", # Body.

2347

#

2348

# HTTP request body. A request body is allowed only if the HTTP method is

2349

# POST or PUT. It will result in invalid argument error to set a body on a

2350

# job with an incompatible HttpMethod.

2351

"relativeUri": "A String", # The relative URI.

2352

#

2353

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2354

# It can contain a path, query string arguments, and `#` fragments.

2355

# If the relative URL is empty, then the root path "/" will be used.

2356

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2357

},

2358

"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]

2359

# different programming environments, including REST APIs and RPC APIs. It is

2360

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2361

# three pieces of data: error code, error message, and error details.

2362

#

2363

# You can find out more about this error model and how to work with it in the

2364

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2365

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2366

# user-facing error message should be localized and sent in the

2367

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2368

"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]

2369

# message types for APIs to use.

2370

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2371

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2372

},

2373

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2374

"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]

2375

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2376

"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]

2377

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2378

# By default, if a job does not complete successfully (meaning that

2379

# an acknowledgement is not received from the handler, then it will be retried

2380

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2381

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2382

#

2383

# A job's retry interval starts at

2384

# min_backoff_duration, then doubles

2385

# `max_doublings` times, then increases linearly, and finally

2386

# retries at intervals of

2387

# max_backoff_duration up to

2388

# retry_count times.

2389

#

2390

# For example, if min_backoff_duration is

2391

# 10s, max_backoff_duration is 300s, and

2392

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2393

# retry interval will double three times, and then increase linearly by

2394

# 2^3 * 10s. Finally, the job will retry at intervals of

2395

# max_backoff_duration until the job has

2396

# been attempted retry_count times. Thus, the

2397

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2398

#

2399

# The default value of this field is 5.

2400

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2401

# it fails.

2402

#

2403

# The default value of this field is 5 seconds.

2404

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2405

# it fails.

2406

#

2407

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2408

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2409

# execution was first attempted. If specified with

2410

# retry_count, the job will be retried until both

2411

# limits are reached.

2412

#

2413

# The default value for max_retry_duration is zero, which means retry

2414

# duration is unlimited.

2415

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2416

# exponential backoff procedure described by

2417

# max_doublings.

2418

#

2419

# The default value of retry_count is zero.

2420

#

2421

# If retry_count is zero, a job attempt will *not* be retried if

2422

# it fails. Instead the Cloud Scheduler system will wait for the

2423

# next scheduled execution time.

2424

#

2425

# If retry_count is set to a non-zero number then Cloud Scheduler

2426

# will retry failed attempts, using exponential backoff,

2427

# retry_count times, or until the next scheduled execution time,

2428

# whichever comes first.

2429

#

2430

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2431

},

2432

"state": "A String", # Output only. State of the job.

2433

"name": "A String", # Optionally caller-specified in CreateJob, after

2434

# which it becomes output only.

2435

#

2436

# The job name. For example:

2437

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2438

#

2439

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2440

# hyphens (-), colons (:), or periods (.).

2441

# For more information, see

2442

# [Identifying

2443

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2444

# * `LOCATION_ID` is the canonical ID for the job's location.

2445

# The list of available locations can be obtained by calling

2446

# ListLocations.

2447

# For more information, see https://cloud.google.com/about/locations/.

2448

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2449

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2450

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2451

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2452

# retry of a previously failed attempt or the next execution time

2453

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2454

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2455

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2456

#

2457

# Describes the schedule on which the job will be executed.

2458

#

2459

# The schedule can be either of the following types:

2460

#

2461

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2462

# * English-like

2463

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2464

#

2465

# As a general rule, execution `n + 1` of a job will not begin

2466

# until execution `n` has finished. Cloud Scheduler will never

2467

# allow two simultaneously outstanding executions. For example,

2468

# this implies that if the `n+1`th execution is scheduled to run at

2469

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2470

# execution will not start until `16:15`.

2471

# A scheduled start time will be delayed if the previous

2472

# execution has not ended when its scheduled time occurs.

2473

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2474

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2475

# the job will be tried a total of retry_count

2476

# times, with exponential backoff, until the next scheduled start

2477

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2478

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2479

# this deadline then the request is cancelled and the attempt is marked as a

2480

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2481

# execution logs. Cloud Scheduler will retry the job according

2482

# to the RetryConfig.

2483

#

2484

# The allowed duration for this deadline is:

2485

# * For HTTP targets, between 15 seconds and 30 minutes.

2486

# * For App Engine HTTP targets, between 15

2487

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2488

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

2489

# the given Pub/Sub topic.

2490

"attributes": { # Attributes for PubsubMessage.

2491

#

2492

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

2497

# be published when a job is delivered. The topic name must be in the

2498

# same format as required by PubSub's

2499

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2500

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2501

#

2502

# The topic must be in the same project as the Cloud Scheduler job.

2503

"data": "A String", # The message payload for PubsubMessage.

2504

#

2505

# Pubsub message must contain either non-empty data, or at least one

2506

# attribute.

2507

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2508

"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]

2509

# an HTTP request via an http_method such as HTTP

2510

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2511

# response code in the range [200 - 299]. A failure to receive a response

2512

# constitutes a failed execution. For a redirected request, the response

2513

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2514

"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]

2515

# HTTP request. This map contains the header field names and

2516

# values. Repeated headers are not supported, but a header value can

2517

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2518

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2519

# headers will be ignored or replaced. A partial list of headers that

2520

# will be ignored or replaced is below:

2521

# - Host: This will be computed by Cloud Scheduler and derived from

2522

# uri.

2523

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2524

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2525

# * `X-Google-*`: Google internal use only.

2526

# * `X-AppEngine-*`: Google internal use only.

2527

#

2528

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2529

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2531

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2532

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2533

# token will be generated and attached as an `Authorization` header in the

2534

# HTTP request.

2535

#

2536

# This type of authorization can be used for many scenarios, including

2537

# calling Cloud Run, or endpoints where you intend to validate the token

2538

# yourself.

2539

# [OpenID Connect

2540

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2541

# This type of authorization can be used for many scenarios, including

2542

# calling Cloud Run, or endpoints where you intend to validate the token

2543

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2544

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2545

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2546

"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]

2547

# to be used for generating OIDC token.

2548

# The service account must be within the same project as the job. The caller

2549

# must have iam.serviceAccounts.actAs permission for the service account.

2550

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2551

"httpMethod": "A String", # Which HTTP method to use for the request.

2552

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2553

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2554

# incompatible HttpMethod.

2555

"oauthToken": { # Contains information needed for generating an # If specified, an

2556

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2557

# will be generated and attached as an `Authorization` header in the HTTP

2558

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2559

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2560

# This type of authorization should generally only be used when calling

2561

# Google APIs hosted on *.googleapis.com.

2562

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2563

# This type of authorization should generally only be used when calling Google

2564

# APIs hosted on *.googleapis.com.

2565

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2566

# to be used for generating OAuth token.

2567

# The service account must be within the same project as the job. The caller

2568

# must have iam.serviceAccounts.actAs permission for the service account.

2569

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2570

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2571

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2572

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2573

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2574

# must begin with either "http://" or "https://". Some examples of

2575

# valid values for uri are:

2576

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2577

# encode some characters for safety and compatibility. The maximum allowed

2578

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2579

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2580

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2581

# schedule. The value of this field must be a time

2582

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2583

#

2584

# Note that some time zones include a provision for

2585

# daylight savings time. The rules for daylight saving time are

2586

# determined by the chosen tz. For UTC use the string "utc". If a

2587

# time zone is not specified, the default will be in UTC (also known

2588

# as GMT).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code>

2594

<pre>Pauses a job.

2595

2596

If a job is paused then the system will stop executing the job

2597

until it is re-enabled via ResumeJob. The

2598

state of the job is stored in state; if paused it

2599

will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED

2600

to be paused.

2601

2602

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2603

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2604

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

2605

body: object, The request body.

2606

The object takes the form of:

2607

2608

{ # Request message for PauseJob.

2609

}

2610

2611

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2618

2619

{ # Configuration for a job.

2620

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2621

"description": "A String", # Optionally caller-specified in CreateJob or

2622

# UpdateJob.

2623

#

2624

# A human-readable description for the job. This string must not contain

2625

# more than 500 characters.

2626

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

2627

# of an HTTP request via an http_method such

2628

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

2629

# HTTP response code in the range [200 - 299]. Error 503 is

2630

# considered an App Engine system error instead of an application

2631

# error. Requests returning error 503 will be retried regardless of

2632

# retry configuration and not counted against retry counts. Any other

2633

# response code, or a failure to receive a response before the

2634

# deadline, constitutes a failed attempt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2635

"headers": { # HTTP request headers.

2636

#

2637

# This map contains the header field names and values. Headers can be set

2638

# when the job is created.

2639

#

2640

# Cloud Scheduler sets some headers to default values:

2641

#

2642

# * `User-Agent`: By default, this header is

2643

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

2644

# This header can be modified, but Cloud Scheduler will append

2645

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

2646

# modified `User-Agent`.

2647

# * `X-CloudScheduler`: This header will be set to true.

2648

#

2649

# If the job has an body, Cloud Scheduler sets

2650

# the following headers:

2651

#

2652

# * `Content-Type`: By default, the `Content-Type` header is set to

2653

# `"application/octet-stream"`. The default can be overridden by explictly

2654

# setting `Content-Type` to a particular media type when the job is

2655

# created.

2656

# For example, `Content-Type` can be set to `"application/json"`.

2657

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

2658

# output only. It cannot be changed.

2659

#

2660

# The headers below are output only. They cannot be set or overridden:

2661

#

2662

# * `X-Google-*`: For Google internal use only.

2663

# * `X-AppEngine-*`: For Google internal use only.

2664

#

2665

# In addition, some App Engine headers, which contain

2666

# job-specific information, are also be sent to the job handler.

2667

"a_key": "A String",

2668

},

2669

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

2670

#

2671

# For more information about services, versions, and instances see

2672

# [An Overview of App

2673

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

2674

# [Microservices Architecture on Google App

2675

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

2676

# [App Engine Standard request

2677

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

2678

# and [App Engine Flex request

2679

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2680

"service": "A String", # App service.

2681

#

2682

# By default, the job is sent to the service which is the default

2683

# service when the job is attempted.

2684

"instance": "A String", # App instance.

2685

#

2686

# By default, the job is sent to an instance which is available when

2687

# the job is attempted.

2688

#

2689

# Requests can only be sent to a specific instance if

2690

# [manual scaling is used in App Engine

2691

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

2692

# App Engine Flex does not support instances. For more information, see

2693

# [App Engine Standard request

2694

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

2695

# and [App Engine Flex request

2696

# 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]

2697

"version": "A String", # App version.

2698

#

2699

# By default, the job is sent to the version which is the default

2700

# version when the job is attempted.

2701

"host": "A String", # Output only. The host that the job is sent to.

2702

#

2703

# For more information about how App Engine requests are routed, see

2704

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

2705

#

2706

# The host is constructed as:

2707

#

2708

#

2709

# * `host = [application_domain_name]`</br>

2710

# `| [service] + '.' + [application_domain_name]`</br>

2711

# `| [version] + '.' + [application_domain_name]`</br>

2712

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

2713

# `| [instance] + '.' + [application_domain_name]`</br>

2714

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

2715

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

2716

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

2717

#

2718

# * `application_domain_name` = The domain name of the app, for

2719

# example <app-id>.appspot.com, which is associated with the

2720

# job's project ID.

2721

#

2722

# * `service =` service

2723

#

2724

# * `version =` version

2725

#

2726

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

2731

#

2732

# * `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

2747

# to the service which is the default service when the job is attempted.

2748

#

2749

# If version is empty, then the job will be sent

2750

# to the version which is the default version when the job is attempted.

2751

#

2752

# If instance is empty, then the job will be

2753

# 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

2758

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2759

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2760

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

2761

# permitted.

2762

"body": "A String", # Body.

2763

#

2764

# HTTP request body. A request body is allowed only if the HTTP method is

2765

# POST or PUT. It will result in invalid argument error to set a body on a

2766

# job with an incompatible HttpMethod.

2767

"relativeUri": "A String", # The relative URI.

2768

#

2769

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

2770

# It can contain a path, query string arguments, and `#` fragments.

2771

# If the relative URL is empty, then the root path "/" will be used.

2772

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2773

},

2774

"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]

2775

# different programming environments, including REST APIs and RPC APIs. It is

2776

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

2777

# three pieces of data: error code, error message, and error details.

2778

#

2779

# You can find out more about this error model and how to work with it in the

2780

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2781

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2782

# user-facing error message should be localized and sent in the

2783

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

"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]

2785

# message types for APIs to use.

2786

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2787

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2788

},

2789

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2790

"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]

2791

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2792

"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]

2793

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2794

# By default, if a job does not complete successfully (meaning that

2795

# an acknowledgement is not received from the handler, then it will be retried

2796

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2797

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

2798

#

2799

# A job's retry interval starts at

2800

# min_backoff_duration, then doubles

2801

# `max_doublings` times, then increases linearly, and finally

2802

# retries at intervals of

2803

# max_backoff_duration up to

2804

# retry_count times.

2805

#

2806

# For example, if min_backoff_duration is

2807

# 10s, max_backoff_duration is 300s, and

2808

# `max_doublings` is 3, then the a job will first be retried in 10s. The

2809

# retry interval will double three times, and then increase linearly by

2810

# 2^3 * 10s. Finally, the job will retry at intervals of

2811

# max_backoff_duration until the job has

2812

# been attempted retry_count times. Thus, the

2813

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

2814

#

2815

# The default value of this field is 5.

2816

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

2817

# it fails.

2818

#

2819

# The default value of this field is 5 seconds.

2820

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

2821

# it fails.

2822

#

2823

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2824

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

2825

# execution was first attempted. If specified with

2826

# retry_count, the job will be retried until both

2827

# limits are reached.

2828

#

2829

# The default value for max_retry_duration is zero, which means retry

2830

# duration is unlimited.

2831

"retryCount": 42, # The number of attempts that the system will make to run a job using the

2832

# exponential backoff procedure described by

2833

# max_doublings.

2834

#

2835

# The default value of retry_count is zero.

2836

#

2837

# If retry_count is zero, a job attempt will *not* be retried if

2838

# it fails. Instead the Cloud Scheduler system will wait for the

2839

# next scheduled execution time.

2840

#

2841

# If retry_count is set to a non-zero number then Cloud Scheduler

2842

# will retry failed attempts, using exponential backoff,

2843

# retry_count times, or until the next scheduled execution time,

2844

# whichever comes first.

2845

#

2846

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2847

},

2848

"state": "A String", # Output only. State of the job.

2849

"name": "A String", # Optionally caller-specified in CreateJob, after

2850

# which it becomes output only.

2851

#

2852

# The job name. For example:

2853

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

2854

#

2855

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

2856

# hyphens (-), colons (:), or periods (.).

2857

# For more information, see

2858

# [Identifying

2859

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

2860

# * `LOCATION_ID` is the canonical ID for the job's location.

2861

# The list of available locations can be obtained by calling

2862

# ListLocations.

2863

# For more information, see https://cloud.google.com/about/locations/.

2864

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

2865

# hyphens (-), or underscores (_). The maximum length is 500 characters.

2866

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

2867

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

2868

# retry of a previously failed attempt or the next execution time

2869

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2870

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2871

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2872

#

2873

# Describes the schedule on which the job will be executed.

2874

#

2875

# The schedule can be either of the following types:

2876

#

2877

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

2878

# * English-like

2879

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

2880

#

2881

# As a general rule, execution `n + 1` of a job will not begin

2882

# until execution `n` has finished. Cloud Scheduler will never

2883

# allow two simultaneously outstanding executions. For example,

2884

# this implies that if the `n+1`th execution is scheduled to run at

2885

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

2886

# execution will not start until `16:15`.

2887

# A scheduled start time will be delayed if the previous

2888

# execution has not ended when its scheduled time occurs.

2889

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2890

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2891

# the job will be tried a total of retry_count

2892

# times, with exponential backoff, until the next scheduled start

2893

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2894

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

2895

# this deadline then the request is cancelled and the attempt is marked as a

2896

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

2897

# execution logs. Cloud Scheduler will retry the job according

2898

# to the RetryConfig.

2899

#

2900

# The allowed duration for this deadline is:

2901

# * For HTTP targets, between 15 seconds and 30 minutes.

2902

# * For App Engine HTTP targets, between 15

2903

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2904

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

2905

# the given Pub/Sub topic.

2906

"attributes": { # Attributes for PubsubMessage.

2907

#

2908

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

2913

# be published when a job is delivered. The topic name must be in the

2914

# same format as required by PubSub's

2915

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

2916

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

2917

#

2918

# The topic must be in the same project as the Cloud Scheduler job.

2919

"data": "A String", # The message payload for PubsubMessage.

2920

#

2921

# Pubsub message must contain either non-empty data, or at least one

2922

# attribute.

2923

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2924

"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]

2925

# an HTTP request via an http_method such as HTTP

2926

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

2927

# response code in the range [200 - 299]. A failure to receive a response

2928

# constitutes a failed execution. For a redirected request, the response

2929

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2930

"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]

2931

# HTTP request. This map contains the header field names and

2932

# values. Repeated headers are not supported, but a header value can

2933

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2934

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2935

# headers will be ignored or replaced. A partial list of headers that

2936

# will be ignored or replaced is below:

2937

# - Host: This will be computed by Cloud Scheduler and derived from

2938

# uri.

2939

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2940

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2941

# * `X-Google-*`: Google internal use only.

2942

# * `X-AppEngine-*`: Google internal use only.

2943

#

2944

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2945

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2946

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2947

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2948

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

2949

# token will be generated and attached as an `Authorization` header in the

2950

# HTTP request.

2951

#

2952

# This type of authorization can be used for many scenarios, including

2953

# calling Cloud Run, or endpoints where you intend to validate the token

2954

# yourself.

2955

# [OpenID Connect

2956

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

2957

# This type of authorization can be used for many scenarios, including

2958

# calling Cloud Run, or endpoints where you intend to validate the token

2959

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2960

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2961

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2962

"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]

2963

# to be used for generating OIDC token.

2964

# The service account must be within the same project as the job. The caller

2965

# must have iam.serviceAccounts.actAs permission for the service account.

2966

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2967

"httpMethod": "A String", # Which HTTP method to use for the request.

2968

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

2969

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

2970

# incompatible HttpMethod.

2971

"oauthToken": { # Contains information needed for generating an # If specified, an

2972

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

2973

# will be generated and attached as an `Authorization` header in the HTTP

2974

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2975

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2976

# This type of authorization should generally only be used when calling

2977

# Google APIs hosted on *.googleapis.com.

2978

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

2979

# This type of authorization should generally only be used when calling Google

2980

# APIs hosted on *.googleapis.com.

2981

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

2982

# to be used for generating OAuth token.

2983

# The service account must be within the same project as the job. The caller

2984

# must have iam.serviceAccounts.actAs permission for the service account.

2985

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

2986

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

2987

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2988

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2989

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

2990

# must begin with either "http://" or "https://". Some examples of

2991

# valid values for uri are:

2992

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

2993

# encode some characters for safety and compatibility. The maximum allowed

2994

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2995

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2996

"timeZone": "A String", # Specifies the time zone to be used in interpreting

2997

# schedule. The value of this field must be a time

2998

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

2999

#

3000

# Note that some time zones include a provision for

3001

# daylight savings time. The rules for daylight saving time are

3002

# determined by the chosen tz. For UTC use the string "utc". If a

3003

# time zone is not specified, the default will be in UTC (also known

3004

# as GMT).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>

3010

<pre>Resume a job.

3011

3012

This method reenables a job after it has been Job.State.PAUSED. The

3013

state of a job is stored in Job.state; after calling this method it

3014

will be set to Job.State.ENABLED. A job must be in

3015

Job.State.PAUSED to be resumed.

3016

3017

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3018

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3019

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3020

body: object, The request body.

3021

The object takes the form of:

3022

3023

{ # Request message for ResumeJob.

3024

}

3025

3026

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3033

3034

{ # Configuration for a job.

3035

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

"description": "A String", # Optionally caller-specified in CreateJob or

3037

# UpdateJob.

3038

#

3039

# A human-readable description for the job. This string must not contain

3040

# more than 500 characters.

3041

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3042

# of an HTTP request via an http_method such

3043

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3044

# HTTP response code in the range [200 - 299]. Error 503 is

3045

# considered an App Engine system error instead of an application

3046

# error. Requests returning error 503 will be retried regardless of

3047

# retry configuration and not counted against retry counts. Any other

3048

# response code, or a failure to receive a response before the

3049

# deadline, constitutes a failed attempt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3050

"headers": { # HTTP request headers.

3051

#

3052

# This map contains the header field names and values. Headers can be set

3053

# when the job is created.

3054

#

3055

# Cloud Scheduler sets some headers to default values:

3056

#

3057

# * `User-Agent`: By default, this header is

3058

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3059

# This header can be modified, but Cloud Scheduler will append

3060

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3061

# modified `User-Agent`.

3062

# * `X-CloudScheduler`: This header will be set to true.

3063

#

3064

# If the job has an body, Cloud Scheduler sets

3065

# the following headers:

3066

#

3067

# * `Content-Type`: By default, the `Content-Type` header is set to

3068

# `"application/octet-stream"`. The default can be overridden by explictly

3069

# setting `Content-Type` to a particular media type when the job is

3070

# created.

3071

# For example, `Content-Type` can be set to `"application/json"`.

3072

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3073

# output only. It cannot be changed.

3074

#

3075

# The headers below are output only. They cannot be set or overridden:

3076

#

3077

# * `X-Google-*`: For Google internal use only.

3078

# * `X-AppEngine-*`: For Google internal use only.

3079

#

3080

# In addition, some App Engine headers, which contain

3081

# job-specific information, are also be sent to the job handler.

3082

"a_key": "A String",

3083

},

3084

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3085

#

3086

# For more information about services, versions, and instances see

3087

# [An Overview of App

3088

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3089

# [Microservices Architecture on Google App

3090

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3091

# [App Engine Standard request

3092

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3093

# and [App Engine Flex request

3094

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3095

"service": "A String", # App service.

3096

#

3097

# By default, the job is sent to the service which is the default

3098

# service when the job is attempted.

3099

"instance": "A String", # App instance.

3100

#

3101

# By default, the job is sent to an instance which is available when

3102

# the job is attempted.

3103

#

3104

# Requests can only be sent to a specific instance if

3105

# [manual scaling is used in App Engine

3106

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3107

# App Engine Flex does not support instances. For more information, see

3108

# [App Engine Standard request

3109

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3110

# and [App Engine Flex request

3111

# 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]

3112

"version": "A String", # App version.

3113

#

3114

# By default, the job is sent to the version which is the default

3115

# version when the job is attempted.

3116

"host": "A String", # Output only. The host that the job is sent to.

3117

#

3118

# For more information about how App Engine requests are routed, see

3119

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3120

#

3121

# The host is constructed as:

3122

#

3123

#

3124

# * `host = [application_domain_name]`</br>

3125

# `| [service] + '.' + [application_domain_name]`</br>

3126

# `| [version] + '.' + [application_domain_name]`</br>

3127

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3128

# `| [instance] + '.' + [application_domain_name]`</br>

3129

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3130

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3131

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3132

#

3133

# * `application_domain_name` = The domain name of the app, for

3134

# example <app-id>.appspot.com, which is associated with the

3135

# job's project ID.

3136

#

3137

# * `service =` service

3138

#

3139

# * `version =` version

3140

#

3141

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3146

#

3147

# * `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

3162

# to the service which is the default service when the job is attempted.

3163

#

3164

# If version is empty, then the job will be sent

3165

# to the version which is the default version when the job is attempted.

3166

#

3167

# If instance is empty, then the job will be

3168

# 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

3173

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3174

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3175

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3176

# permitted.

3177

"body": "A String", # Body.

3178

#

3179

# HTTP request body. A request body is allowed only if the HTTP method is

3180

# POST or PUT. It will result in invalid argument error to set a body on a

3181

# job with an incompatible HttpMethod.

3182

"relativeUri": "A String", # The relative URI.

3183

#

3184

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3185

# It can contain a path, query string arguments, and `#` fragments.

3186

# If the relative URL is empty, then the root path "/" will be used.

3187

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3188

},

3189

"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]

3190

# different programming environments, including REST APIs and RPC APIs. It is

3191

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3192

# three pieces of data: error code, error message, and error details.

3193

#

3194

# You can find out more about this error model and how to work with it in the

3195

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3197

# user-facing error message should be localized and sent in the

3198

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3199

"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]

3200

# message types for APIs to use.

3201

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3202

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3203

},

3204

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3205

"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]

3206

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3207

"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]

3208

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3209

# By default, if a job does not complete successfully (meaning that

3210

# an acknowledgement is not received from the handler, then it will be retried

3211

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3212

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3213

#

3214

# A job's retry interval starts at

3215

# min_backoff_duration, then doubles

3216

# `max_doublings` times, then increases linearly, and finally

3217

# retries at intervals of

3218

# max_backoff_duration up to

3219

# retry_count times.

3220

#

3221

# For example, if min_backoff_duration is

3222

# 10s, max_backoff_duration is 300s, and

3223

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3224

# retry interval will double three times, and then increase linearly by

3225

# 2^3 * 10s. Finally, the job will retry at intervals of

3226

# max_backoff_duration until the job has

3227

# been attempted retry_count times. Thus, the

3228

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3229

#

3230

# The default value of this field is 5.

3231

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3232

# it fails.

3233

#

3234

# The default value of this field is 5 seconds.

3235

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3236

# it fails.

3237

#

3238

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3239

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3240

# execution was first attempted. If specified with

3241

# retry_count, the job will be retried until both

3242

# limits are reached.

3243

#

3244

# The default value for max_retry_duration is zero, which means retry

3245

# duration is unlimited.

3246

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3247

# exponential backoff procedure described by

3248

# max_doublings.

3249

#

3250

# The default value of retry_count is zero.

3251

#

3252

# If retry_count is zero, a job attempt will *not* be retried if

3253

# it fails. Instead the Cloud Scheduler system will wait for the

3254

# next scheduled execution time.

3255

#

3256

# If retry_count is set to a non-zero number then Cloud Scheduler

3257

# will retry failed attempts, using exponential backoff,

3258

# retry_count times, or until the next scheduled execution time,

3259

# whichever comes first.

3260

#

3261

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3262

},

3263

"state": "A String", # Output only. State of the job.

3264

"name": "A String", # Optionally caller-specified in CreateJob, after

3265

# which it becomes output only.

3266

#

3267

# The job name. For example:

3268

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3269

#

3270

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3271

# hyphens (-), colons (:), or periods (.).

3272

# For more information, see

3273

# [Identifying

3274

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3275

# * `LOCATION_ID` is the canonical ID for the job's location.

3276

# The list of available locations can be obtained by calling

3277

# ListLocations.

3278

# For more information, see https://cloud.google.com/about/locations/.

3279

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3280

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3281

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3282

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3283

# retry of a previously failed attempt or the next execution time

3284

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3285

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3286

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3287

#

3288

# Describes the schedule on which the job will be executed.

3289

#

3290

# The schedule can be either of the following types:

3291

#

3292

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3293

# * English-like

3294

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3295

#

3296

# As a general rule, execution `n + 1` of a job will not begin

3297

# until execution `n` has finished. Cloud Scheduler will never

3298

# allow two simultaneously outstanding executions. For example,

3299

# this implies that if the `n+1`th execution is scheduled to run at

3300

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3301

# execution will not start until `16:15`.

3302

# A scheduled start time will be delayed if the previous

3303

# execution has not ended when its scheduled time occurs.

3304

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3305

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3306

# the job will be tried a total of retry_count

3307

# times, with exponential backoff, until the next scheduled start

3308

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3309

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3310

# this deadline then the request is cancelled and the attempt is marked as a

3311

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3312

# execution logs. Cloud Scheduler will retry the job according

3313

# to the RetryConfig.

3314

#

3315

# The allowed duration for this deadline is:

3316

# * For HTTP targets, between 15 seconds and 30 minutes.

3317

# * For App Engine HTTP targets, between 15

3318

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3319

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

3320

# the given Pub/Sub topic.

3321

"attributes": { # Attributes for PubsubMessage.

3322

#

3323

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

3328

# be published when a job is delivered. The topic name must be in the

3329

# same format as required by PubSub's

3330

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3331

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3332

#

3333

# The topic must be in the same project as the Cloud Scheduler job.

3334

"data": "A String", # The message payload for PubsubMessage.

3335

#

3336

# Pubsub message must contain either non-empty data, or at least one

3337

# attribute.

3338

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3339

"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]

3340

# an HTTP request via an http_method such as HTTP

3341

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3342

# response code in the range [200 - 299]. A failure to receive a response

3343

# constitutes a failed execution. For a redirected request, the response

3344

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3345

"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]

3346

# HTTP request. This map contains the header field names and

3347

# values. Repeated headers are not supported, but a header value can

3348

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3349

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3350

# headers will be ignored or replaced. A partial list of headers that

3351

# will be ignored or replaced is below:

3352

# - Host: This will be computed by Cloud Scheduler and derived from

3353

# uri.

3354

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3355

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3356

# * `X-Google-*`: Google internal use only.

3357

# * `X-AppEngine-*`: Google internal use only.

3358

#

3359

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3360

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3361

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3362

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3363

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3364

# token will be generated and attached as an `Authorization` header in the

3365

# HTTP request.

3366

#

3367

# This type of authorization can be used for many scenarios, including

3368

# calling Cloud Run, or endpoints where you intend to validate the token

3369

# yourself.

3370

# [OpenID Connect

3371

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3372

# This type of authorization can be used for many scenarios, including

3373

# calling Cloud Run, or endpoints where you intend to validate the token

3374

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3375

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3376

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3377

"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]

3378

# to be used for generating OIDC token.

3379

# The service account must be within the same project as the job. The caller

3380

# must have iam.serviceAccounts.actAs permission for the service account.

3381

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3382

"httpMethod": "A String", # Which HTTP method to use for the request.

3383

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

3384

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3385

# incompatible HttpMethod.

3386

"oauthToken": { # Contains information needed for generating an # If specified, an

3387

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3388

# will be generated and attached as an `Authorization` header in the HTTP

3389

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3390

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3391

# This type of authorization should generally only be used when calling

3392

# Google APIs hosted on *.googleapis.com.

3393

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3394

# This type of authorization should generally only be used when calling Google

3395

# APIs hosted on *.googleapis.com.

3396

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3397

# to be used for generating OAuth token.

3398

# The service account must be within the same project as the job. The caller

3399

# must have iam.serviceAccounts.actAs permission for the service account.

3400

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3401

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3402

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3403

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3404

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3405

# must begin with either "http://" or "https://". Some examples of

3406

# valid values for uri are:

3407

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3408

# encode some characters for safety and compatibility. The maximum allowed

3409

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3410

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3411

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3412

# schedule. The value of this field must be a time

3413

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3414

#

3415

# Note that some time zones include a provision for

3416

# daylight savings time. The rules for daylight saving time are

3417

# determined by the chosen tz. For UTC use the string "utc". If a

3418

# time zone is not specified, the default will be in UTC (also known

3419

# as GMT).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="run">run(name, body=None, x__xgafv=None)</code>

3425

<pre>Forces a job to run now.

3426

3427

When this method is called, Cloud Scheduler will dispatch the job, even

3428

if the job is already running.

3429

3430

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3431

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3432

`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. (required)

3433

body: object, The request body.

3434

The object takes the form of:

3435

3436

{ # Request message for forcing a job to run now using

# RunJob.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3447

3448

{ # Configuration for a job.

3449

# The maximum allowed size for a job is 100KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3450

"description": "A String", # Optionally caller-specified in CreateJob or

3451

# UpdateJob.

3452

#

3453

# A human-readable description for the job. This string must not contain

3454

# more than 500 characters.

3455

"appEngineHttpTarget": { # App Engine target. The job will be pushed to a job handler by means # App Engine HTTP target.

3456

# of an HTTP request via an http_method such

3457

# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an

3458

# HTTP response code in the range [200 - 299]. Error 503 is

3459

# considered an App Engine system error instead of an application

3460

# error. Requests returning error 503 will be retried regardless of

3461

# retry configuration and not counted against retry counts. Any other

3462

# response code, or a failure to receive a response before the

3463

# deadline, constitutes a failed attempt.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3464

"headers": { # HTTP request headers.

3465

#

3466

# This map contains the header field names and values. Headers can be set

3467

# when the job is created.

3468

#

3469

# Cloud Scheduler sets some headers to default values:

3470

#

3471

# * `User-Agent`: By default, this header is

3472

# `"AppEngine-Google; (+http://code.google.com/appengine)"`.

3473

# This header can be modified, but Cloud Scheduler will append

3474

# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the

3475

# modified `User-Agent`.

3476

# * `X-CloudScheduler`: This header will be set to true.

3477

#

3478

# If the job has an body, Cloud Scheduler sets

3479

# the following headers:

3480

#

3481

# * `Content-Type`: By default, the `Content-Type` header is set to

3482

# `"application/octet-stream"`. The default can be overridden by explictly

3483

# setting `Content-Type` to a particular media type when the job is

3484

# created.

3485

# For example, `Content-Type` can be set to `"application/json"`.

3486

# * `Content-Length`: This is computed by Cloud Scheduler. This value is

3487

# output only. It cannot be changed.

3488

#

3489

# The headers below are output only. They cannot be set or overridden:

3490

#

3491

# * `X-Google-*`: For Google internal use only.

3492

# * `X-AppEngine-*`: For Google internal use only.

3493

#

3494

# In addition, some App Engine headers, which contain

3495

# job-specific information, are also be sent to the job handler.

3496

"a_key": "A String",

3497

},

3498

"appEngineRouting": { # App Engine Routing. # App Engine Routing setting for the job.

3499

#

3500

# For more information about services, versions, and instances see

3501

# [An Overview of App

3502

# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),

3503

# [Microservices Architecture on Google App

3504

# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),

3505

# [App Engine Standard request

3506

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),

3507

# and [App Engine Flex request

3508

# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3509

"service": "A String", # App service.

3510

#

3511

# By default, the job is sent to the service which is the default

3512

# service when the job is attempted.

3513

"instance": "A String", # App instance.

3514

#

3515

# By default, the job is sent to an instance which is available when

3516

# the job is attempted.

3517

#

3518

# Requests can only be sent to a specific instance if

3519

# [manual scaling is used in App Engine

3520

# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).

3521

# App Engine Flex does not support instances. For more information, see

3522

# [App Engine Standard request

3523

# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)

3524

# and [App Engine Flex request

3525

# 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]

3526

"version": "A String", # App version.

3527

#

3528

# By default, the job is sent to the version which is the default

3529

# version when the job is attempted.

3530

"host": "A String", # Output only. The host that the job is sent to.

3531

#

3532

# For more information about how App Engine requests are routed, see

3533

# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).

3534

#

3535

# The host is constructed as:

3536

#

3537

#

3538

# * `host = [application_domain_name]`</br>

3539

# `| [service] + '.' + [application_domain_name]`</br>

3540

# `| [version] + '.' + [application_domain_name]`</br>

3541

# `| [version_dot_service]+ '.' + [application_domain_name]`</br>

3542

# `| [instance] + '.' + [application_domain_name]`</br>

3543

# `| [instance_dot_service] + '.' + [application_domain_name]`</br>

3544

# `| [instance_dot_version] + '.' + [application_domain_name]`</br>

3545

# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`

3546

#

3547

# * `application_domain_name` = The domain name of the app, for

3548

# example <app-id>.appspot.com, which is associated with the

3549

# job's project ID.

3550

#

3551

# * `service =` service

3552

#

3553

# * `version =` version

3554

#

3555

# * `version_dot_service =`

# version `+ '.' +`

# service

#

# * `instance =` instance

3560

#

3561

# * `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

3576

# to the service which is the default service when the job is attempted.

3577

#

3578

# If version is empty, then the job will be sent

3579

# to the version which is the default version when the job is attempted.

3580

#

3581

# If instance is empty, then the job will be

3582

# 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

3587

# to the default version of the default service when the job is attempted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3588

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3589

"httpMethod": "A String", # The HTTP method to use for the request. PATCH and OPTIONS are not

3590

# permitted.

3591

"body": "A String", # Body.

3592

#

3593

# HTTP request body. A request body is allowed only if the HTTP method is

3594

# POST or PUT. It will result in invalid argument error to set a body on a

3595

# job with an incompatible HttpMethod.

3596

"relativeUri": "A String", # The relative URI.

3597

#

3598

# The relative URL must begin with "/" and must be a valid HTTP relative URL.

3599

# It can contain a path, query string arguments, and `#` fragments.

3600

# If the relative URL is empty, then the root path "/" will be used.

3601

# No spaces are allowed, and the maximum length allowed is 2083 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3602

},

3603

"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]

3604

# different programming environments, including REST APIs and RPC APIs. It is

3605

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

3606

# three pieces of data: error code, error message, and error details.

3607

#

3608

# You can find out more about this error model and how to work with it in the

3609

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3610

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3611

# user-facing error message should be localized and sent in the

3612

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

"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]

3614

# message types for APIs to use.

3615

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3616

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3617

},

3618

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3619

"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]

3620

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3621

"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]

3622

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3623

# By default, if a job does not complete successfully (meaning that

3624

# an acknowledgement is not received from the handler, then it will be retried

3625

# with exponential backoff according to the settings in RetryConfig.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3626

"maxDoublings": 42, # The time between retries will double `max_doublings` times.

3627

#

3628

# A job's retry interval starts at

3629

# min_backoff_duration, then doubles

3630

# `max_doublings` times, then increases linearly, and finally

3631

# retries at intervals of

3632

# max_backoff_duration up to

3633

# retry_count times.

3634

#

3635

# For example, if min_backoff_duration is

3636

# 10s, max_backoff_duration is 300s, and

3637

# `max_doublings` is 3, then the a job will first be retried in 10s. The

3638

# retry interval will double three times, and then increase linearly by

3639

# 2^3 * 10s. Finally, the job will retry at intervals of

3640

# max_backoff_duration until the job has

3641

# been attempted retry_count times. Thus, the

3642

# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....

3643

#

3644

# The default value of this field is 5.

3645

"minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after

3646

# it fails.

3647

#

3648

# The default value of this field is 5 seconds.

3649

"maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after

3650

# it fails.

3651

#

3652

# The default value of this field is 1 hour.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3653

"maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from time when an

3654

# execution was first attempted. If specified with

3655

# retry_count, the job will be retried until both

3656

# limits are reached.

3657

#

3658

# The default value for max_retry_duration is zero, which means retry

3659

# duration is unlimited.

3660

"retryCount": 42, # The number of attempts that the system will make to run a job using the

3661

# exponential backoff procedure described by

3662

# max_doublings.

3663

#

3664

# The default value of retry_count is zero.

3665

#

3666

# If retry_count is zero, a job attempt will *not* be retried if

3667

# it fails. Instead the Cloud Scheduler system will wait for the

3668

# next scheduled execution time.

3669

#

3670

# If retry_count is set to a non-zero number then Cloud Scheduler

3671

# will retry failed attempts, using exponential backoff,

3672

# retry_count times, or until the next scheduled execution time,

3673

# whichever comes first.

3674

#

3675

# Values greater than 5 and negative values are not allowed.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3676

},

3677

"state": "A String", # Output only. State of the job.

3678

"name": "A String", # Optionally caller-specified in CreateJob, after

3679

# which it becomes output only.

3680

#

3681

# The job name. For example:

3682

# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.

3683

#

3684

# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),

3685

# hyphens (-), colons (:), or periods (.).

3686

# For more information, see

3687

# [Identifying

3688

# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)

3689

# * `LOCATION_ID` is the canonical ID for the job's location.

3690

# The list of available locations can be obtained by calling

3691

# ListLocations.

3692

# For more information, see https://cloud.google.com/about/locations/.

3693

# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),

3694

# hyphens (-), or underscores (_). The maximum length is 500 characters.

3695

"lastAttemptTime": "A String", # Output only. The time the last job attempt started.

3696

"scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a

3697

# retry of a previously failed attempt or the next execution time

3698

# according to the schedule.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3699

"userUpdateTime": "A String", # Output only. The creation time of the job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

"schedule": "A String", # Required, except when used with UpdateJob.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3701

#

3702

# Describes the schedule on which the job will be executed.

3703

#

3704

# The schedule can be either of the following types:

3705

#

3706

# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)

3707

# * English-like

3708

# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)

3709

#

3710

# As a general rule, execution `n + 1` of a job will not begin

3711

# until execution `n` has finished. Cloud Scheduler will never

3712

# allow two simultaneously outstanding executions. For example,

3713

# this implies that if the `n+1`th execution is scheduled to run at

3714

# 16:00 but the `n`th execution takes until 16:15, the `n+1`th

3715

# execution will not start until `16:15`.

3716

# A scheduled start time will be delayed if the previous

3717

# execution has not ended when its scheduled time occurs.

3718

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3719

# If retry_count > 0 and a job attempt fails,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3720

# the job will be tried a total of retry_count

3721

# times, with exponential backoff, until the next scheduled start

3722

# time.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3723

"attemptDeadline": "A String", # The deadline for job attempts. If the request handler does not respond by

3724

# this deadline then the request is cancelled and the attempt is marked as a

3725

# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in

3726

# execution logs. Cloud Scheduler will retry the job according

3727

# to the RetryConfig.

3728

#

3729

# The allowed duration for this deadline is:

3730

# * For HTTP targets, between 15 seconds and 30 minutes.

3731

# * For App Engine HTTP targets, between 15

3732

# seconds and 24 hours.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3733

"pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target.

3734

# the given Pub/Sub topic.

3735

"attributes": { # Attributes for PubsubMessage.

3736

#

3737

# Pubsub message must contain either non-empty data, or at least one

# attribute.

"a_key": "A String",

},

"topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will

3742

# be published when a job is delivered. The topic name must be in the

3743

# same format as required by PubSub's

3744

# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),

3745

# for example `projects/PROJECT_ID/topics/TOPIC_ID`.

3746

#

3747

# The topic must be in the same project as the Cloud Scheduler job.

3748

"data": "A String", # The message payload for PubsubMessage.

3749

#

3750

# Pubsub message must contain either non-empty data, or at least one

3751

# attribute.

3752

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3753

"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]

3754

# an HTTP request via an http_method such as HTTP

3755

# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP

3756

# response code in the range [200 - 299]. A failure to receive a response

3757

# constitutes a failed execution. For a redirected request, the response

3758

# returned by the redirected request is considered.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3759

"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]

3760

# HTTP request. This map contains the header field names and

3761

# values. Repeated headers are not supported, but a header value can

3762

# contain commas. These headers represent a subset of the headers

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3763

# that will accompany the job's HTTP request. Some HTTP request

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3764

# headers will be ignored or replaced. A partial list of headers that

3765

# will be ignored or replaced is below:

3766

# - Host: This will be computed by Cloud Scheduler and derived from

3767

# uri.

3768

# * `Content-Length`: This will be computed by Cloud Scheduler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3769

# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3770

# * `X-Google-*`: Google internal use only.

3771

# * `X-AppEngine-*`: Google internal use only.

3772

#

3773

# The total size of headers must be less than 80KB.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3774

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3775

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3776

"oidcToken": { # Contains information needed for generating an # If specified, an

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3777

# [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)

3778

# token will be generated and attached as an `Authorization` header in the

3779

# HTTP request.

3780

#

3781

# This type of authorization can be used for many scenarios, including

3782

# calling Cloud Run, or endpoints where you intend to validate the token

3783

# yourself.

3784

# [OpenID Connect

3785

# token](https://developers.google.com/identity/protocols/OpenIDConnect).

3786

# This type of authorization can be used for many scenarios, including

3787

# calling Cloud Run, or endpoints where you intend to validate the token

3788

# yourself.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

"audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3790

# specified in target will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3791

"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]

3792

# to be used for generating OIDC token.

3793

# The service account must be within the same project as the job. The caller

3794

# must have iam.serviceAccounts.actAs permission for the service account.

3795

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3796

"httpMethod": "A String", # Which HTTP method to use for the request.

3797

"body": "A String", # HTTP request body. A request body is allowed only if the HTTP

3798

# method is POST, PUT, or PATCH. It is an error to set body on a job with an

3799

# incompatible HttpMethod.

3800

"oauthToken": { # Contains information needed for generating an # If specified, an

3801

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2)

3802

# will be generated and attached as an `Authorization` header in the HTTP

3803

# request.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3804

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3805

# This type of authorization should generally only be used when calling

3806

# Google APIs hosted on *.googleapis.com.

3807

# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).

3808

# This type of authorization should generally only be used when calling Google

3809

# APIs hosted on *.googleapis.com.

3810

"serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts)

3811

# to be used for generating OAuth token.

3812

# The service account must be within the same project as the job. The caller

3813

# must have iam.serviceAccounts.actAs permission for the service account.

3814

"scope": "A String", # OAuth scope to be used for generating OAuth access token.

3815

# If not specified, "https://www.googleapis.com/auth/cloud-platform"

3816

# will be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3817

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3818

"uri": "A String", # Required. The full URI path that the request will be sent to. This string

3819

# must begin with either "http://" or "https://". Some examples of

3820

# valid values for uri are:

3821

# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will

3822

# encode some characters for safety and compatibility. The maximum allowed

3823

# URL length is 2083 characters after encoding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3824

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3825

"timeZone": "A String", # Specifies the time zone to be used in interpreting

3826

# schedule. The value of this field must be a time

3827

# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).

3828

#

3829

# Note that some time zones include a provision for

3830

# daylight savings time. The rules for daylight saving time are

3831

# determined by the chosen tz. For UTC use the string "utc". If a

3832

# time zone is not specified, the default will be in UTC (also known

3833

# as GMT).

Bu Sun Kim