Class Schedule (1.1.2)

Stay organized with collections Save and categorize content based on your preferences.
public final class Schedule extends GeneratedMessageV3 implements ScheduleOrBuilder

The definition of a schedule.

Protobuf type google.cloud.notebooks.v1.Schedule

Implements

ScheduleOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CRON_SCHEDULE_FIELD_NUMBER

public static final int CRON_SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_TEMPLATE_FIELD_NUMBER

public static final int EXECUTION_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RECENT_EXECUTIONS_FIELD_NUMBER

public static final int RECENT_EXECUTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Schedule getDefaultInstance()
Returns
TypeDescription
Schedule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Schedule.Builder newBuilder()
Returns
TypeDescription
Schedule.Builder

newBuilder(Schedule prototype)

public static Schedule.Builder newBuilder(Schedule prototype)
Parameter
NameDescription
prototypeSchedule
Returns
TypeDescription
Schedule.Builder

parseDelimitedFrom(InputStream input)

public static Schedule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Schedule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Schedule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Schedule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Schedule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Schedule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schedule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Schedule> parser()
Returns
TypeDescription
Parser<Schedule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the schedule was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the schedule was created.

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

Returns
TypeDescription
TimestampOrBuilder

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for cronSchedule.

getDefaultInstanceForType()

public Schedule getDefaultInstanceForType()
Returns
TypeDescription
Schedule

getDescription()

public String getDescription()

A brief description of this environment.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A brief description of this environment.

string description = 3;

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

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

Returns
TypeDescription
ByteString

The bytes for displayName.

getExecutionTemplate()

public ExecutionTemplate getExecutionTemplate()

Notebook Execution Template corresponding to this schedule.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

Returns
TypeDescription
ExecutionTemplate

The executionTemplate.

getExecutionTemplateOrBuilder()

public ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder()

Notebook Execution Template corresponding to this schedule.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

Returns
TypeDescription
ExecutionTemplateOrBuilder

getName()

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

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Schedule> getParserForType()
Returns
TypeDescription
Parser<Schedule>
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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Execution

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

Returns
TypeDescription
int

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

Returns
TypeDescription
List<Execution>

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ExecutionOrBuilder

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

Returns
TypeDescription
List<? extends com.google.cloud.notebooks.v1.ExecutionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Schedule.State getState()

.google.cloud.notebooks.v1.Schedule.State state = 4;

Returns
TypeDescription
Schedule.State

The state.

getStateValue()

public int getStateValue()

.google.cloud.notebooks.v1.Schedule.State state = 4;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for timeZone.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time the schedule was last updated.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the schedule was created.

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

Returns
TypeDescription
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;

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Schedule.Builder newBuilderForType()
Returns
TypeDescription
Schedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Schedule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Schedule.Builder toBuilder()
Returns
TypeDescription
Schedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException