Interface ScheduleOrBuilder (3.42.0)

public interface ScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowQueueing()

public abstract 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.

getCatchUp()

public abstract 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.

getCreatePipelineJobRequest()

public abstract 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;

Returns
Type	Description
`CreatePipelineJobRequest`	The createPipelineJobRequest.

getCreatePipelineJobRequestOrBuilder()

public abstract 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;

Returns
Type	Description
`CreatePipelineJobRequestOrBuilder`

getCreateTime()

public abstract 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.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Schedule was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getCron()

public abstract String getCron()

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.

getCronBytes()

public abstract ByteString getCronBytes()

string cron = 10;

Returns
Type	Description
`ByteString`	The bytes for cron.

getDisplayName()

public abstract 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.

getDisplayNameBytes()

public abstract 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.

getEndTime()

public abstract 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];

Returns
Type	Description
`Timestamp`	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`TimestampOrBuilder`

getLastPauseTime()

public abstract 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.

getLastPauseTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

getLastResumeTime()

public abstract 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.

getLastResumeTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

getLastScheduledRunResponse()

public abstract 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];

Returns
Type	Description
`Schedule.RunResponse`	The lastScheduledRunResponse.

getLastScheduledRunResponseOrBuilder()

public abstract Schedule.RunResponseOrBuilder getLastScheduledRunResponseOrBuilder()

.google.cloud.aiplatform.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Schedule.RunResponseOrBuilder`

getMaxConcurrentRunCount()

public abstract 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.

getMaxRunCount()

public abstract 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.

getName()

public abstract String getName()

Immutable. The resource name of the Schedule.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The resource name of the Schedule.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for name.

getNextRunTime()

public abstract 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.

getNextRunTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

getRequestCase()

public abstract Schedule.RequestCase getRequestCase()

Returns
Type	Description
`Schedule.RequestCase`

getStartTime()

public abstract 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.

getStartTimeOrBuilder()

public abstract 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];

Returns
Type	Description
`TimestampOrBuilder`

getStartedRunCount()

public abstract 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.

getState()

public abstract Schedule.State getState()

Output only. The state of this Schedule.

.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Schedule.State`	The state.

getStateValue()

public abstract 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.

getTimeSpecificationCase()

public abstract Schedule.TimeSpecificationCase getTimeSpecificationCase()

Returns
Type	Description
`Schedule.TimeSpecificationCase`

getUpdateTime()

public abstract 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.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Schedule was updated.

.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasCreatePipelineJobRequest()

public abstract 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.

hasCreateTime()

public abstract 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.

hasCron()

public abstract boolean hasCron()

string cron = 10;

Returns
Type	Description
`boolean`	Whether the cron field is set.

hasEndTime()

public abstract boolean hasEndTime()

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the endTime field is set.

hasLastPauseTime()

public abstract 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.

hasLastResumeTime()

public abstract 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.

hasLastScheduledRunResponse()

public abstract boolean hasLastScheduledRunResponse()

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

hasNextRunTime()

public abstract 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.

hasStartTime()

public abstract 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.

hasUpdateTime()

public abstract 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.