Package com.google.cloud.notebooks.v1

Class 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
     The definition of a schedule.
    Protobuf type google.cloud.notebooks.v1.Schedule
    See Also:
    Serialized Form

    • 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

      • 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];
        Specified by:
        getName in interface ScheduleOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface ScheduleOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getDisplayName in interface ScheduleOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.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];
        Specified by:
        getDisplayNameBytes in interface ScheduleOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         A brief description of this environment.
        string description = 3;
        Specified by:
        getDescription in interface ScheduleOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A brief description of this environment.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface ScheduleOrBuilder
        Returns:
        The bytes for description.

      • getStateValue

        public int getStateValue()
        .google.cloud.notebooks.v1.Schedule.State state = 4;
        Specified by:
        getStateValue in interface ScheduleOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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;
        Specified by:
        getCronSchedule in interface ScheduleOrBuilder
        Returns:
        The cronSchedule.

      • getCronScheduleBytes

        public com.google.protobuf.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;
        Specified by:
        getCronScheduleBytes in interface ScheduleOrBuilder
        Returns:
        The bytes for cronSchedule.

      • 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;
        Specified by:
        getTimeZone in interface ScheduleOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.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;
        Specified by:
        getTimeZoneBytes in interface ScheduleOrBuilder
        Returns:
        The bytes for timeZone.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.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. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ScheduleOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ScheduleOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Time the schedule was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.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. Time the schedule was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ScheduleOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Time the schedule was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ScheduleOrBuilder

      • hasExecutionTemplate

        public boolean hasExecutionTemplate()
         Notebook Execution Template corresponding to this schedule.
        .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
        Specified by:
        hasExecutionTemplate in interface ScheduleOrBuilder
        Returns:
        Whether the executionTemplate field is set.

      • getExecutionTemplate

        public ExecutionTemplate getExecutionTemplate()
         Notebook Execution Template corresponding to this schedule.
        .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
        Specified by:
        getExecutionTemplate in interface ScheduleOrBuilder
        Returns:
        The executionTemplate.

      • 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];
        Specified by:
        getRecentExecutionsList in interface ScheduleOrBuilder

      • 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];
        Specified by:
        getRecentExecutionsOrBuilderList in interface ScheduleOrBuilder

      • 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];
        Specified by:
        getRecentExecutionsCount in interface ScheduleOrBuilder

      • getRecentExecutions

        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];
        Specified by:
        getRecentExecutions in interface ScheduleOrBuilder

      • getRecentExecutionsOrBuilder

        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];
        Specified by:
        getRecentExecutionsOrBuilder 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​(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

      • 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