- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.13
- 2.2.0
- 2.1.23
public interface JobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAppEngineHttpTarget()
public abstract AppEngineHttpTarget getAppEngineHttpTarget()App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
| Type | Description |
AppEngineHttpTarget | The appEngineHttpTarget. |
getAppEngineHttpTargetOrBuilder()
public abstract AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
| Type | Description |
AppEngineHttpTargetOrBuilder |
getAttemptDeadline()
public abstract Duration getAttemptDeadline() The deadline for job attempts. If the request handler does not respond by
this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED failure. The failed attempt can be viewed in
execution logs. Cloud Scheduler will retry the job according
to the RetryConfig.
The allowed duration for this deadline is:
- For HTTP targets, between 15 seconds and 30 minutes.
- For App Engine HTTP targets, between 15 seconds and 24 hours.
.google.protobuf.Duration attempt_deadline = 22;
| Type | Description |
Duration | The attemptDeadline. |
getAttemptDeadlineOrBuilder()
public abstract DurationOrBuilder getAttemptDeadlineOrBuilder() The deadline for job attempts. If the request handler does not respond by
this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED failure. The failed attempt can be viewed in
execution logs. Cloud Scheduler will retry the job according
to the RetryConfig.
The allowed duration for this deadline is:
- For HTTP targets, between 15 seconds and 30 minutes.
- For App Engine HTTP targets, between 15 seconds and 24 hours.
.google.protobuf.Duration attempt_deadline = 22;
| Type | Description |
DurationOrBuilder |
getDescription()
public abstract String getDescription()Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
string description = 2;
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters.
string description = 2;
| Type | Description |
ByteString | The bytes for description. |
getHttpTarget()
public abstract HttpTarget getHttpTarget()HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
| Type | Description |
HttpTarget | The httpTarget. |
getHttpTargetOrBuilder()
public abstract HttpTargetOrBuilder getHttpTargetOrBuilder()HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
| Type | Description |
HttpTargetOrBuilder |
getLastAttemptTime()
public abstract Timestamp getLastAttemptTime()Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
| Type | Description |
Timestamp | The lastAttemptTime. |
getLastAttemptTimeOrBuilder()
public abstract TimestampOrBuilder getLastAttemptTimeOrBuilder()Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
| Type | Description |
TimestampOrBuilder |
getName()
public abstract String getName() Optionally caller-specified in CreateJob, after
which it becomes output only.
The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
PROJECT_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.JOB_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string name = 1;
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() Optionally caller-specified in CreateJob, after
which it becomes output only.
The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
PROJECT_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.JOB_IDcan contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
string name = 1;
| Type | Description |
ByteString | The bytes for name. |
getPubsubTarget()
public abstract PubsubTarget getPubsubTarget()Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
| Type | Description |
PubsubTarget | The pubsubTarget. |
getPubsubTargetOrBuilder()
public abstract PubsubTargetOrBuilder getPubsubTargetOrBuilder()Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
| Type | Description |
PubsubTargetOrBuilder |
getRetryConfig()
public abstract RetryConfig getRetryConfig()Settings that determine the retry behavior.
.google.cloud.scheduler.v1.RetryConfig retry_config = 19;
| Type | Description |
RetryConfig | The retryConfig. |
getRetryConfigOrBuilder()
public abstract RetryConfigOrBuilder getRetryConfigOrBuilder()Settings that determine the retry behavior.
.google.cloud.scheduler.v1.RetryConfig retry_config = 19;
| Type | Description |
RetryConfigOrBuilder |
getSchedule()
public abstract String getSchedule()Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types:
- Crontab
- English-like
schedule
As a general rule, execution
n + 1of a job will not begin until executionnhas finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1th execution is scheduled to run at 16:00 but thenth execution takes until 16:15, then+1th execution will not start until16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.
string schedule = 20;
| Type | Description |
String | The schedule. |
getScheduleBytes()
public abstract ByteString getScheduleBytes()Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types:
- Crontab
- English-like
schedule
As a general rule, execution
n + 1of a job will not begin until executionnhas finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if then+1th execution is scheduled to run at 16:00 but thenth execution takes until 16:15, then+1th execution will not start until16:15. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.
string schedule = 20;
| Type | Description |
ByteString | The bytes for schedule. |
getScheduleTime()
public abstract Timestamp getScheduleTime()Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
.google.protobuf.Timestamp schedule_time = 17;
| Type | Description |
Timestamp | The scheduleTime. |
getScheduleTimeOrBuilder()
public abstract TimestampOrBuilder getScheduleTimeOrBuilder()Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
.google.protobuf.Timestamp schedule_time = 17;
| Type | Description |
TimestampOrBuilder |
getState()
public abstract Job.State getState()Output only. State of the job.
.google.cloud.scheduler.v1.Job.State state = 10;
| Type | Description |
Job.State | The state. |
getStateValue()
public abstract int getStateValue()Output only. State of the job.
.google.cloud.scheduler.v1.Job.State state = 10;
| Type | Description |
int | The enum numeric value on the wire for state. |
getStatus()
public abstract Status getStatus()Output only. The response from the target for the last attempted execution.
.google.rpc.Status status = 11;
| Type | Description |
com.google.rpc.Status | The status. |
getStatusOrBuilder()
public abstract StatusOrBuilder getStatusOrBuilder()Output only. The response from the target for the last attempted execution.
.google.rpc.Status status = 11;
| Type | Description |
com.google.rpc.StatusOrBuilder |
getTargetCase()
public abstract Job.TargetCase getTargetCase()| Type | Description |
Job.TargetCase |
getTimeZone()
public abstract String getTimeZone()Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
string time_zone = 21;
| Type | Description |
String | The timeZone. |
getTimeZoneBytes()
public abstract ByteString getTimeZoneBytes()Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database. Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
string time_zone = 21;
| Type | Description |
ByteString | The bytes for timeZone. |
getUserUpdateTime()
public abstract Timestamp getUserUpdateTime()Output only. The creation time of the job.
.google.protobuf.Timestamp user_update_time = 9;
| Type | Description |
Timestamp | The userUpdateTime. |
getUserUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUserUpdateTimeOrBuilder()Output only. The creation time of the job.
.google.protobuf.Timestamp user_update_time = 9;
| Type | Description |
TimestampOrBuilder |
hasAppEngineHttpTarget()
public abstract boolean hasAppEngineHttpTarget()App Engine HTTP target.
.google.cloud.scheduler.v1.AppEngineHttpTarget app_engine_http_target = 5;
| Type | Description |
boolean | Whether the appEngineHttpTarget field is set. |
hasAttemptDeadline()
public abstract boolean hasAttemptDeadline() The deadline for job attempts. If the request handler does not respond by
this deadline then the request is cancelled and the attempt is marked as a
DEADLINE_EXCEEDED failure. The failed attempt can be viewed in
execution logs. Cloud Scheduler will retry the job according
to the RetryConfig.
The allowed duration for this deadline is:
- For HTTP targets, between 15 seconds and 30 minutes.
- For App Engine HTTP targets, between 15 seconds and 24 hours.
.google.protobuf.Duration attempt_deadline = 22;
| Type | Description |
boolean | Whether the attemptDeadline field is set. |
hasHttpTarget()
public abstract boolean hasHttpTarget()HTTP target.
.google.cloud.scheduler.v1.HttpTarget http_target = 6;
| Type | Description |
boolean | Whether the httpTarget field is set. |
hasLastAttemptTime()
public abstract boolean hasLastAttemptTime()Output only. The time the last job attempt started.
.google.protobuf.Timestamp last_attempt_time = 18;
| Type | Description |
boolean | Whether the lastAttemptTime field is set. |
hasPubsubTarget()
public abstract boolean hasPubsubTarget()Pub/Sub target.
.google.cloud.scheduler.v1.PubsubTarget pubsub_target = 4;
| Type | Description |
boolean | Whether the pubsubTarget field is set. |
hasRetryConfig()
public abstract boolean hasRetryConfig()Settings that determine the retry behavior.
.google.cloud.scheduler.v1.RetryConfig retry_config = 19;
| Type | Description |
boolean | Whether the retryConfig field is set. |
hasScheduleTime()
public abstract boolean hasScheduleTime()Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
.google.protobuf.Timestamp schedule_time = 17;
| Type | Description |
boolean | Whether the scheduleTime field is set. |
hasStatus()
public abstract boolean hasStatus()Output only. The response from the target for the last attempted execution.
.google.rpc.Status status = 11;
| Type | Description |
boolean | Whether the status field is set. |
hasUserUpdateTime()
public abstract boolean hasUserUpdateTime()Output only. The creation time of the job.
.google.protobuf.Timestamp user_update_time = 9;
| Type | Description |
boolean | Whether the userUpdateTime field is set. |