public final class Schedule extends GeneratedMessageV3 implements ScheduleOrBuilder
The definition of a schedule.
Protobuf type google.cloud.notebooks.v1.Schedule
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
CRON_SCHEDULE_FIELD_NUMBER
public static final int CRON_SCHEDULE_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EXECUTION_TEMPLATE_FIELD_NUMBER
public static final int EXECUTION_TEMPLATE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RECENT_EXECUTIONS_FIELD_NUMBER
public static final int RECENT_EXECUTIONS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Schedule getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Schedule.Builder newBuilder()
Returns
newBuilder(Schedule prototype)
public static Schedule.Builder newBuilder(Schedule prototype)
Parameter
Returns
public static Schedule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Schedule parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Schedule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Schedule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Schedule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Schedule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Schedule> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Time the schedule was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time the schedule was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCronSchedule()
public String getCronSchedule()
Cron-tab formatted schedule by which the job will execute.
Format: minute, hour, day of month, month, day of week,
e.g. 0 0 * * WED = every Wednesday
More examples: https://crontab.guru/examples.html
string cron_schedule = 5;
| Type | Description |
| String | The cronSchedule.
|
getCronScheduleBytes()
public ByteString getCronScheduleBytes()
Cron-tab formatted schedule by which the job will execute.
Format: minute, hour, day of month, month, day of week,
e.g. 0 0 * * WED = every Wednesday
More examples: https://crontab.guru/examples.html
string cron_schedule = 5;
| Type | Description |
| ByteString | The bytes for cronSchedule.
|
getDefaultInstanceForType()
public Schedule getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
A brief description of this environment.
string description = 3;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A brief description of this environment.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Output only. Display name used for UI purposes.
Name can only contain alphanumeric characters, hyphens '-',
and underscores '_'.
string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Output only. Display name used for UI purposes.
Name can only contain alphanumeric characters, hyphens '-',
and underscores '_'.
string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for displayName.
|
getExecutionTemplate()
public ExecutionTemplate getExecutionTemplate()
Notebook Execution Template corresponding to this schedule.
.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
getExecutionTemplateOrBuilder()
public ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder()
Notebook Execution Template corresponding to this schedule.
.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
getName()
Output only. The name of this schedule. Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The name of this schedule. Format:
projects/{project_id}/locations/{location}/schedules/{schedule_id}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getParserForType()
public Parser<Schedule> getParserForType()
Returns
Overrides
getRecentExecutions(int index)
public Execution getRecentExecutions(int index)
Output only. The most recent execution names triggered from this schedule and their
corresponding states.
repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRecentExecutionsCount()
public int getRecentExecutionsCount()
Output only. The most recent execution names triggered from this schedule and their
corresponding states.
repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRecentExecutionsList()
public List<Execution> getRecentExecutionsList()
Output only. The most recent execution names triggered from this schedule and their
corresponding states.
repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRecentExecutionsOrBuilder(int index)
public ExecutionOrBuilder getRecentExecutionsOrBuilder(int index)
Output only. The most recent execution names triggered from this schedule and their
corresponding states.
repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRecentExecutionsOrBuilderList()
public List<? extends ExecutionOrBuilder> getRecentExecutionsOrBuilderList()
Output only. The most recent execution names triggered from this schedule and their
corresponding states.
repeated .google.cloud.notebooks.v1.Execution recent_executions = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.notebooks.v1.ExecutionOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public Schedule.State getState()
.google.cloud.notebooks.v1.Schedule.State state = 4;
getStateValue()
public int getStateValue()
.google.cloud.notebooks.v1.Schedule.State state = 4;
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getTimeZone()
public String getTimeZone()
Timezone on which the cron_schedule.
The value of this field must be a time zone name from the tz database.
TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Note that some time zones include a provision for daylight savings time.
The rules for daylight saving time are determined by the chosen tz.
For UTC use the string "utc". If a time zone is not specified,
the default will be in UTC (also known as GMT).
string time_zone = 6;
| Type | Description |
| String | The timeZone.
|
getTimeZoneBytes()
public ByteString getTimeZoneBytes()
Timezone on which the cron_schedule.
The value of this field must be a time zone name from the tz database.
TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Note that some time zones include a provision for daylight savings time.
The rules for daylight saving time are determined by the chosen tz.
For UTC use the string "utc". If a time zone is not specified,
the default will be in UTC (also known as GMT).
string time_zone = 6;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time the schedule was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time the schedule was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Time the schedule was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasExecutionTemplate()
public boolean hasExecutionTemplate()
Notebook Execution Template corresponding to this schedule.
.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
| Type | Description |
| boolean | Whether the executionTemplate field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time the schedule was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Schedule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Schedule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
