public final class Schedule extends GeneratedMessageV3 implements ScheduleOrBuilder
An instance of a Schedule periodically schedules runs to make API calls based
on user specified time specification and API request type.
Protobuf type google.cloud.aiplatform.v1.Schedule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int ALLOW_QUEUEING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CATCH_UP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int CRON_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int END_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LAST_PAUSE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LAST_RESUME_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MAX_RUN_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NEXT_RUN_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STARTED_RUN_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Schedule getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Schedule.Builder newBuilder()
public static Schedule.Builder newBuilder(Schedule prototype)
| Parameter |
|---|
| Name | Description |
prototype | Schedule
|
public static Schedule parseDelimitedFrom(InputStream input)
public static Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(ByteString data)
public static Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(CodedInputStream input)
public static Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(InputStream input)
public static Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(ByteBuffer data)
public static Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Schedule> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public boolean getAllowQueueing()
Optional. Whether new scheduled runs can be queued when max_concurrent_runs
limit is reached. If set to true, new runs will be queued instead of
skipped. Default to false.
bool allow_queueing = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | The allowQueueing.
|
public boolean getCatchUp()
Output only. Whether to backfill missed runs when the schedule is resumed
from PAUSED state. If set to true, all missed runs will be scheduled. New
runs will be scheduled after the backfill is complete. Default to false.
bool catch_up = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | The catchUp.
|
public CreatePipelineJobRequest getCreatePipelineJobRequest()
Request for
PipelineService.CreatePipelineJob.
CreatePipelineJobRequest.parent field is required (format:
projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;
public CreatePipelineJobRequestOrBuilder getCreatePipelineJobRequestOrBuilder()
Request for
PipelineService.CreatePipelineJob.
CreatePipelineJobRequest.parent field is required (format:
projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;
public Timestamp getCreateTime()
Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
runs. To explicitly set a timezone to the cron tab, apply a prefix in the
cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
database. For example, "CRON_TZ=America/New_York 1 * * * *", or
"TZ=America/New_York 1 * * * *".
string cron = 10;
| Returns |
|---|
| Type | Description |
String | The cron.
|
public ByteString getCronBytes()
Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
runs. To explicitly set a timezone to the cron tab, apply a prefix in the
cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
database. For example, "CRON_TZ=America/New_York 1 * * * *", or
"TZ=America/New_York 1 * * * *".
string cron = 10;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for cron.
|
public Schedule getDefaultInstanceForType()
public String getDisplayName()
Required. User provided name of the Schedule.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. User provided name of the Schedule.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
public Timestamp getEndTime()
Optional. Timestamp after which no new runs can be scheduled.
If specified, The schedule will be completed when either
end_time is reached or when scheduled_run_count >= max_run_count.
If not specified, new runs will keep getting scheduled until this Schedule
is paused or deleted. Already scheduled runs will be allowed to complete.
Unset if not specified.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
public TimestampOrBuilder getEndTimeOrBuilder()
Optional. Timestamp after which no new runs can be scheduled.
If specified, The schedule will be completed when either
end_time is reached or when scheduled_run_count >= max_run_count.
If not specified, new runs will keep getting scheduled until this Schedule
is paused or deleted. Already scheduled runs will be allowed to complete.
Unset if not specified.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
public Timestamp getLastPauseTime()
Output only. Timestamp when this Schedule was last paused.
Unset if never paused.
.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The lastPauseTime.
|
public TimestampOrBuilder getLastPauseTimeOrBuilder()
Output only. Timestamp when this Schedule was last paused.
Unset if never paused.
.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Timestamp getLastResumeTime()
Output only. Timestamp when this Schedule was last resumed.
Unset if never resumed from pause.
.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The lastResumeTime.
|
public TimestampOrBuilder getLastResumeTimeOrBuilder()
Output only. Timestamp when this Schedule was last resumed.
Unset if never resumed from pause.
.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Schedule.RunResponse getLastScheduledRunResponse()
Output only. Response of the last scheduled run.
This is the response for starting the scheduled requests and not the
execution of the operations/jobs created by the requests (if applicable).
Unset if no run has been scheduled yet.
.google.cloud.aiplatform.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Schedule.RunResponseOrBuilder getLastScheduledRunResponseOrBuilder()
Output only. Response of the last scheduled run.
This is the response for starting the scheduled requests and not the
execution of the operations/jobs created by the requests (if applicable).
Unset if no run has been scheduled yet.
.google.cloud.aiplatform.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
public long getMaxConcurrentRunCount()
Required. Maximum number of runs that can be started concurrently for this
Schedule. This is the limit for starting the scheduled requests and not the
execution of the operations/jobs created by the requests (if applicable).
int64 max_concurrent_run_count = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
long | The maxConcurrentRunCount.
|
public long getMaxRunCount()
Optional. Maximum run count of the schedule.
If specified, The schedule will be completed when either
started_run_count >= max_run_count or when end_time is reached.
If not specified, new runs will keep getting scheduled until this Schedule
is paused or deleted. Already scheduled runs will be allowed to complete.
Unset if not specified.
int64 max_run_count = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
long | The maxRunCount.
|
Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
public Timestamp getNextRunTime()
Output only. Timestamp when this Schedule should schedule the next run.
Having a next_run_time in the past means the runs are being started
behind schedule.
.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The nextRunTime.
|
public TimestampOrBuilder getNextRunTimeOrBuilder()
Output only. Timestamp when this Schedule should schedule the next run.
Having a next_run_time in the past means the runs are being started
behind schedule.
.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<Schedule> getParserForType()
Overrides
public Schedule.RequestCase getRequestCase()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
public Timestamp getStartTime()
Optional. Timestamp after which the first run can be scheduled.
Default to Schedule create time if not specified.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Timestamp | The startTime.
|
public TimestampOrBuilder getStartTimeOrBuilder()
Optional. Timestamp after which the first run can be scheduled.
Default to Schedule create time if not specified.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];
public long getStartedRunCount()
Output only. The number of runs started by this schedule.
int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
long | The startedRunCount.
|
public Schedule.State getState()
Output only. The state of this Schedule.
.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getStateValue()
Output only. The state of this Schedule.
.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
public Schedule.TimeSpecificationCase getTimeSpecificationCase()
public Timestamp getUpdateTime()
Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreatePipelineJobRequest()
Request for
PipelineService.CreatePipelineJob.
CreatePipelineJobRequest.parent field is required (format:
projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns |
|---|
| Type | Description |
boolean | Whether the createPipelineJobRequest field is set.
|
public boolean hasCreateTime()
Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
runs. To explicitly set a timezone to the cron tab, apply a prefix in the
cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}".
The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone
database. For example, "CRON_TZ=America/New_York 1 * * * *", or
"TZ=America/New_York 1 * * * *".
string cron = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the cron field is set.
|
public boolean hasEndTime()
Optional. Timestamp after which no new runs can be scheduled.
If specified, The schedule will be completed when either
end_time is reached or when scheduled_run_count >= max_run_count.
If not specified, new runs will keep getting scheduled until this Schedule
is paused or deleted. Already scheduled runs will be allowed to complete.
Unset if not specified.
.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasLastPauseTime()
Output only. Timestamp when this Schedule was last paused.
Unset if never paused.
.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the lastPauseTime field is set.
|
public boolean hasLastResumeTime()
Output only. Timestamp when this Schedule was last resumed.
Unset if never resumed from pause.
.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the lastResumeTime field is set.
|
public boolean hasLastScheduledRunResponse()
Output only. Response of the last scheduled run.
This is the response for starting the scheduled requests and not the
execution of the operations/jobs created by the requests (if applicable).
Unset if no run has been scheduled yet.
.google.cloud.aiplatform.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the lastScheduledRunResponse field is set.
|
public boolean hasNextRunTime()
Output only. Timestamp when this Schedule should schedule the next run.
Having a next_run_time in the past means the runs are being started
behind schedule.
.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the nextRunTime field is set.
|
public boolean hasStartTime()
Optional. Timestamp after which the first run can be scheduled.
Default to Schedule create time if not specified.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
public boolean hasUpdateTime()
Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public Schedule.Builder newBuilderForType()
protected Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Schedule.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
