Package com.google.cloud.aiplatform.v1beta1

Class PythonPackageSpec

  • All Implemented Interfaces:
    PythonPackageSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PythonPackageSpec
extends com.google.protobuf.GeneratedMessageV3
implements PythonPackageSpecOrBuilder
     The spec of a Python packaged code.
    Protobuf type google.cloud.aiplatform.v1beta1.PythonPackageSpec
    See Also:
    Serialized Form

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

      • internalGetFieldAccessorTable

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

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

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

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

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

      • getEnvList

        public List<EnvVar> getEnvList()
         Environment variables to be passed to the python module.
 Maximum limit is 100.
        repeated .google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.EnvVar env = 5;
        Specified by:
        getEnv in interface PythonPackageSpecOrBuilder

      • getEnvOrBuilder

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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