Package com.google.cloud.notebooks.v1

Class ExecutionTemplate

  • All Implemented Interfaces:
    ExecutionTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ExecutionTemplate
extends com.google.protobuf.GeneratedMessageV3
implements ExecutionTemplateOrBuilder
     The description a notebook execution workload.
    Protobuf type google.cloud.notebooks.v1.ExecutionTemplate
    See Also:
    Serialized Form

    • Field Detail

      • SCALE_TIER_FIELD_NUMBER

        public static final int SCALE_TIER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MASTER_TYPE_FIELD_NUMBER

        public static final int MASTER_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACCELERATOR_CONFIG_FIELD_NUMBER

        public static final int ACCELERATOR_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_NOTEBOOK_FILE_FIELD_NUMBER

        public static final int INPUT_NOTEBOOK_FILE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTAINER_IMAGE_URI_FIELD_NUMBER

        public static final int CONTAINER_IMAGE_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_NOTEBOOK_FOLDER_FIELD_NUMBER

        public static final int OUTPUT_NOTEBOOK_FOLDER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMS_YAML_FILE_FIELD_NUMBER

        public static final int PARAMS_YAML_FILE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATAPROC_PARAMETERS_FIELD_NUMBER

        public static final int DATAPROC_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERTEX_AI_PARAMETERS_FIELD_NUMBER

        public static final int VERTEX_AI_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KERNEL_SPEC_FIELD_NUMBER

        public static final int KERNEL_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TENSORBOARD_FIELD_NUMBER

        public static final int TENSORBOARD_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getScaleTierValue

        @Deprecated
public int getScaleTierValue()
        Deprecated.
        google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
         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];
        Specified by:
        getScaleTierValue in interface ExecutionTemplateOrBuilder
        Returns:
        The enum numeric value on the wire for scaleTier.

      • getScaleTier

        @Deprecated
public ExecutionTemplate.ScaleTier getScaleTier()
        Deprecated.
        google.cloud.notebooks.v1.ExecutionTemplate.scale_tier is deprecated. See google/cloud/notebooks/v1/execution.proto;l=151
         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];
        Specified by:
        getScaleTier in interface ExecutionTemplateOrBuilder
        Returns:
        The scaleTier.

      • getMasterType

        public 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;
        Specified by:
        getMasterType in interface ExecutionTemplateOrBuilder
        Returns:
        The masterType.

      • getMasterTypeBytes

        public com.google.protobuf.ByteString getMasterTypeBytes()
         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;
        Specified by:
        getMasterTypeBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for masterType.

      • hasAcceleratorConfig

        public boolean hasAcceleratorConfig()
         Configuration (count and accelerator type) for hardware running notebook
 execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;
        Specified by:
        hasAcceleratorConfig in interface ExecutionTemplateOrBuilder
        Returns:
        Whether the acceleratorConfig field is set.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ExecutionTemplateOrBuilder
         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;
        Specified by:
        getLabelsCount in interface ExecutionTemplateOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         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;
        Specified by:
        containsLabels in interface ExecutionTemplateOrBuilder

      • getLabelsMap

        public Map<String,​String> 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;
        Specified by:
        getLabelsMap in interface ExecutionTemplateOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 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;
        Specified by:
        getLabelsOrDefault in interface ExecutionTemplateOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         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;
        Specified by:
        getLabelsOrThrow in interface ExecutionTemplateOrBuilder

      • getInputNotebookFile

        public 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;
        Specified by:
        getInputNotebookFile in interface ExecutionTemplateOrBuilder
        Returns:
        The inputNotebookFile.

      • getInputNotebookFileBytes

        public com.google.protobuf.ByteString getInputNotebookFileBytes()
         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;
        Specified by:
        getInputNotebookFileBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for inputNotebookFile.

      • getContainerImageUri

        public 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;
        Specified by:
        getContainerImageUri in interface ExecutionTemplateOrBuilder
        Returns:
        The containerImageUri.

      • getContainerImageUriBytes

        public com.google.protobuf.ByteString getContainerImageUriBytes()
         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;
        Specified by:
        getContainerImageUriBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for containerImageUri.

      • getOutputNotebookFolder

        public 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;
        Specified by:
        getOutputNotebookFolder in interface ExecutionTemplateOrBuilder
        Returns:
        The outputNotebookFolder.

      • getOutputNotebookFolderBytes

        public com.google.protobuf.ByteString getOutputNotebookFolderBytes()
         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;
        Specified by:
        getOutputNotebookFolderBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for outputNotebookFolder.

      • getParamsYamlFile

        public 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;
        Specified by:
        getParamsYamlFile in interface ExecutionTemplateOrBuilder
        Returns:
        The paramsYamlFile.

      • getParamsYamlFileBytes

        public com.google.protobuf.ByteString getParamsYamlFileBytes()
         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;
        Specified by:
        getParamsYamlFileBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for paramsYamlFile.

      • getParametersBytes

        public com.google.protobuf.ByteString getParametersBytes()
         Parameters used within the 'input_notebook_file' notebook.
        string parameters = 9;
        Specified by:
        getParametersBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for parameters.

      • getServiceAccount

        public 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;
        Specified by:
        getServiceAccount in interface ExecutionTemplateOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public com.google.protobuf.ByteString getServiceAccountBytes()
         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;
        Specified by:
        getServiceAccountBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for serviceAccount.

      • getJobTypeValue

        public int getJobTypeValue()
         The type of Job to be used on this execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
        Specified by:
        getJobTypeValue in interface ExecutionTemplateOrBuilder
        Returns:
        The enum numeric value on the wire for jobType.

      • hasDataprocParameters

        public boolean hasDataprocParameters()
         Parameters used in Dataproc JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;
        Specified by:
        hasDataprocParameters in interface ExecutionTemplateOrBuilder
        Returns:
        Whether the dataprocParameters field is set.

      • hasVertexAiParameters

        public boolean hasVertexAiParameters()
         Parameters used in Vertex AI JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;
        Specified by:
        hasVertexAiParameters in interface ExecutionTemplateOrBuilder
        Returns:
        Whether the vertexAiParameters field is set.

      • getKernelSpec

        public 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;
        Specified by:
        getKernelSpec in interface ExecutionTemplateOrBuilder
        Returns:
        The kernelSpec.

      • getKernelSpecBytes

        public com.google.protobuf.ByteString getKernelSpecBytes()
         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;
        Specified by:
        getKernelSpecBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for kernelSpec.

      • getTensorboard

        public 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) = { ... }
        Specified by:
        getTensorboard in interface ExecutionTemplateOrBuilder
        Returns:
        The tensorboard.

      • getTensorboardBytes

        public com.google.protobuf.ByteString getTensorboardBytes()
         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) = { ... }
        Specified by:
        getTensorboardBytes in interface ExecutionTemplateOrBuilder
        Returns:
        The bytes for tensorboard.

      • 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 ExecutionTemplate parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ExecutionTemplate parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ExecutionTemplate.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ExecutionTemplate.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ExecutionTemplate.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ExecutionTemplate> 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 ExecutionTemplate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder