com.google.cloud.notebooks.v1.ExecutionTemplateOrBuilder 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
Show all versions of proto-google-cloud-notebooks-v1 Show documentation
Proto library for google-cloud-notebooks
/*
* 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.4
package com.google.cloud.notebooks.v1;
public interface ExecutionTemplateOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.notebooks.v1.ExecutionTemplate)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Scale tier of the hardware used for notebook execution.
* DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
*
*
* @deprecated google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See
* google/cloud/notebooks/v1/execution.proto;l=151
* @return The enum numeric value on the wire for scaleTier.
*/
@java.lang.Deprecated
int getScaleTierValue();
/**
*
*
*
* Required. Scale tier of the hardware used for notebook execution.
* DEPRECATED Will be discontinued. As right now only CUSTOM is supported.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier scale_tier = 1 [deprecated = true, (.google.api.field_behavior) = REQUIRED];
*
*
* @deprecated google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See
* google/cloud/notebooks/v1/execution.proto;l=151
* @return The scaleTier.
*/
@java.lang.Deprecated
com.google.cloud.notebooks.v1.ExecutionTemplate.ScaleTier getScaleTier();
/**
*
*
*
* Specifies the type of virtual machine to use for your training
* job's master worker. You must specify this field when `scaleTier` is set to
* `CUSTOM`.
*
* You can use certain Compute Engine machine types directly in this field.
* The following types are supported:
*
* - `n1-standard-4`
* - `n1-standard-8`
* - `n1-standard-16`
* - `n1-standard-32`
* - `n1-standard-64`
* - `n1-standard-96`
* - `n1-highmem-2`
* - `n1-highmem-4`
* - `n1-highmem-8`
* - `n1-highmem-16`
* - `n1-highmem-32`
* - `n1-highmem-64`
* - `n1-highmem-96`
* - `n1-highcpu-16`
* - `n1-highcpu-32`
* - `n1-highcpu-64`
* - `n1-highcpu-96`
*
*
* Alternatively, you can use the following legacy machine types:
*
* - `standard`
* - `large_model`
* - `complex_model_s`
* - `complex_model_m`
* - `complex_model_l`
* - `standard_gpu`
* - `complex_model_m_gpu`
* - `complex_model_l_gpu`
* - `standard_p100`
* - `complex_model_m_p100`
* - `standard_v100`
* - `large_model_v100`
* - `complex_model_m_v100`
* - `complex_model_l_v100`
*
*
* Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
* field. Learn more about the [special configuration options for training
* with
* TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
*
*
* string master_type = 2;
*
* @return The masterType.
*/
java.lang.String getMasterType();
/**
*
*
*
* Specifies the type of virtual machine to use for your training
* job's master worker. You must specify this field when `scaleTier` is set to
* `CUSTOM`.
*
* You can use certain Compute Engine machine types directly in this field.
* The following types are supported:
*
* - `n1-standard-4`
* - `n1-standard-8`
* - `n1-standard-16`
* - `n1-standard-32`
* - `n1-standard-64`
* - `n1-standard-96`
* - `n1-highmem-2`
* - `n1-highmem-4`
* - `n1-highmem-8`
* - `n1-highmem-16`
* - `n1-highmem-32`
* - `n1-highmem-64`
* - `n1-highmem-96`
* - `n1-highcpu-16`
* - `n1-highcpu-32`
* - `n1-highcpu-64`
* - `n1-highcpu-96`
*
*
* Alternatively, you can use the following legacy machine types:
*
* - `standard`
* - `large_model`
* - `complex_model_s`
* - `complex_model_m`
* - `complex_model_l`
* - `standard_gpu`
* - `complex_model_m_gpu`
* - `complex_model_l_gpu`
* - `standard_p100`
* - `complex_model_m_p100`
* - `standard_v100`
* - `large_model_v100`
* - `complex_model_m_v100`
* - `complex_model_l_v100`
*
*
* Finally, if you want to use a TPU for training, specify `cloud_tpu` in this
* field. Learn more about the [special configuration options for training
* with
* TPU](https://cloud.google.com/ai-platform/training/docs/using-tpus#configuring_a_custom_tpu_machine).
*
*
* string master_type = 2;
*
* @return The bytes for masterType.
*/
com.google.protobuf.ByteString getMasterTypeBytes();
/**
*
*
*
* Configuration (count and accelerator type) for hardware running notebook
* execution.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
*
*
* @return Whether the acceleratorConfig field is set.
*/
boolean hasAcceleratorConfig();
/**
*
*
*
* Configuration (count and accelerator type) for hardware running notebook
* execution.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
*
*
* @return The acceleratorConfig.
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig getAcceleratorConfig();
/**
*
*
*
* Configuration (count and accelerator type) for hardware running notebook
* execution.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
*
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfigOrBuilder
getAcceleratorConfigOrBuilder();
/**
*
*
*
* Labels for execution.
* If execution is scheduled, a field included will be 'nbs-scheduled'.
* Otherwise, it is an immediate execution, and an included field will be
* 'nbs-immediate'. Use fields to efficiently index between various types of
* executions.
*
*
* map<string, string> labels = 4;
*/
int getLabelsCount();
/**
*
*
*
* Labels for execution.
* If execution is scheduled, a field included will be 'nbs-scheduled'.
* Otherwise, it is an immediate execution, and an included field will be
* 'nbs-immediate'. Use fields to efficiently index between various types of
* executions.
*
*
* map<string, string> labels = 4;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels for execution.
* If execution is scheduled, a field included will be 'nbs-scheduled'.
* Otherwise, it is an immediate execution, and an included field will be
* 'nbs-immediate'. Use fields to efficiently index between various types of
* executions.
*
*
* map<string, string> labels = 4;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels for execution.
* If execution is scheduled, a field included will be 'nbs-scheduled'.
* Otherwise, it is an immediate execution, and an included field will be
* 'nbs-immediate'. Use fields to efficiently index between various types of
* executions.
*
*
* map<string, string> labels = 4;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels for execution.
* If execution is scheduled, a field included will be 'nbs-scheduled'.
* Otherwise, it is an immediate execution, and an included field will be
* 'nbs-immediate'. Use fields to efficiently index between various types of
* executions.
*
*
* map<string, string> labels = 4;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Path to the notebook file to execute.
* Must be in a Google Cloud Storage bucket.
* Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
*
*
* string input_notebook_file = 5;
*
* @return The inputNotebookFile.
*/
java.lang.String getInputNotebookFile();
/**
*
*
*
* Path to the notebook file to execute.
* Must be in a Google Cloud Storage bucket.
* Format: `gs://{bucket_name}/{folder}/{notebook_file_name}`
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb`
*
*
* string input_notebook_file = 5;
*
* @return The bytes for inputNotebookFile.
*/
com.google.protobuf.ByteString getInputNotebookFileBytes();
/**
*
*
*
* Container Image URI to a DLVM
* Example: 'gcr.io/deeplearning-platform-release/base-cu100'
* More examples can be found at:
* https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
*
*
* string container_image_uri = 6;
*
* @return The containerImageUri.
*/
java.lang.String getContainerImageUri();
/**
*
*
*
* Container Image URI to a DLVM
* Example: 'gcr.io/deeplearning-platform-release/base-cu100'
* More examples can be found at:
* https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container
*
*
* string container_image_uri = 6;
*
* @return The bytes for containerImageUri.
*/
com.google.protobuf.ByteString getContainerImageUriBytes();
/**
*
*
*
* Path to the notebook folder to write to.
* Must be in a Google Cloud Storage bucket path.
* Format: `gs://{bucket_name}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
*
*
* string output_notebook_folder = 7;
*
* @return The outputNotebookFolder.
*/
java.lang.String getOutputNotebookFolder();
/**
*
*
*
* Path to the notebook folder to write to.
* Must be in a Google Cloud Storage bucket path.
* Format: `gs://{bucket_name}/{folder}`
* Ex: `gs://notebook_user/scheduled_notebooks`
*
*
* string output_notebook_folder = 7;
*
* @return The bytes for outputNotebookFolder.
*/
com.google.protobuf.ByteString getOutputNotebookFolderBytes();
/**
*
*
*
* Parameters to be overridden in the notebook during execution.
* Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
* how to specifying parameters in the input notebook and pass them here
* in an YAML file.
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
*
*
* string params_yaml_file = 8;
*
* @return The paramsYamlFile.
*/
java.lang.String getParamsYamlFile();
/**
*
*
*
* Parameters to be overridden in the notebook during execution.
* Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on
* how to specifying parameters in the input notebook and pass them here
* in an YAML file.
* Ex: `gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml`
*
*
* string params_yaml_file = 8;
*
* @return The bytes for paramsYamlFile.
*/
com.google.protobuf.ByteString getParamsYamlFileBytes();
/**
*
*
*
* Parameters used within the 'input_notebook_file' notebook.
*
*
* string parameters = 9;
*
* @return The parameters.
*/
java.lang.String getParameters();
/**
*
*
*
* Parameters used within the 'input_notebook_file' notebook.
*
*
* string parameters = 9;
*
* @return The bytes for parameters.
*/
com.google.protobuf.ByteString getParametersBytes();
/**
*
*
*
* The email address of a service account to use when running the execution.
* You must have the `iam.serviceAccounts.actAs` permission for the specified
* service account.
*
*
* string service_account = 10;
*
* @return The serviceAccount.
*/
java.lang.String getServiceAccount();
/**
*
*
*
* The email address of a service account to use when running the execution.
* You must have the `iam.serviceAccounts.actAs` permission for the specified
* service account.
*
*
* string service_account = 10;
*
* @return The bytes for serviceAccount.
*/
com.google.protobuf.ByteString getServiceAccountBytes();
/**
*
*
*
* The type of Job to be used on this execution.
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
*
* @return The enum numeric value on the wire for jobType.
*/
int getJobTypeValue();
/**
*
*
*
* The type of Job to be used on this execution.
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
*
* @return The jobType.
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.JobType getJobType();
/**
*
*
*
* Parameters used in Dataproc JobType executions.
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
*
*
* @return Whether the dataprocParameters field is set.
*/
boolean hasDataprocParameters();
/**
*
*
*
* Parameters used in Dataproc JobType executions.
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
*
*
* @return The dataprocParameters.
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters getDataprocParameters();
/**
*
*
*
* Parameters used in Dataproc JobType executions.
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
*
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.DataprocParametersOrBuilder
getDataprocParametersOrBuilder();
/**
*
*
*
* Parameters used in Vertex AI JobType executions.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
*
*
* @return Whether the vertexAiParameters field is set.
*/
boolean hasVertexAiParameters();
/**
*
*
*
* Parameters used in Vertex AI JobType executions.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
*
*
* @return The vertexAiParameters.
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters getVertexAiParameters();
/**
*
*
*
* Parameters used in Vertex AI JobType executions.
*
*
*
* .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
*
*/
com.google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParametersOrBuilder
getVertexAiParametersOrBuilder();
/**
*
*
*
* Name of the kernel spec to use. This must be specified if the
* kernel spec name on the execution target does not match the name in the
* input notebook file.
*
*
* string kernel_spec = 14;
*
* @return The kernelSpec.
*/
java.lang.String getKernelSpec();
/**
*
*
*
* Name of the kernel spec to use. This must be specified if the
* kernel spec name on the execution target does not match the name in the
* input notebook file.
*
*
* string kernel_spec = 14;
*
* @return The bytes for kernelSpec.
*/
com.google.protobuf.ByteString getKernelSpecBytes();
/**
*
*
*
* The name of a Vertex AI [Tensorboard] resource to which this execution
* will upload Tensorboard logs.
* Format:
* `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
*
*
* string tensorboard = 15 [(.google.api.resource_reference) = { ... }
*
* @return The tensorboard.
*/
java.lang.String getTensorboard();
/**
*
*
*
* The name of a Vertex AI [Tensorboard] resource to which this execution
* will upload Tensorboard logs.
* Format:
* `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
*
*
* string tensorboard = 15 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for tensorboard.
*/
com.google.protobuf.ByteString getTensorboardBytes();
com.google.cloud.notebooks.v1.ExecutionTemplate.JobParametersCase getJobParametersCase();
}