• Home
• com.google.api.grpc
• proto-google-cloud-notebooks-v1
• 1.45.0
• source code
• ScheduleOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.notebooks.v1.ScheduleOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/notebooks/v1/schedule.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.notebooks.v1;

public interface ScheduleOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.Schedule)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * 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];
   *
   * @return The name.
   */
  java.lang.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];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * 
   * 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];
   *
   * @return The displayName.
   */
  java.lang.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];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   * 
   * A brief description of this environment.
   * 
   *
   * string description = 3;
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   * 
   * A brief description of this environment.
   * 
   *
   * string description = 3;
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   * .google.cloud.notebooks.v1.Schedule.State state = 4;
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   * .google.cloud.notebooks.v1.Schedule.State state = 4;
   *
   * @return The state.
   */
  com.google.cloud.notebooks.v1.Schedule.State getState();

  /**
   *
   *
   * 
   * 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;
   *
   * @return The cronSchedule.
   */
  java.lang.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;
   *
   * @return The bytes for cronSchedule.
   */
  com.google.protobuf.ByteString getCronScheduleBytes();

  /**
   *
   *
   * 
   * 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;
   *
   * @return The timeZone.
   */
  java.lang.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;
   *
   * @return The bytes for timeZone.
   */
  com.google.protobuf.ByteString getTimeZoneBytes();

  /**
   *
   *
   * 
   * Output only. Time the schedule was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   * 
   * Output only. Time the schedule was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   * 
   * Output only. Time the schedule was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   * 
   * Output only. Time the schedule was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   * 
   * Output only. Time the schedule was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   * 
   * Notebook Execution Template corresponding to this schedule.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
   *
   * @return Whether the executionTemplate field is set.
   */
  boolean hasExecutionTemplate();
  /**
   *
   *
   * 
   * Notebook Execution Template corresponding to this schedule.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
   *
   * @return The executionTemplate.
   */
  com.google.cloud.notebooks.v1.ExecutionTemplate getExecutionTemplate();
  /**
   *
   *
   * 
   * Notebook Execution Template corresponding to this schedule.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 9;
   */
  com.google.cloud.notebooks.v1.ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder();

  /**
   *
   *
   * 
   * 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];
   * 
   */
  java.util.List 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];
   * 
   */
  com.google.cloud.notebooks.v1.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];
   * 
   */
  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];
   * 
   */
  java.util.List
      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];
   * 
   */
  com.google.cloud.notebooks.v1.ExecutionOrBuilder getRecentExecutionsOrBuilder(int index);
}