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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Proto library for google-cloud-notebooks
The newest version!
/*
 * 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/execution.proto

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

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

  /**
   *
   *
   *    * execute metadata including name, hardware spec, region, labels, etc.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;
   *
   * @return Whether the executionTemplate field is set.
   */
  boolean hasExecutionTemplate();
  /**
   *
   *
   *    * execute metadata including name, hardware spec, region, labels, etc.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;
   *
   * @return The executionTemplate.
   */
  com.google.cloud.notebooks.v1.ExecutionTemplate getExecutionTemplate();
  /**
   *
   *
   *    * execute metadata including name, hardware spec, region, labels, etc.
   * 
   *
   * .google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;
   */
  com.google.cloud.notebooks.v1.ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder();

  /**
   *
   *
   *    * Output only. The resource name of the execute. Format:
   * `projects/{project_id}/locations/{location}/executions/{execution_id}`
   * 
   *
   * string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. The resource name of the execute. Format:
   * `projects/{project_id}/locations/{location}/executions/{execution_id}`
   * 
   *
   * string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Output only. Name used for UI purposes.
   * Name can only contain alphanumeric characters and underscores '_'.
   * 
   *
   * string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Output only. Name used for UI purposes.
   * Name can only contain alphanumeric characters and underscores '_'.
   * 
   *
   * string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

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

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

  /**
   *
   *
   *    * Output only. Time the Execution was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   *    * Output only. Time the Execution was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  com.google.protobuf.Timestamp getUpdateTime();
  /**
   *
   *
   *    * Output only. Time the Execution was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   *    * Output only. State of the underlying AI Platform job.
   * 
   *
   * 
   * .google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * Output only. State of the underlying AI Platform job.
   * 
   *
   * 
   * .google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The state.
   */
  com.google.cloud.notebooks.v1.Execution.State getState();

  /**
   *
   *
   *    * Output notebook file generated by this execution
   * 
   *
   * string output_notebook_file = 8;
   *
   * @return The outputNotebookFile.
   */
  java.lang.String getOutputNotebookFile();
  /**
   *
   *
   *    * Output notebook file generated by this execution
   * 
   *
   * string output_notebook_file = 8;
   *
   * @return The bytes for outputNotebookFile.
   */
  com.google.protobuf.ByteString getOutputNotebookFileBytes();

  /**
   *
   *
   *    * Output only. The URI of the external job used to execute the notebook.
   * 
   *
   * string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The jobUri.
   */
  java.lang.String getJobUri();
  /**
   *
   *
   *    * Output only. The URI of the external job used to execute the notebook.
   * 
   *
   * string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for jobUri.
   */
  com.google.protobuf.ByteString getJobUriBytes();
}