1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/scheduler/v1/job.proto 18 19 package com.google.cloud.scheduler.v1; 20 21 public interface JobOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.scheduler.v1.Job) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Optionally caller-specified in 31 * [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob], after 32 * which it becomes output only. 33 * The job name. For example: 34 * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 35 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 36 * hyphens (-), colons (:), or periods (.). 37 * For more information, see 38 * [Identifying 39 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 40 * * `LOCATION_ID` is the canonical ID for the job's location. 41 * The list of available locations can be obtained by calling 42 * [ListLocations][google.cloud.location.Locations.ListLocations]. 43 * For more information, see https://cloud.google.com/about/locations/. 44 * * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 45 * hyphens (-), or underscores (_). The maximum length is 500 characters. 46 * </pre> 47 * 48 * <code>string name = 1;</code> 49 * 50 * @return The name. 51 */ getName()52 java.lang.String getName(); 53 /** 54 * 55 * 56 * <pre> 57 * Optionally caller-specified in 58 * [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob], after 59 * which it becomes output only. 60 * The job name. For example: 61 * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. 62 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 63 * hyphens (-), colons (:), or periods (.). 64 * For more information, see 65 * [Identifying 66 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 67 * * `LOCATION_ID` is the canonical ID for the job's location. 68 * The list of available locations can be obtained by calling 69 * [ListLocations][google.cloud.location.Locations.ListLocations]. 70 * For more information, see https://cloud.google.com/about/locations/. 71 * * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 72 * hyphens (-), or underscores (_). The maximum length is 500 characters. 73 * </pre> 74 * 75 * <code>string name = 1;</code> 76 * 77 * @return The bytes for name. 78 */ getNameBytes()79 com.google.protobuf.ByteString getNameBytes(); 80 81 /** 82 * 83 * 84 * <pre> 85 * Optionally caller-specified in 86 * [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or 87 * [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]. 88 * A human-readable description for the job. This string must not contain 89 * more than 500 characters. 90 * </pre> 91 * 92 * <code>string description = 2;</code> 93 * 94 * @return The description. 95 */ getDescription()96 java.lang.String getDescription(); 97 /** 98 * 99 * 100 * <pre> 101 * Optionally caller-specified in 102 * [CreateJob][google.cloud.scheduler.v1.CloudScheduler.CreateJob] or 103 * [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]. 104 * A human-readable description for the job. This string must not contain 105 * more than 500 characters. 106 * </pre> 107 * 108 * <code>string description = 2;</code> 109 * 110 * @return The bytes for description. 111 */ getDescriptionBytes()112 com.google.protobuf.ByteString getDescriptionBytes(); 113 114 /** 115 * 116 * 117 * <pre> 118 * Pub/Sub target. 119 * </pre> 120 * 121 * <code>.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;</code> 122 * 123 * @return Whether the pubsubTarget field is set. 124 */ hasPubsubTarget()125 boolean hasPubsubTarget(); 126 /** 127 * 128 * 129 * <pre> 130 * Pub/Sub target. 131 * </pre> 132 * 133 * <code>.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;</code> 134 * 135 * @return The pubsubTarget. 136 */ getPubsubTarget()137 com.google.cloud.scheduler.v1.PubsubTarget getPubsubTarget(); 138 /** 139 * 140 * 141 * <pre> 142 * Pub/Sub target. 143 * </pre> 144 * 145 * <code>.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;</code> 146 */ getPubsubTargetOrBuilder()147 com.google.cloud.scheduler.v1.PubsubTargetOrBuilder getPubsubTargetOrBuilder(); 148 149 /** 150 * 151 * 152 * <pre> 153 * App Engine HTTP target. 154 * </pre> 155 * 156 * <code>.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;</code> 157 * 158 * @return Whether the appEngineHttpTarget field is set. 159 */ hasAppEngineHttpTarget()160 boolean hasAppEngineHttpTarget(); 161 /** 162 * 163 * 164 * <pre> 165 * App Engine HTTP target. 166 * </pre> 167 * 168 * <code>.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;</code> 169 * 170 * @return The appEngineHttpTarget. 171 */ getAppEngineHttpTarget()172 com.google.cloud.scheduler.v1.AppEngineHttpTarget getAppEngineHttpTarget(); 173 /** 174 * 175 * 176 * <pre> 177 * App Engine HTTP target. 178 * </pre> 179 * 180 * <code>.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;</code> 181 */ getAppEngineHttpTargetOrBuilder()182 com.google.cloud.scheduler.v1.AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder(); 183 184 /** 185 * 186 * 187 * <pre> 188 * HTTP target. 189 * </pre> 190 * 191 * <code>.google.cloud.scheduler.v1.HttpTarget http_target = 6;</code> 192 * 193 * @return Whether the httpTarget field is set. 194 */ hasHttpTarget()195 boolean hasHttpTarget(); 196 /** 197 * 198 * 199 * <pre> 200 * HTTP target. 201 * </pre> 202 * 203 * <code>.google.cloud.scheduler.v1.HttpTarget http_target = 6;</code> 204 * 205 * @return The httpTarget. 206 */ getHttpTarget()207 com.google.cloud.scheduler.v1.HttpTarget getHttpTarget(); 208 /** 209 * 210 * 211 * <pre> 212 * HTTP target. 213 * </pre> 214 * 215 * <code>.google.cloud.scheduler.v1.HttpTarget http_target = 6;</code> 216 */ getHttpTargetOrBuilder()217 com.google.cloud.scheduler.v1.HttpTargetOrBuilder getHttpTargetOrBuilder(); 218 219 /** 220 * 221 * 222 * <pre> 223 * Required, except when used with 224 * [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]. 225 * Describes the schedule on which the job will be executed. 226 * The schedule can be either of the following types: 227 * * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) 228 * * English-like 229 * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 230 * As a general rule, execution `n + 1` of a job will not begin 231 * until execution `n` has finished. Cloud Scheduler will never 232 * allow two simultaneously outstanding executions. For example, 233 * this implies that if the `n+1`th execution is scheduled to run at 234 * 16:00 but the `n`th execution takes until 16:15, the `n+1`th 235 * execution will not start until `16:15`. 236 * A scheduled start time will be delayed if the previous 237 * execution has not ended when its scheduled time occurs. 238 * If [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] > 0 and 239 * a job attempt fails, the job will be tried a total of 240 * [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times, 241 * with exponential backoff, until the next scheduled start time. 242 * </pre> 243 * 244 * <code>string schedule = 20;</code> 245 * 246 * @return The schedule. 247 */ getSchedule()248 java.lang.String getSchedule(); 249 /** 250 * 251 * 252 * <pre> 253 * Required, except when used with 254 * [UpdateJob][google.cloud.scheduler.v1.CloudScheduler.UpdateJob]. 255 * Describes the schedule on which the job will be executed. 256 * The schedule can be either of the following types: 257 * * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) 258 * * English-like 259 * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) 260 * As a general rule, execution `n + 1` of a job will not begin 261 * until execution `n` has finished. Cloud Scheduler will never 262 * allow two simultaneously outstanding executions. For example, 263 * this implies that if the `n+1`th execution is scheduled to run at 264 * 16:00 but the `n`th execution takes until 16:15, the `n+1`th 265 * execution will not start until `16:15`. 266 * A scheduled start time will be delayed if the previous 267 * execution has not ended when its scheduled time occurs. 268 * If [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] > 0 and 269 * a job attempt fails, the job will be tried a total of 270 * [retry_count][google.cloud.scheduler.v1.RetryConfig.retry_count] times, 271 * with exponential backoff, until the next scheduled start time. 272 * </pre> 273 * 274 * <code>string schedule = 20;</code> 275 * 276 * @return The bytes for schedule. 277 */ getScheduleBytes()278 com.google.protobuf.ByteString getScheduleBytes(); 279 280 /** 281 * 282 * 283 * <pre> 284 * Specifies the time zone to be used in interpreting 285 * [schedule][google.cloud.scheduler.v1.Job.schedule]. The value of this field 286 * must be a time zone name from the [tz 287 * database](http://en.wikipedia.org/wiki/Tz_database). 288 * Note that some time zones include a provision for 289 * daylight savings time. The rules for daylight saving time are 290 * determined by the chosen tz. For UTC use the string "utc". If a 291 * time zone is not specified, the default will be in UTC (also known 292 * as GMT). 293 * </pre> 294 * 295 * <code>string time_zone = 21;</code> 296 * 297 * @return The timeZone. 298 */ getTimeZone()299 java.lang.String getTimeZone(); 300 /** 301 * 302 * 303 * <pre> 304 * Specifies the time zone to be used in interpreting 305 * [schedule][google.cloud.scheduler.v1.Job.schedule]. The value of this field 306 * must be a time zone name from the [tz 307 * database](http://en.wikipedia.org/wiki/Tz_database). 308 * Note that some time zones include a provision for 309 * daylight savings time. The rules for daylight saving time are 310 * determined by the chosen tz. For UTC use the string "utc". If a 311 * time zone is not specified, the default will be in UTC (also known 312 * as GMT). 313 * </pre> 314 * 315 * <code>string time_zone = 21;</code> 316 * 317 * @return The bytes for timeZone. 318 */ getTimeZoneBytes()319 com.google.protobuf.ByteString getTimeZoneBytes(); 320 321 /** 322 * 323 * 324 * <pre> 325 * Output only. The creation time of the job. 326 * </pre> 327 * 328 * <code>.google.protobuf.Timestamp user_update_time = 9;</code> 329 * 330 * @return Whether the userUpdateTime field is set. 331 */ hasUserUpdateTime()332 boolean hasUserUpdateTime(); 333 /** 334 * 335 * 336 * <pre> 337 * Output only. The creation time of the job. 338 * </pre> 339 * 340 * <code>.google.protobuf.Timestamp user_update_time = 9;</code> 341 * 342 * @return The userUpdateTime. 343 */ getUserUpdateTime()344 com.google.protobuf.Timestamp getUserUpdateTime(); 345 /** 346 * 347 * 348 * <pre> 349 * Output only. The creation time of the job. 350 * </pre> 351 * 352 * <code>.google.protobuf.Timestamp user_update_time = 9;</code> 353 */ getUserUpdateTimeOrBuilder()354 com.google.protobuf.TimestampOrBuilder getUserUpdateTimeOrBuilder(); 355 356 /** 357 * 358 * 359 * <pre> 360 * Output only. State of the job. 361 * </pre> 362 * 363 * <code>.google.cloud.scheduler.v1.Job.State state = 10;</code> 364 * 365 * @return The enum numeric value on the wire for state. 366 */ getStateValue()367 int getStateValue(); 368 /** 369 * 370 * 371 * <pre> 372 * Output only. State of the job. 373 * </pre> 374 * 375 * <code>.google.cloud.scheduler.v1.Job.State state = 10;</code> 376 * 377 * @return The state. 378 */ getState()379 com.google.cloud.scheduler.v1.Job.State getState(); 380 381 /** 382 * 383 * 384 * <pre> 385 * Output only. The response from the target for the last attempted execution. 386 * </pre> 387 * 388 * <code>.google.rpc.Status status = 11;</code> 389 * 390 * @return Whether the status field is set. 391 */ hasStatus()392 boolean hasStatus(); 393 /** 394 * 395 * 396 * <pre> 397 * Output only. The response from the target for the last attempted execution. 398 * </pre> 399 * 400 * <code>.google.rpc.Status status = 11;</code> 401 * 402 * @return The status. 403 */ getStatus()404 com.google.rpc.Status getStatus(); 405 /** 406 * 407 * 408 * <pre> 409 * Output only. The response from the target for the last attempted execution. 410 * </pre> 411 * 412 * <code>.google.rpc.Status status = 11;</code> 413 */ getStatusOrBuilder()414 com.google.rpc.StatusOrBuilder getStatusOrBuilder(); 415 416 /** 417 * 418 * 419 * <pre> 420 * Output only. The next time the job is scheduled. Note that this may be a 421 * retry of a previously failed attempt or the next execution time 422 * according to the schedule. 423 * </pre> 424 * 425 * <code>.google.protobuf.Timestamp schedule_time = 17;</code> 426 * 427 * @return Whether the scheduleTime field is set. 428 */ hasScheduleTime()429 boolean hasScheduleTime(); 430 /** 431 * 432 * 433 * <pre> 434 * Output only. The next time the job is scheduled. Note that this may be a 435 * retry of a previously failed attempt or the next execution time 436 * according to the schedule. 437 * </pre> 438 * 439 * <code>.google.protobuf.Timestamp schedule_time = 17;</code> 440 * 441 * @return The scheduleTime. 442 */ getScheduleTime()443 com.google.protobuf.Timestamp getScheduleTime(); 444 /** 445 * 446 * 447 * <pre> 448 * Output only. The next time the job is scheduled. Note that this may be a 449 * retry of a previously failed attempt or the next execution time 450 * according to the schedule. 451 * </pre> 452 * 453 * <code>.google.protobuf.Timestamp schedule_time = 17;</code> 454 */ getScheduleTimeOrBuilder()455 com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder(); 456 457 /** 458 * 459 * 460 * <pre> 461 * Output only. The time the last job attempt started. 462 * </pre> 463 * 464 * <code>.google.protobuf.Timestamp last_attempt_time = 18;</code> 465 * 466 * @return Whether the lastAttemptTime field is set. 467 */ hasLastAttemptTime()468 boolean hasLastAttemptTime(); 469 /** 470 * 471 * 472 * <pre> 473 * Output only. The time the last job attempt started. 474 * </pre> 475 * 476 * <code>.google.protobuf.Timestamp last_attempt_time = 18;</code> 477 * 478 * @return The lastAttemptTime. 479 */ getLastAttemptTime()480 com.google.protobuf.Timestamp getLastAttemptTime(); 481 /** 482 * 483 * 484 * <pre> 485 * Output only. The time the last job attempt started. 486 * </pre> 487 * 488 * <code>.google.protobuf.Timestamp last_attempt_time = 18;</code> 489 */ getLastAttemptTimeOrBuilder()490 com.google.protobuf.TimestampOrBuilder getLastAttemptTimeOrBuilder(); 491 492 /** 493 * 494 * 495 * <pre> 496 * Settings that determine the retry behavior. 497 * </pre> 498 * 499 * <code>.google.cloud.scheduler.v1.RetryConfig retry_config = 19;</code> 500 * 501 * @return Whether the retryConfig field is set. 502 */ hasRetryConfig()503 boolean hasRetryConfig(); 504 /** 505 * 506 * 507 * <pre> 508 * Settings that determine the retry behavior. 509 * </pre> 510 * 511 * <code>.google.cloud.scheduler.v1.RetryConfig retry_config = 19;</code> 512 * 513 * @return The retryConfig. 514 */ getRetryConfig()515 com.google.cloud.scheduler.v1.RetryConfig getRetryConfig(); 516 /** 517 * 518 * 519 * <pre> 520 * Settings that determine the retry behavior. 521 * </pre> 522 * 523 * <code>.google.cloud.scheduler.v1.RetryConfig retry_config = 19;</code> 524 */ getRetryConfigOrBuilder()525 com.google.cloud.scheduler.v1.RetryConfigOrBuilder getRetryConfigOrBuilder(); 526 527 /** 528 * 529 * 530 * <pre> 531 * The deadline for job attempts. If the request handler does not respond by 532 * this deadline then the request is cancelled and the attempt is marked as a 533 * `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 534 * execution logs. Cloud Scheduler will retry the job according 535 * to the [RetryConfig][google.cloud.scheduler.v1.RetryConfig]. 536 * The default and the allowed values depend on the type of target: 537 * * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the 538 * default is 3 minutes. The deadline must be in the interval [15 seconds, 30 539 * minutes]. 540 * * For [App Engine HTTP 541 * targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 0 indicates 542 * that the request has the default deadline. The default deadline depends on 543 * the scaling type of the service: 10 minutes for standard apps with 544 * automatic scaling, 24 hours for standard apps with manual and basic 545 * scaling, and 60 minutes for flex apps. If the request deadline is set, it 546 * must be in the interval [15 seconds, 24 hours 15 seconds]. 547 * * For [Pub/Sub targets][google.cloud.scheduler.v1.Job.pubsub_target], this 548 * field is ignored. 549 * </pre> 550 * 551 * <code>.google.protobuf.Duration attempt_deadline = 22;</code> 552 * 553 * @return Whether the attemptDeadline field is set. 554 */ hasAttemptDeadline()555 boolean hasAttemptDeadline(); 556 /** 557 * 558 * 559 * <pre> 560 * The deadline for job attempts. If the request handler does not respond by 561 * this deadline then the request is cancelled and the attempt is marked as a 562 * `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 563 * execution logs. Cloud Scheduler will retry the job according 564 * to the [RetryConfig][google.cloud.scheduler.v1.RetryConfig]. 565 * The default and the allowed values depend on the type of target: 566 * * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the 567 * default is 3 minutes. The deadline must be in the interval [15 seconds, 30 568 * minutes]. 569 * * For [App Engine HTTP 570 * targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 0 indicates 571 * that the request has the default deadline. The default deadline depends on 572 * the scaling type of the service: 10 minutes for standard apps with 573 * automatic scaling, 24 hours for standard apps with manual and basic 574 * scaling, and 60 minutes for flex apps. If the request deadline is set, it 575 * must be in the interval [15 seconds, 24 hours 15 seconds]. 576 * * For [Pub/Sub targets][google.cloud.scheduler.v1.Job.pubsub_target], this 577 * field is ignored. 578 * </pre> 579 * 580 * <code>.google.protobuf.Duration attempt_deadline = 22;</code> 581 * 582 * @return The attemptDeadline. 583 */ getAttemptDeadline()584 com.google.protobuf.Duration getAttemptDeadline(); 585 /** 586 * 587 * 588 * <pre> 589 * The deadline for job attempts. If the request handler does not respond by 590 * this deadline then the request is cancelled and the attempt is marked as a 591 * `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in 592 * execution logs. Cloud Scheduler will retry the job according 593 * to the [RetryConfig][google.cloud.scheduler.v1.RetryConfig]. 594 * The default and the allowed values depend on the type of target: 595 * * For [HTTP targets][google.cloud.scheduler.v1.Job.http_target], the 596 * default is 3 minutes. The deadline must be in the interval [15 seconds, 30 597 * minutes]. 598 * * For [App Engine HTTP 599 * targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 0 indicates 600 * that the request has the default deadline. The default deadline depends on 601 * the scaling type of the service: 10 minutes for standard apps with 602 * automatic scaling, 24 hours for standard apps with manual and basic 603 * scaling, and 60 minutes for flex apps. If the request deadline is set, it 604 * must be in the interval [15 seconds, 24 hours 15 seconds]. 605 * * For [Pub/Sub targets][google.cloud.scheduler.v1.Job.pubsub_target], this 606 * field is ignored. 607 * </pre> 608 * 609 * <code>.google.protobuf.Duration attempt_deadline = 22;</code> 610 */ getAttemptDeadlineOrBuilder()611 com.google.protobuf.DurationOrBuilder getAttemptDeadlineOrBuilder(); 612 getTargetCase()613 public com.google.cloud.scheduler.v1.Job.TargetCase getTargetCase(); 614 } 615