- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class Schedule.Builder extends GeneratedMessageV3.Builder<Schedule.Builder> implements ScheduleOrBuilderAn 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.v1beta1.Schedule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Schedule.BuilderImplements
ScheduleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Schedule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
build()
public Schedule build()| Returns | |
|---|---|
| Type | Description |
Schedule | |
buildPartial()
public Schedule buildPartial()| Returns | |
|---|---|
| Type | Description |
Schedule | |
clear()
public Schedule.Builder clear()| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearAllowQueueing()
public Schedule.Builder clearAllowQueueing()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 |
Schedule.Builder | This builder for chaining. |
clearCatchUp()
public Schedule.Builder clearCatchUp()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 |
Schedule.Builder | This builder for chaining. |
clearCreatePipelineJobRequest()
public Schedule.Builder clearCreatePipelineJobRequest()Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearCreateTime()
public Schedule.Builder clearCreateTime()Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearCron()
public Schedule.Builder clearCron()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 |
Schedule.Builder | This builder for chaining. |
clearDisplayName()
public Schedule.Builder clearDisplayName()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 |
Schedule.Builder | This builder for chaining. |
clearEndTime()
public Schedule.Builder clearEndTime()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 |
Schedule.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Schedule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearLastPauseTime()
public Schedule.Builder clearLastPauseTime()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 |
Schedule.Builder | |
clearLastResumeTime()
public Schedule.Builder clearLastResumeTime()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 |
Schedule.Builder | |
clearMaxConcurrentRunCount()
public Schedule.Builder clearMaxConcurrentRunCount()Required. Maximum number of runs that can be executed concurrently for this Schedule.
int64 max_concurrent_run_count = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
clearMaxRunCount()
public Schedule.Builder clearMaxRunCount()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 |
Schedule.Builder | This builder for chaining. |
clearName()
public Schedule.Builder clearName()Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
clearNextRunTime()
public Schedule.Builder clearNextRunTime()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 |
Schedule.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Schedule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearRequest()
public Schedule.Builder clearRequest()| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clearStartTime()
public Schedule.Builder clearStartTime()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 |
Schedule.Builder | |
clearStartedRunCount()
public Schedule.Builder clearStartedRunCount()Output only. The number of runs started by this schedule.
int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
clearState()
public Schedule.Builder clearState()Output only. The state of this Schedule.
.google.cloud.aiplatform.v1beta1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
clearTimeSpecification()
public Schedule.Builder clearTimeSpecification()| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
clone()
public Schedule.Builder clone()| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | 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];
| Returns | |
|---|---|
| Type | Description |
boolean | The catchUp. |
getCreatePipelineJobRequest()
public CreatePipelineJobRequest getCreatePipelineJobRequest()Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns | |
|---|---|
| Type | Description |
CreatePipelineJobRequest | The createPipelineJobRequest. |
getCreatePipelineJobRequestBuilder()
public CreatePipelineJobRequest.Builder getCreatePipelineJobRequestBuilder()Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns | |
|---|---|
| Type | Description |
CreatePipelineJobRequest.Builder | |
getCreatePipelineJobRequestOrBuilder()
public CreatePipelineJobRequestOrBuilder getCreatePipelineJobRequestOrBuilder()Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns | |
|---|---|
| Type | Description |
CreatePipelineJobRequestOrBuilder | |
getCreateTime()
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public 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 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 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. |
getDefaultInstanceForType()
public Schedule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Schedule | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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];
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
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. |
getEndTime()
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];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The endTime. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()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 |
Builder | |
getEndTimeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getLastPauseTime()
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. |
getLastPauseTimeBuilder()
public Timestamp.Builder getLastPauseTimeBuilder()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 |
Builder | |
getLastPauseTimeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getLastResumeTime()
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. |
getLastResumeTimeBuilder()
public Timestamp.Builder getLastResumeTimeBuilder()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 |
Builder | |
getLastResumeTimeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getMaxConcurrentRunCount()
public long getMaxConcurrentRunCount()Required. Maximum number of runs that can be executed concurrently for this Schedule.
int64 max_concurrent_run_count = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
long | The maxConcurrentRunCount. |
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];
| Returns | |
|---|---|
| Type | Description |
long | The maxRunCount. |
getName()
public String getName()Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
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. |
getNextRunTime()
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. |
getNextRunTimeBuilder()
public Timestamp.Builder getNextRunTimeBuilder()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 |
Builder | |
getNextRunTimeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getRequestCase()
public Schedule.RequestCase getRequestCase()| Returns | |
|---|---|
| Type | Description |
Schedule.RequestCase | |
getStartTime()
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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()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 |
Builder | |
getStartTimeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
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];
| Returns | |
|---|---|
| Type | Description |
long | The startedRunCount. |
getState()
public 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 | |
|---|---|
| Type | Description |
Schedule.State | The state. |
getStateValue()
public int getStateValue()Output only. The state of this Schedule.
.google.cloud.aiplatform.v1beta1.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 Schedule.TimeSpecificationCase getTimeSpecificationCase()| Returns | |
|---|---|
| Type | Description |
Schedule.TimeSpecificationCase | |
hasCreatePipelineJobRequest()
public boolean hasCreatePipelineJobRequest()Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createPipelineJobRequest field is set. |
hasCreateTime()
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. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the cron field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the endTime field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the lastPauseTime field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the lastResumeTime field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the nextRunTime field is set. |
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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the startTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreatePipelineJobRequest(CreatePipelineJobRequest value)
public Schedule.Builder mergeCreatePipelineJobRequest(CreatePipelineJobRequest value)Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Parameter | |
|---|---|
| Name | Description |
value | CreatePipelineJobRequest |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeCreateTime(Timestamp value)
public Schedule.Builder mergeCreateTime(Timestamp value)Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeEndTime(Timestamp value)
public Schedule.Builder mergeEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeFrom(Schedule other)
public Schedule.Builder mergeFrom(Schedule other)| Parameter | |
|---|---|
| Name | Description |
other | Schedule |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Schedule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Schedule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeLastPauseTime(Timestamp value)
public Schedule.Builder mergeLastPauseTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeLastResumeTime(Timestamp value)
public Schedule.Builder mergeLastResumeTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeNextRunTime(Timestamp value)
public Schedule.Builder mergeNextRunTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeStartTime(Timestamp value)
public Schedule.Builder mergeStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Schedule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setAllowQueueing(boolean value)
public Schedule.Builder setAllowQueueing(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe allowQueueing to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setCatchUp(boolean value)
public Schedule.Builder setCatchUp(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe catchUp to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setCreatePipelineJobRequest(CreatePipelineJobRequest value)
public Schedule.Builder setCreatePipelineJobRequest(CreatePipelineJobRequest value)Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Parameter | |
|---|---|
| Name | Description |
value | CreatePipelineJobRequest |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setCreatePipelineJobRequest(CreatePipelineJobRequest.Builder builderForValue)
public Schedule.Builder setCreatePipelineJobRequest(CreatePipelineJobRequest.Builder builderForValue)Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CreatePipelineJobRequest.Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setCreateTime(Timestamp value)
public Schedule.Builder setCreateTime(Timestamp value)Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Schedule.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setCron(String value)
public Schedule.Builder setCron(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe cron to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setCronBytes(ByteString value)
public Schedule.Builder setCronBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for cron to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setDisplayName(String value)
public Schedule.Builder setDisplayName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Schedule.Builder setDisplayNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setEndTime(Timestamp value)
public Schedule.Builder setEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setEndTime(Timestamp.Builder builderForValue)
public Schedule.Builder setEndTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Schedule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setLastPauseTime(Timestamp value)
public Schedule.Builder setLastPauseTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setLastPauseTime(Timestamp.Builder builderForValue)
public Schedule.Builder setLastPauseTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setLastResumeTime(Timestamp value)
public Schedule.Builder setLastResumeTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setLastResumeTime(Timestamp.Builder builderForValue)
public Schedule.Builder setLastResumeTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setMaxConcurrentRunCount(long value)
public Schedule.Builder setMaxConcurrentRunCount(long value)Required. Maximum number of runs that can be executed concurrently for this Schedule.
int64 max_concurrent_run_count = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | longThe maxConcurrentRunCount to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setMaxRunCount(long value)
public Schedule.Builder setMaxRunCount(long value)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];
| Parameter | |
|---|---|
| Name | Description |
value | longThe maxRunCount to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setName(String value)
public Schedule.Builder setName(String value)Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Schedule.Builder setNameBytes(ByteString value)Output only. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setNextRunTime(Timestamp value)
public Schedule.Builder setNextRunTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setNextRunTime(Timestamp.Builder builderForValue)
public Schedule.Builder setNextRunTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Schedule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setStartTime(Timestamp value)
public Schedule.Builder setStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setStartTime(Timestamp.Builder builderForValue)
public Schedule.Builder setStartTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |
setStartedRunCount(long value)
public Schedule.Builder setStartedRunCount(long value)Output only. The number of runs started by this schedule.
int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | longThe startedRunCount to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setState(Schedule.State value)
public Schedule.Builder setState(Schedule.State value)Output only. The state of this Schedule.
.google.cloud.aiplatform.v1beta1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Schedule.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setStateValue(int value)
public Schedule.Builder setStateValue(int value)Output only. The state of this Schedule.
.google.cloud.aiplatform.v1beta1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Schedule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Schedule.Builder | |