Package com.google.cloud.aiplatform.v1

Class PythonPackageSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.PythonPackageSpec
All Implemented Interfaces:
PythonPackageSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PythonPackageSpec extends com.google.protobuf.GeneratedMessage implements PythonPackageSpecOrBuilder
 The spec of a Python packaged code.
Protobuf type google.cloud.aiplatform.v1.PythonPackageSpec
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PythonPackageSpec.Builder
    The spec of a Python packaged code.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ARGS_FIELD_NUMBER
     
    static final int
    ENV_FIELD_NUMBER
     
    static final int
    EXECUTOR_IMAGE_URI_FIELD_NUMBER
     
    static final int
    PACKAGE_URIS_FIELD_NUMBER
     
    static final int
    PYTHON_MODULE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getArgs(int index)
    Command line arguments to be passed to the Python task.
    com.google.protobuf.ByteString
    getArgsBytes(int index)
    Command line arguments to be passed to the Python task.
    int
    getArgsCount()
    Command line arguments to be passed to the Python task.
    com.google.protobuf.ProtocolStringList
    getArgsList()
    Command line arguments to be passed to the Python task.
    static PythonPackageSpec
    getDefaultInstance()
     
    PythonPackageSpec
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    EnvVar
    getEnv(int index)
    Environment variables to be passed to the python module.
    int
    getEnvCount()
    Environment variables to be passed to the python module.
    List<EnvVar>
    getEnvList()
    Environment variables to be passed to the python module.
    EnvVarOrBuilder
    getEnvOrBuilder(int index)
    Environment variables to be passed to the python module.
    List<? extends EnvVarOrBuilder>
    getEnvOrBuilderList()
    Environment variables to be passed to the python module.
    String
    getExecutorImageUri()
    Required.
    com.google.protobuf.ByteString
    getExecutorImageUriBytes()
    Required.
    String
    getPackageUris(int index)
    Required.
    com.google.protobuf.ByteString
    getPackageUrisBytes(int index)
    Required.
    int
    getPackageUrisCount()
    Required.
    com.google.protobuf.ProtocolStringList
    getPackageUrisList()
    Required.
    com.google.protobuf.Parser<PythonPackageSpec>
    getParserForType()
     
    String
    getPythonModule()
    Required.
    com.google.protobuf.ByteString
    getPythonModuleBytes()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PythonPackageSpec.Builder
    newBuilder()
     
    static PythonPackageSpec.Builder
    newBuilder(PythonPackageSpec prototype)
     
    PythonPackageSpec.Builder
    newBuilderForType()
     
    protected PythonPackageSpec.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PythonPackageSpec
    parseDelimitedFrom(InputStream input)
     
    static PythonPackageSpec
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PythonPackageSpec
    parseFrom(byte[] data)
     
    static PythonPackageSpec
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PythonPackageSpec
    parseFrom(com.google.protobuf.ByteString data)
     
    static PythonPackageSpec
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PythonPackageSpec
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PythonPackageSpec
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PythonPackageSpec
    parseFrom(InputStream input)
     
    static PythonPackageSpec
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PythonPackageSpec
    parseFrom(ByteBuffer data)
     
    static PythonPackageSpec
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PythonPackageSpec>
    parser()
     
    PythonPackageSpec.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • EXECUTOR_IMAGE_URI_FIELD_NUMBER

      public static final int EXECUTOR_IMAGE_URI_FIELD_NUMBER
      See Also:

    • PACKAGE_URIS_FIELD_NUMBER

      public static final int PACKAGE_URIS_FIELD_NUMBER
      See Also:

    • PYTHON_MODULE_FIELD_NUMBER

      public static final int PYTHON_MODULE_FIELD_NUMBER
      See Also:

    • ARGS_FIELD_NUMBER

      public static final int ARGS_FIELD_NUMBER
      See Also:

    • ENV_FIELD_NUMBER

      public static final int ENV_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.v1.EnvVar env = 5;
      Specified by:
      getEnvList in interface PythonPackageSpecOrBuilder

    • getEnvOrBuilderList

      public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()
       Environment variables to be passed to the python module.
 Maximum limit is 100.
      repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
      Specified by:
      getEnvOrBuilderList 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

    • getEnvOrBuilder

      public EnvVarOrBuilder getEnvOrBuilder(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:
      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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PythonPackageSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PythonPackageSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static PythonPackageSpec.Builder newBuilder()

    • newBuilder

      public static PythonPackageSpec.Builder newBuilder(PythonPackageSpec prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PythonPackageSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PythonPackageSpec> parser()

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

    • getDefaultInstanceForType

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