com.google.cloud.aiplatform.v1beta1

Interface ScheduleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Schedule, Schedule.Builder

public interface ScheduleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowQueueing() Optional.
boolean	getCatchUp() Output only.
CreatePipelineJobRequest	getCreatePipelineJobRequest() Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
CreatePipelineJobRequestOrBuilder	getCreatePipelineJobRequestOrBuilder() Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getCron() Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.
com.google.protobuf.ByteString	getCronBytes() Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
com.google.protobuf.Timestamp	getEndTime() Optional.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Optional.
com.google.protobuf.Timestamp	getLastPauseTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastPauseTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getLastResumeTime() Output only.
com.google.protobuf.TimestampOrBuilder	getLastResumeTimeOrBuilder() Output only.
Schedule.RunResponse	getLastScheduledRunResponse() Output only.
Schedule.RunResponseOrBuilder	getLastScheduledRunResponseOrBuilder() Output only.
long	getMaxConcurrentRunCount() Required.
long	getMaxRunCount() Optional.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Timestamp	getNextRunTime() Output only.
com.google.protobuf.TimestampOrBuilder	getNextRunTimeOrBuilder() Output only.
Schedule.RequestCase	getRequestCase()
long	getStartedRunCount() Output only.
com.google.protobuf.Timestamp	getStartTime() Optional.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Optional.
Schedule.State	getState() Output only.
int	getStateValue() Output only.
Schedule.TimeSpecificationCase	getTimeSpecificationCase()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreatePipelineJobRequest() Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
boolean	hasCreateTime() Output only.
boolean	hasCron() Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.
boolean	hasEndTime() Optional.
boolean	hasLastPauseTime() Output only.
boolean	hasLastResumeTime() Output only.
boolean	hasLastScheduledRunResponse() Output only.
boolean	hasNextRunTime() Output only.
boolean	hasStartTime() Optional.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCron

boolean hasCron()

 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:

Whether the cron field is set.

getCron

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:

The cron.

getCronBytes

com.google.protobuf.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:

The bytes for cron.

hasCreatePipelineJobRequest

boolean hasCreatePipelineJobRequest()

 Request for
 [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
 CreatePipelineJobRequest.parent field is required (format:
 projects/{project}/locations/{location}).
 

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

Returns:

Whether the createPipelineJobRequest field is set.

getCreatePipelineJobRequest

CreatePipelineJobRequest getCreatePipelineJobRequest()

 Request for
 [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
 CreatePipelineJobRequest.parent field is required (format:
 projects/{project}/locations/{location}).
 

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

Returns:

The createPipelineJobRequest.

getCreatePipelineJobRequestOrBuilder

CreatePipelineJobRequestOrBuilder getCreatePipelineJobRequestOrBuilder()

 Request for
 [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
 CreatePipelineJobRequest.parent field is required (format:
 projects/{project}/locations/{location}).
 

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

getName

String getName()

 Immutable. The resource name of the Schedule.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Immutable. The resource name of the Schedule.
 

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

hasStartTime

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:

Whether the startTime field is set.

getStartTime

com.google.protobuf.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:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.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];

hasEndTime

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:

Whether the endTime field is set.

getEndTime

com.google.protobuf.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:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.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];

getMaxRunCount

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:

The maxRunCount.

getStartedRunCount

long getStartedRunCount()

 Output only. The number of runs started by this schedule.
 

int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The startedRunCount.

getStateValue

int getStateValue()

 Output only. The state of this Schedule.
 

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

Returns:

The enum numeric value on the wire for state.

getState

Schedule.State getState()

 Output only. The state of this Schedule.
 

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

Returns:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this Schedule was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this Schedule was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this Schedule was created.
 

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

hasUpdateTime

boolean hasUpdateTime()

 Output only. Timestamp when this Schedule was updated.
 

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

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Timestamp when this Schedule was updated.
 

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Timestamp when this Schedule was updated.
 

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

hasNextRunTime

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:

Whether the nextRunTime field is set.

getNextRunTime

com.google.protobuf.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:

The nextRunTime.

getNextRunTimeOrBuilder

com.google.protobuf.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];

hasLastPauseTime

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:

Whether the lastPauseTime field is set.

getLastPauseTime

com.google.protobuf.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:

The lastPauseTime.

getLastPauseTimeOrBuilder

com.google.protobuf.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];

hasLastResumeTime

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:

Whether the lastResumeTime field is set.

getLastResumeTime

com.google.protobuf.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:

The lastResumeTime.

getLastResumeTimeOrBuilder

com.google.protobuf.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];

getMaxConcurrentRunCount

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:

The maxConcurrentRunCount.

getAllowQueueing

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:

The allowQueueing.

getCatchUp

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:

The catchUp.

hasLastScheduledRunResponse

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.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the lastScheduledRunResponse field is set.

getLastScheduledRunResponse

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.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The lastScheduledRunResponse.

getLastScheduledRunResponseOrBuilder

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.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

getTimeSpecificationCase

Schedule.TimeSpecificationCase getTimeSpecificationCase()

getRequestCase

Schedule.RequestCase getRequestCase()