Package com.google.cloud.notebooks.v1

Class ExecutionTemplate.Builder

  • All Implemented Interfaces:
    ExecutionTemplateOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ExecutionTemplate
    public static final class ExecutionTemplate.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>
implements ExecutionTemplateOrBuilder
     The description a notebook execution workload.
    Protobuf type google.cloud.notebooks.v1.ExecutionTemplate

    • Method Detail

      • 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.Builder<ExecutionTemplate.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • clear

        public ExecutionTemplate.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • getDefaultInstanceForType

        public ExecutionTemplate getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public ExecutionTemplate.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • setField

        public ExecutionTemplate.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • clearField

        public ExecutionTemplate.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • clearOneof

        public ExecutionTemplate.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • setRepeatedField

        public ExecutionTemplate.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • addRepeatedField

        public ExecutionTemplate.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • mergeFrom

        public ExecutionTemplate.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecutionTemplate.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • mergeFrom

        public ExecutionTemplate.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExecutionTemplate.Builder>
        Throws:
        IOException

      • 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.

      • setScaleTierValue

        @Deprecated
public ExecutionTemplate.Builder setScaleTierValue​(int value)
        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];
        Parameters:
        value - The enum numeric value on the wire for scaleTier to set.
        Returns:
        This builder for chaining.

      • 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.

      • setScaleTier

        @Deprecated
public ExecutionTemplate.Builder setScaleTier​(ExecutionTemplate.ScaleTier value)
        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];
        Parameters:
        value - The scaleTier to set.
        Returns:
        This builder for chaining.

      • clearScaleTier

        @Deprecated
public ExecutionTemplate.Builder clearScaleTier()
        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];
        Returns:
        This builder for chaining.

      • 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.

      • setMasterType

        public ExecutionTemplate.Builder setMasterType​(String value)
         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;
        Parameters:
        value - The masterType to set.
        Returns:
        This builder for chaining.

      • clearMasterType

        public ExecutionTemplate.Builder clearMasterType()
         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;
        Returns:
        This builder for chaining.

      • setMasterTypeBytes

        public ExecutionTemplate.Builder setMasterTypeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for masterType to set.
        Returns:
        This builder for chaining.

      • 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.

      • clearAcceleratorConfig

        public ExecutionTemplate.Builder clearAcceleratorConfig()
         Configuration (count and accelerator type) for hardware running notebook
 execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

      • getAcceleratorConfigBuilder

        public ExecutionTemplate.SchedulerAcceleratorConfig.Builder getAcceleratorConfigBuilder()
         Configuration (count and accelerator type) for hardware running notebook
 execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.SchedulerAcceleratorConfig accelerator_config = 3;

      • 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

      • removeLabels

        public ExecutionTemplate.Builder removeLabels​(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;

      • getMutableLabels

        @Deprecated
public Map<String,​String> getMutableLabels()
        Deprecated.
        Use alternate mutation accessors instead.

      • putLabels

        public ExecutionTemplate.Builder putLabels​(String key,
                                           String value)
         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;

      • putAllLabels

        public ExecutionTemplate.Builder putAllLabels​(Map<String,​String> values)
         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;

      • 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.

      • setInputNotebookFile

        public ExecutionTemplate.Builder setInputNotebookFile​(String value)
         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;
        Parameters:
        value - The inputNotebookFile to set.
        Returns:
        This builder for chaining.

      • clearInputNotebookFile

        public ExecutionTemplate.Builder clearInputNotebookFile()
         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;
        Returns:
        This builder for chaining.

      • setInputNotebookFileBytes

        public ExecutionTemplate.Builder setInputNotebookFileBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for inputNotebookFile to set.
        Returns:
        This builder for chaining.

      • 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.

      • setContainerImageUri

        public ExecutionTemplate.Builder setContainerImageUri​(String value)
         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;
        Parameters:
        value - The containerImageUri to set.
        Returns:
        This builder for chaining.

      • clearContainerImageUri

        public ExecutionTemplate.Builder clearContainerImageUri()
         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;
        Returns:
        This builder for chaining.

      • setContainerImageUriBytes

        public ExecutionTemplate.Builder setContainerImageUriBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for containerImageUri to set.
        Returns:
        This builder for chaining.

      • 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.

      • setOutputNotebookFolder

        public ExecutionTemplate.Builder setOutputNotebookFolder​(String value)
         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;
        Parameters:
        value - The outputNotebookFolder to set.
        Returns:
        This builder for chaining.

      • clearOutputNotebookFolder

        public ExecutionTemplate.Builder clearOutputNotebookFolder()
         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;
        Returns:
        This builder for chaining.

      • setOutputNotebookFolderBytes

        public ExecutionTemplate.Builder setOutputNotebookFolderBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for outputNotebookFolder to set.
        Returns:
        This builder for chaining.

      • 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.

      • setParamsYamlFile

        public ExecutionTemplate.Builder setParamsYamlFile​(String value)
         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;
        Parameters:
        value - The paramsYamlFile to set.
        Returns:
        This builder for chaining.

      • clearParamsYamlFile

        public ExecutionTemplate.Builder clearParamsYamlFile()
         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;
        Returns:
        This builder for chaining.

      • setParamsYamlFileBytes

        public ExecutionTemplate.Builder setParamsYamlFileBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for paramsYamlFile to set.
        Returns:
        This builder for chaining.

      • 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.

      • setParameters

        public ExecutionTemplate.Builder setParameters​(String value)
         Parameters used within the 'input_notebook_file' notebook.
        string parameters = 9;
        Parameters:
        value - The parameters to set.
        Returns:
        This builder for chaining.

      • clearParameters

        public ExecutionTemplate.Builder clearParameters()
         Parameters used within the 'input_notebook_file' notebook.
        string parameters = 9;
        Returns:
        This builder for chaining.

      • setParametersBytes

        public ExecutionTemplate.Builder setParametersBytes​(com.google.protobuf.ByteString value)
         Parameters used within the 'input_notebook_file' notebook.
        string parameters = 9;
        Parameters:
        value - The bytes for parameters to set.
        Returns:
        This builder for chaining.

      • 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.

      • setServiceAccount

        public ExecutionTemplate.Builder setServiceAccount​(String value)
         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;
        Parameters:
        value - The serviceAccount to set.
        Returns:
        This builder for chaining.

      • clearServiceAccount

        public ExecutionTemplate.Builder clearServiceAccount()
         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;
        Returns:
        This builder for chaining.

      • setServiceAccountBytes

        public ExecutionTemplate.Builder setServiceAccountBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for serviceAccount to set.
        Returns:
        This builder for chaining.

      • 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.

      • setJobTypeValue

        public ExecutionTemplate.Builder setJobTypeValue​(int value)
         The type of Job to be used on this execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
        Parameters:
        value - The enum numeric value on the wire for jobType to set.
        Returns:
        This builder for chaining.

      • setJobType

        public ExecutionTemplate.Builder setJobType​(ExecutionTemplate.JobType value)
         The type of Job to be used on this execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
        Parameters:
        value - The jobType to set.
        Returns:
        This builder for chaining.

      • clearJobType

        public ExecutionTemplate.Builder clearJobType()
         The type of Job to be used on this execution.
        .google.cloud.notebooks.v1.ExecutionTemplate.JobType job_type = 11;
        Returns:
        This builder for chaining.

      • 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.

      • clearDataprocParameters

        public ExecutionTemplate.Builder clearDataprocParameters()
         Parameters used in Dataproc JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

      • getDataprocParametersBuilder

        public ExecutionTemplate.DataprocParameters.Builder getDataprocParametersBuilder()
         Parameters used in Dataproc JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.DataprocParameters dataproc_parameters = 12;

      • 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.

      • clearVertexAiParameters

        public ExecutionTemplate.Builder clearVertexAiParameters()
         Parameters used in Vertex AI JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;

      • getVertexAiParametersBuilder

        public ExecutionTemplate.VertexAIParameters.Builder getVertexAiParametersBuilder()
         Parameters used in Vertex AI JobType executions.
        .google.cloud.notebooks.v1.ExecutionTemplate.VertexAIParameters vertex_ai_parameters = 13;

      • 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.

      • setKernelSpec

        public ExecutionTemplate.Builder setKernelSpec​(String value)
         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;
        Parameters:
        value - The kernelSpec to set.
        Returns:
        This builder for chaining.

      • clearKernelSpec

        public ExecutionTemplate.Builder clearKernelSpec()
         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;
        Returns:
        This builder for chaining.

      • setKernelSpecBytes

        public ExecutionTemplate.Builder setKernelSpecBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for kernelSpec to set.
        Returns:
        This builder for chaining.

      • 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.

      • setTensorboard

        public ExecutionTemplate.Builder setTensorboard​(String value)
         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) = { ... }
        Parameters:
        value - The tensorboard to set.
        Returns:
        This builder for chaining.

      • clearTensorboard

        public ExecutionTemplate.Builder clearTensorboard()
         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) = { ... }
        Returns:
        This builder for chaining.

      • setTensorboardBytes

        public ExecutionTemplate.Builder setTensorboardBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for tensorboard to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ExecutionTemplate.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>

      • mergeUnknownFields

        public final ExecutionTemplate.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExecutionTemplate.Builder>