Schedule (proto-google-cloud-aiplatform-v1 3.63.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1.Schedule

All Implemented Interfaces:

ScheduleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Schedule
extends com.google.protobuf.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
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Schedule.Builder` An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
`static class`	`Schedule.RequestCase`
`static class`	`Schedule.RunResponse` Status of a scheduled run.
`static interface`	`Schedule.RunResponseOrBuilder`
`static class`	`Schedule.State` Possible state of the schedule.
`static class`	`Schedule.TimeSpecificationCase`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOW_QUEUEING_FIELD_NUMBER`
`static int`	`CATCH_UP_FIELD_NUMBER`
`static int`	`CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER`
`static int`	`CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`CRON_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`END_TIME_FIELD_NUMBER`
`static int`	`LAST_PAUSE_TIME_FIELD_NUMBER`
`static int`	`LAST_RESUME_TIME_FIELD_NUMBER`
`static int`	`LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER`
`static int`	`MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER`
`static int`	`MAX_RUN_COUNT_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`NEXT_RUN_TIME_FIELD_NUMBER`
`static int`	`START_TIME_FIELD_NUMBER`
`static int`	`STARTED_RUN_COUNT_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`getAllowQueueing()` Optional.
`boolean`	`getCatchUp()` Output only.
`CreateNotebookExecutionJobRequest`	`getCreateNotebookExecutionJobRequest()` Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
`CreateNotebookExecutionJobRequestOrBuilder`	`getCreateNotebookExecutionJobRequestOrBuilder()` Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
`CreatePipelineJobRequest`	`getCreatePipelineJobRequest()` Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
`CreatePipelineJobRequestOrBuilder`	`getCreatePipelineJobRequestOrBuilder()` Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.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.
`static Schedule`	`getDefaultInstance()`
`Schedule`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<Schedule>`	`getParserForType()`
`Schedule.RequestCase`	`getRequestCase()`
`int`	`getSerializedSize()`
`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`	`hasCreateNotebookExecutionJobRequest()` Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
`boolean`	`hasCreatePipelineJobRequest()` Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasCron()` Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.
`boolean`	`hasEndTime()` Optional.
`int`	`hashCode()`
`boolean`	`hasLastPauseTime()` Output only.
`boolean`	`hasLastResumeTime()` Output only.
`boolean`	`hasLastScheduledRunResponse()` Output only.
`boolean`	`hasNextRunTime()` Output only.
`boolean`	`hasStartTime()` Optional.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Schedule.Builder`	`newBuilder()`
`static Schedule.Builder`	`newBuilder(Schedule prototype)`
`Schedule.Builder`	`newBuilderForType()`
`protected Schedule.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Schedule`	`parseDelimitedFrom(InputStream input)`
`static Schedule`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Schedule`	`parseFrom(byte[] data)`
`static Schedule`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Schedule`	`parseFrom(ByteBuffer data)`
`static Schedule`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Schedule`	`parseFrom(com.google.protobuf.ByteString data)`
`static Schedule`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Schedule`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Schedule`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Schedule`	`parseFrom(InputStream input)`
`static Schedule`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Schedule>`	`parser()`
`Schedule.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- CRON_FIELD_NUMBER
```
public static final int CRON_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER
```
public static final int CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER
```
public static final int CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- START_TIME_FIELD_NUMBER
```
public static final int START_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- END_TIME_FIELD_NUMBER
```
public static final int END_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAX_RUN_COUNT_FIELD_NUMBER
```
public static final int MAX_RUN_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STARTED_RUN_COUNT_FIELD_NUMBER
```
public static final int STARTED_RUN_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NEXT_RUN_TIME_FIELD_NUMBER
```
public static final int NEXT_RUN_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_PAUSE_TIME_FIELD_NUMBER
```
public static final int LAST_PAUSE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_RESUME_TIME_FIELD_NUMBER
```
public static final int LAST_RESUME_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER
```
public static final int MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLOW_QUEUEING_FIELD_NUMBER
```
public static final int ALLOW_QUEUEING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CATCH_UP_FIELD_NUMBER
```
public static final int CATCH_UP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER
```
public static final int LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTimeSpecificationCase
```
public Schedule.TimeSpecificationCase getTimeSpecificationCase()
```
Specified by:

getTimeSpecificationCase in interface ScheduleOrBuilder

getRequestCase
```
public Schedule.RequestCase getRequestCase()
```
Specified by:

getRequestCase in interface ScheduleOrBuilder

hasCron

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

Specified by:: hasCron in interface ScheduleOrBuilder
Returns:: Whether the cron field is set.

getCron

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

Specified by:: getCron in interface ScheduleOrBuilder
Returns:: The cron.

getCronBytes

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

Specified by:: getCronBytes in interface ScheduleOrBuilder
Returns:: The bytes for cron.

hasCreatePipelineJobRequest

public boolean hasCreatePipelineJobRequest()

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

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

Specified by:: hasCreatePipelineJobRequest in interface ScheduleOrBuilder
Returns:: Whether the createPipelineJobRequest field is set.

getCreatePipelineJobRequest

public CreatePipelineJobRequest getCreatePipelineJobRequest()

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

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

Specified by:: getCreatePipelineJobRequest in interface ScheduleOrBuilder
Returns:: The createPipelineJobRequest.

getCreatePipelineJobRequestOrBuilder

public CreatePipelineJobRequestOrBuilder getCreatePipelineJobRequestOrBuilder()

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

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

Specified by:: getCreatePipelineJobRequestOrBuilder in interface ScheduleOrBuilder

hasCreateNotebookExecutionJobRequest
```
public boolean hasCreateNotebookExecutionJobRequest()
```
```
 Request for
 [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
 
```
.google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;
Specified by:

hasCreateNotebookExecutionJobRequest in interface ScheduleOrBuilder

Returns:

Whether the createNotebookExecutionJobRequest field is set.

getCreateNotebookExecutionJobRequest
```
public CreateNotebookExecutionJobRequest getCreateNotebookExecutionJobRequest()
```
```
 Request for
 [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
 
```
.google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;
Specified by:

getCreateNotebookExecutionJobRequest in interface ScheduleOrBuilder

Returns:

The createNotebookExecutionJobRequest.

getCreateNotebookExecutionJobRequestOrBuilder

public CreateNotebookExecutionJobRequestOrBuilder getCreateNotebookExecutionJobRequestOrBuilder()

 Request for
 [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].


 .google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;

Specified by:: getCreateNotebookExecutionJobRequestOrBuilder in interface ScheduleOrBuilder

getName
```
public String getName()
```
```
 Immutable. The resource name of the Schedule.
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getName in interface ScheduleOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Immutable. The resource name of the Schedule.
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getNameBytes in interface ScheduleOrBuilder

Returns:

The bytes for name.

getDisplayName

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

Specified by:: getDisplayName in interface ScheduleOrBuilder
Returns:: The displayName.

getDisplayNameBytes

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

Specified by:: getDisplayNameBytes in interface ScheduleOrBuilder
Returns:: The bytes for displayName.

hasStartTime
```
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];
Specified by:

hasStartTime in interface ScheduleOrBuilder

Returns:

Whether the startTime field is set.

getStartTime

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

Specified by:: getStartTime in interface ScheduleOrBuilder
Returns:: The startTime.

getStartTimeOrBuilder

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

Specified by:: getStartTimeOrBuilder in interface ScheduleOrBuilder

hasEndTime

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

Specified by:: hasEndTime in interface ScheduleOrBuilder
Returns:: Whether the endTime field is set.

getEndTime

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

Specified by:: getEndTime in interface ScheduleOrBuilder
Returns:: The endTime.

getEndTimeOrBuilder

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

Specified by:: getEndTimeOrBuilder in interface ScheduleOrBuilder

getMaxRunCount

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

Specified by:: getMaxRunCount in interface ScheduleOrBuilder
Returns:: The maxRunCount.

getStartedRunCount
```
public long getStartedRunCount()
```
```
 Output only. The number of runs started by this schedule.
 
```
int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStartedRunCount in interface ScheduleOrBuilder

Returns:

The startedRunCount.

getStateValue
```
public int getStateValue()
```
```
 Output only. The state of this Schedule.
 
```
.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStateValue in interface ScheduleOrBuilder

Returns:

The enum numeric value on the wire for state.

getState
```
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];
Specified by:

getState in interface ScheduleOrBuilder

Returns:

The state.

hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Timestamp when this Schedule was created.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasCreateTime in interface ScheduleOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public 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];
Specified by:

getCreateTime in interface ScheduleOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public 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];
Specified by:

getCreateTimeOrBuilder in interface ScheduleOrBuilder

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Timestamp when this Schedule was updated.
 
```
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasUpdateTime in interface ScheduleOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public 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];
Specified by:

getUpdateTime in interface ScheduleOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public 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];
Specified by:

getUpdateTimeOrBuilder in interface ScheduleOrBuilder

hasNextRunTime
```
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];
Specified by:

hasNextRunTime in interface ScheduleOrBuilder

Returns:

Whether the nextRunTime field is set.

getNextRunTime

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

Specified by:: getNextRunTime in interface ScheduleOrBuilder
Returns:: The nextRunTime.

getNextRunTimeOrBuilder

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

Specified by:: getNextRunTimeOrBuilder in interface ScheduleOrBuilder

hasLastPauseTime
```
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];
Specified by:

hasLastPauseTime in interface ScheduleOrBuilder

Returns:

Whether the lastPauseTime field is set.

getLastPauseTime
```
public 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];
Specified by:

getLastPauseTime in interface ScheduleOrBuilder

Returns:

The lastPauseTime.

getLastPauseTimeOrBuilder
```
public 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];
Specified by:

getLastPauseTimeOrBuilder in interface ScheduleOrBuilder

hasLastResumeTime
```
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];
Specified by:

hasLastResumeTime in interface ScheduleOrBuilder

Returns:

Whether the lastResumeTime field is set.

getLastResumeTime
```
public 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];
Specified by:

getLastResumeTime in interface ScheduleOrBuilder

Returns:

The lastResumeTime.

getLastResumeTimeOrBuilder
```
public 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];
Specified by:

getLastResumeTimeOrBuilder in interface ScheduleOrBuilder

getMaxConcurrentRunCount

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

Specified by:: getMaxConcurrentRunCount in interface ScheduleOrBuilder
Returns:: The maxConcurrentRunCount.

getAllowQueueing

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

Specified by:: getAllowQueueing in interface ScheduleOrBuilder
Returns:: The allowQueueing.

getCatchUp

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

Specified by:: getCatchUp in interface ScheduleOrBuilder
Returns:: The catchUp.

hasLastScheduledRunResponse

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

Specified by:: hasLastScheduledRunResponse in interface ScheduleOrBuilder
Returns:: Whether the lastScheduledRunResponse field is set.

getLastScheduledRunResponse

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

Specified by:: getLastScheduledRunResponse in interface ScheduleOrBuilder
Returns:: The lastScheduledRunResponse.

getLastScheduledRunResponseOrBuilder

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

Specified by:: getLastScheduledRunResponseOrBuilder in interface ScheduleOrBuilder

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Schedule parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:: com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schedule parseFrom(InputStream input)
                          throws IOException

Throws:: IOException

parseFrom

public static Schedule parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:: IOException

parseDelimitedFrom

public static Schedule parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:: IOException

parseDelimitedFrom

public static Schedule parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:: IOException

parseFrom

public static Schedule parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:: IOException

parseFrom

public static Schedule parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:: IOException

newBuilderForType
```
public Schedule.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Schedule.Builder newBuilder()

newBuilder

public static Schedule.Builder newBuilder(Schedule prototype)

toBuilder
```
public Schedule.Builder toBuilder()
```
Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Schedule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Schedule getDefaultInstance()

parser

public static com.google.protobuf.Parser<Schedule> parser()

getParserForType
```
public com.google.protobuf.Parser<Schedule> getParserForType()
```
Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType
```
public Schedule getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class Schedule

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

CRON_FIELD_NUMBER

CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER

CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER

NAME_FIELD_NUMBER

DISPLAY_NAME_FIELD_NUMBER

START_TIME_FIELD_NUMBER

END_TIME_FIELD_NUMBER

MAX_RUN_COUNT_FIELD_NUMBER

STARTED_RUN_COUNT_FIELD_NUMBER

STATE_FIELD_NUMBER

CREATE_TIME_FIELD_NUMBER

UPDATE_TIME_FIELD_NUMBER

NEXT_RUN_TIME_FIELD_NUMBER

LAST_PAUSE_TIME_FIELD_NUMBER

LAST_RESUME_TIME_FIELD_NUMBER

MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER

ALLOW_QUEUEING_FIELD_NUMBER

CATCH_UP_FIELD_NUMBER

LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER

Method Detail

newInstance

getDescriptor

internalGetFieldAccessorTable

getTimeSpecificationCase

getRequestCase

hasCron

getCron

getCronBytes

hasCreatePipelineJobRequest

getCreatePipelineJobRequest

getCreatePipelineJobRequestOrBuilder

hasCreateNotebookExecutionJobRequest

getCreateNotebookExecutionJobRequest

getCreateNotebookExecutionJobRequestOrBuilder

getName

getNameBytes

getDisplayName

getDisplayNameBytes

hasStartTime

getStartTime

getStartTimeOrBuilder

hasEndTime

getEndTime

getEndTimeOrBuilder

getMaxRunCount

getStartedRunCount

getStateValue

getState

hasCreateTime

getCreateTime

getCreateTimeOrBuilder

hasUpdateTime

getUpdateTime

getUpdateTimeOrBuilder

hasNextRunTime

getNextRunTime

getNextRunTimeOrBuilder

hasLastPauseTime

getLastPauseTime

getLastPauseTimeOrBuilder

hasLastResumeTime

getLastResumeTime

getLastResumeTimeOrBuilder

getMaxConcurrentRunCount