Interface PythonPackageSpecOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PythonPackageSpec, PythonPackageSpec.Builder

    public interface PythonPackageSpecOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getExecutorImageUri

        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];
        Returns:
        The executorImageUri.
      • getExecutorImageUriBytes

        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];
        Returns:
        The bytes for executorImageUri.
      • getPackageUrisList

        List<String> 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];
        Returns:
        A list containing the packageUris.
      • getPackageUrisCount

        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];
        Returns:
        The count of packageUris.
      • getPackageUris

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The packageUris at the given index.
      • getPackageUrisBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the packageUris at the given index.
      • getPythonModule

        String getPythonModule()
         Required. The Python module name to run after installing the packages.
         
        string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The pythonModule.
      • getPythonModuleBytes

        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];
        Returns:
        The bytes for pythonModule.
      • getArgsList

        List<String> getArgsList()
         Command line arguments to be passed to the Python task.
         
        repeated string args = 4;
        Returns:
        A list containing the args.
      • getArgsCount

        int getArgsCount()
         Command line arguments to be passed to the Python task.
         
        repeated string args = 4;
        Returns:
        The count of args.
      • getArgs

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

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

        List<EnvVar> getEnvList()
         Environment variables to be passed to the python module.
         Maximum limit is 100.
         
        repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;
      • getEnv

        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;
      • getEnvCount

        int getEnvCount()
         Environment variables to be passed to the python module.
         Maximum limit is 100.
         
        repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;
      • getEnvOrBuilderList

        List<? extends EnvVarOrBuilder> getEnvOrBuilderList()
         Environment variables to be passed to the python module.
         Maximum limit is 100.
         
        repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 5;
      • getEnvOrBuilder

        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;