Package com.google.cloud.aiplatform.v1

Class PythonPackageSpec.Builder

  • All Implemented Interfaces:
    PythonPackageSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PythonPackageSpec
    public static final class PythonPackageSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>
implements PythonPackageSpecOrBuilder
     The spec of a Python packaged code.
    Protobuf type google.cloud.aiplatform.v1.PythonPackageSpec

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

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

      • clear

        public PythonPackageSpec.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<PythonPackageSpec.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<PythonPackageSpec.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • setField

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • clearField

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • clearOneof

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • setRepeatedField

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • addRepeatedField

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • mergeFrom

        public PythonPackageSpec.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<PythonPackageSpec.Builder>

      • isInitialized

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

      • mergeFrom

        public PythonPackageSpec.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<PythonPackageSpec.Builder>
        Throws:
        IOException

      • getExecutorImageUri

        public String getExecutorImageUri()
         Required. The URI of a container image in Artifact Registry that will run
 the provided Python package. Vertex AI provides a wide range of executor
 images with pre-installed packages to meet users' various use cases. See
 the list of [pre-built containers for
 training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 You must use an image from this list.
        string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExecutorImageUri in interface PythonPackageSpecOrBuilder
        Returns:
        The executorImageUri.

      • getExecutorImageUriBytes

        public com.google.protobuf.ByteString getExecutorImageUriBytes()
         Required. The URI of a container image in Artifact Registry that will run
 the provided Python package. Vertex AI provides a wide range of executor
 images with pre-installed packages to meet users' various use cases. See
 the list of [pre-built containers for
 training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 You must use an image from this list.
        string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExecutorImageUriBytes in interface PythonPackageSpecOrBuilder
        Returns:
        The bytes for executorImageUri.

      • setExecutorImageUri

        public PythonPackageSpec.Builder setExecutorImageUri​(String value)
         Required. The URI of a container image in Artifact Registry that will run
 the provided Python package. Vertex AI provides a wide range of executor
 images with pre-installed packages to meet users' various use cases. See
 the list of [pre-built containers for
 training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 You must use an image from this list.
        string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The executorImageUri to set.
        Returns:
        This builder for chaining.

      • clearExecutorImageUri

        public PythonPackageSpec.Builder clearExecutorImageUri()
         Required. The URI of a container image in Artifact Registry that will run
 the provided Python package. Vertex AI provides a wide range of executor
 images with pre-installed packages to meet users' various use cases. See
 the list of [pre-built containers for
 training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 You must use an image from this list.
        string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setExecutorImageUriBytes

        public PythonPackageSpec.Builder setExecutorImageUriBytes​(com.google.protobuf.ByteString value)
         Required. The URI of a container image in Artifact Registry that will run
 the provided Python package. Vertex AI provides a wide range of executor
 images with pre-installed packages to meet users' various use cases. See
 the list of [pre-built containers for
 training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
 You must use an image from this list.
        string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for executorImageUri to set.
        Returns:
        This builder for chaining.

      • getPackageUrisList

        public com.google.protobuf.ProtocolStringList getPackageUrisList()
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPackageUrisList in interface PythonPackageSpecOrBuilder
        Returns:
        A list containing the packageUris.

      • getPackageUrisCount

        public int getPackageUrisCount()
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPackageUrisCount in interface PythonPackageSpecOrBuilder
        Returns:
        The count of packageUris.

      • getPackageUris

        public String getPackageUris​(int index)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPackageUris in interface PythonPackageSpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The packageUris at the given index.

      • getPackageUrisBytes

        public com.google.protobuf.ByteString getPackageUrisBytes​(int index)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPackageUrisBytes in interface PythonPackageSpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the packageUris at the given index.

      • setPackageUris

        public PythonPackageSpec.Builder setPackageUris​(int index,
                                                String value)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index to set the value at.
        value - The packageUris to set.
        Returns:
        This builder for chaining.

      • addPackageUris

        public PythonPackageSpec.Builder addPackageUris​(String value)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The packageUris to add.
        Returns:
        This builder for chaining.

      • addAllPackageUris

        public PythonPackageSpec.Builder addAllPackageUris​(Iterable<String> values)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        values - The packageUris to add.
        Returns:
        This builder for chaining.

      • clearPackageUris

        public PythonPackageSpec.Builder clearPackageUris()
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • addPackageUrisBytes

        public PythonPackageSpec.Builder addPackageUrisBytes​(com.google.protobuf.ByteString value)
         Required. The Google Cloud Storage location of the Python package files
 which are the training program and its dependent packages. The maximum
 number of package URIs is 100.
        repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes of the packageUris to add.
        Returns:
        This builder for chaining.

      • getPythonModule

        public String getPythonModule()
         Required. The Python module name to run after installing the packages.
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPythonModule in interface PythonPackageSpecOrBuilder
        Returns:
        The pythonModule.

      • getPythonModuleBytes

        public com.google.protobuf.ByteString getPythonModuleBytes()
         Required. The Python module name to run after installing the packages.
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPythonModuleBytes in interface PythonPackageSpecOrBuilder
        Returns:
        The bytes for pythonModule.

      • setPythonModule

        public PythonPackageSpec.Builder setPythonModule​(String value)
         Required. The Python module name to run after installing the packages.
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The pythonModule to set.
        Returns:
        This builder for chaining.

      • clearPythonModule

        public PythonPackageSpec.Builder clearPythonModule()
         Required. The Python module name to run after installing the packages.
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setPythonModuleBytes

        public PythonPackageSpec.Builder setPythonModuleBytes​(com.google.protobuf.ByteString value)
         Required. The Python module name to run after installing the packages.
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for pythonModule to set.
        Returns:
        This builder for chaining.

      • getArgsList

        public com.google.protobuf.ProtocolStringList getArgsList()
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Specified by:
        getArgsList in interface PythonPackageSpecOrBuilder
        Returns:
        A list containing the args.

      • getArgsCount

        public int getArgsCount()
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Specified by:
        getArgsCount in interface PythonPackageSpecOrBuilder
        Returns:
        The count of args.

      • getArgs

        public String getArgs​(int index)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Specified by:
        getArgs in interface PythonPackageSpecOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The args at the given index.

      • getArgsBytes

        public com.google.protobuf.ByteString getArgsBytes​(int index)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Specified by:
        getArgsBytes in interface PythonPackageSpecOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.

      • setArgs

        public PythonPackageSpec.Builder setArgs​(int index,
                                         String value)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Parameters:
        index - The index to set the value at.
        value - The args to set.
        Returns:
        This builder for chaining.

      • addArgs

        public PythonPackageSpec.Builder addArgs​(String value)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Parameters:
        value - The args to add.
        Returns:
        This builder for chaining.

      • addAllArgs

        public PythonPackageSpec.Builder addAllArgs​(Iterable<String> values)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Parameters:
        values - The args to add.
        Returns:
        This builder for chaining.

      • clearArgs

        public PythonPackageSpec.Builder clearArgs()
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Returns:
        This builder for chaining.

      • addArgsBytes

        public PythonPackageSpec.Builder addArgsBytes​(com.google.protobuf.ByteString value)
         Command line arguments to be passed to the Python task.
        repeated string args = 4;
        Parameters:
        value - The bytes of the args to add.
        Returns:
        This builder for chaining.

      • getEnvList

        public List<EnvVar> getEnvList()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
        Specified by:
        getEnvList in interface PythonPackageSpecOrBuilder

      • getEnvCount

        public int getEnvCount()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
        Specified by:
        getEnvCount in interface PythonPackageSpecOrBuilder

      • getEnv

        public EnvVar getEnv​(int index)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
        Specified by:
        getEnv in interface PythonPackageSpecOrBuilder

      • setEnv

        public PythonPackageSpec.Builder setEnv​(int index,
                                        EnvVar value)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • setEnv

        public PythonPackageSpec.Builder setEnv​(int index,
                                        EnvVar.Builder builderForValue)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnv

        public PythonPackageSpec.Builder addEnv​(EnvVar value)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnv

        public PythonPackageSpec.Builder addEnv​(int index,
                                        EnvVar value)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnv

        public PythonPackageSpec.Builder addEnv​(EnvVar.Builder builderForValue)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnv

        public PythonPackageSpec.Builder addEnv​(int index,
                                        EnvVar.Builder builderForValue)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addAllEnv

        public PythonPackageSpec.Builder addAllEnv​(Iterable<? extends EnvVar> values)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • clearEnv

        public PythonPackageSpec.Builder clearEnv()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • removeEnv

        public PythonPackageSpec.Builder removeEnv​(int index)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • getEnvBuilder

        public EnvVar.Builder getEnvBuilder​(int index)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnvBuilder

        public EnvVar.Builder addEnvBuilder()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • addEnvBuilder

        public EnvVar.Builder addEnvBuilder​(int index)
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • getEnvBuilderList

        public List<EnvVar.Builder> getEnvBuilderList()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1.EnvVar env = 5;

      • setUnknownFields

        public final PythonPackageSpec.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<PythonPackageSpec.Builder>

      • mergeUnknownFields

        public final PythonPackageSpec.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<PythonPackageSpec.Builder>