Package com.google.cloud.notebooks.v1

Interface ScheduleOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Schedule, Schedule.Builder
    public interface ScheduleOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getDisplayName

        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:
        The displayName.

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • getDescription

        String getDescription()
         A brief description of this environment.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A brief description of this environment.
        string description = 3;
        Returns:
        The bytes for description.

      • getStateValue

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

      • getState

        Schedule.State getState()
        .google.cloud.notebooks.v1.Schedule.State state = 4;
        Returns:
        The state.

      • getCronSchedule

        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:
        The cronSchedule.

      • getCronScheduleBytes

        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;
        Returns:
        The bytes for cronSchedule.

      • getTimeZone

        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:
        The timeZone.

      • getTimeZoneBytes

        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;
        Returns:
        The bytes for timeZone.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time the schedule was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. Time the schedule was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • hasExecutionTemplate

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

      • getExecutionTemplate

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

      • getExecutionTemplateOrBuilder

        ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder()
         Notebook Execution Template corresponding to this schedule.
        .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;

      • getRecentExecutionsList

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

      • getRecentExecutions

        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

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

      • getRecentExecutionsOrBuilderList

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

      • getRecentExecutionsOrBuilder

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