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| Modifier and Type | Method and Description |
|---|---|
PythonPackageSpec.Builder |
addAllArgs(Iterable<String> values)
Command line arguments to be passed to the Python task.
|
PythonPackageSpec.Builder |
addAllEnv(Iterable<? extends EnvVar> values)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
addAllPackageUris(Iterable<String> values)
Required.
|
PythonPackageSpec.Builder |
addArgs(String value)
Command line arguments to be passed to the Python task.
|
PythonPackageSpec.Builder |
addArgsBytes(com.google.protobuf.ByteString value)
Command line arguments to be passed to the Python task.
|
PythonPackageSpec.Builder |
addEnv(EnvVar.Builder builderForValue)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
addEnv(EnvVar value)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
addEnv(int index,
EnvVar.Builder builderForValue)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
addEnv(int index,
EnvVar value)
Environment variables to be passed to the python module.
|
EnvVar.Builder |
addEnvBuilder()
Environment variables to be passed to the python module.
|
EnvVar.Builder |
addEnvBuilder(int index)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
addPackageUris(String value)
Required.
|
PythonPackageSpec.Builder |
addPackageUrisBytes(com.google.protobuf.ByteString value)
Required.
|
PythonPackageSpec.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PythonPackageSpec |
build() |
PythonPackageSpec |
buildPartial() |
PythonPackageSpec.Builder |
clear() |
PythonPackageSpec.Builder |
clearArgs()
Command line arguments to be passed to the Python task.
|
PythonPackageSpec.Builder |
clearEnv()
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
clearExecutorImageUri()
Required.
|
PythonPackageSpec.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PythonPackageSpec.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PythonPackageSpec.Builder |
clearPackageUris()
Required.
|
PythonPackageSpec.Builder |
clearPythonModule()
Required.
|
PythonPackageSpec.Builder |
clone() |
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.
|
PythonPackageSpec |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
EnvVar |
getEnv(int index)
Environment variables to be passed to the python module.
|
EnvVar.Builder |
getEnvBuilder(int index)
Environment variables to be passed to the python module.
|
List<EnvVar.Builder> |
getEnvBuilderList()
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.
|
String |
getPythonModule()
Required.
|
com.google.protobuf.ByteString |
getPythonModuleBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PythonPackageSpec.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PythonPackageSpec.Builder |
mergeFrom(com.google.protobuf.Message other) |
PythonPackageSpec.Builder |
mergeFrom(PythonPackageSpec other) |
PythonPackageSpec.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PythonPackageSpec.Builder |
removeEnv(int index)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
setArgs(int index,
String value)
Command line arguments to be passed to the Python task.
|
PythonPackageSpec.Builder |
setEnv(int index,
EnvVar.Builder builderForValue)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
setEnv(int index,
EnvVar value)
Environment variables to be passed to the python module.
|
PythonPackageSpec.Builder |
setExecutorImageUri(String value)
Required.
|
PythonPackageSpec.Builder |
setExecutorImageUriBytes(com.google.protobuf.ByteString value)
Required.
|
PythonPackageSpec.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PythonPackageSpec.Builder |
setPackageUris(int index,
String value)
Required.
|
PythonPackageSpec.Builder |
setPythonModule(String value)
Required.
|
PythonPackageSpec.Builder |
setPythonModuleBytes(com.google.protobuf.ByteString value)
Required.
|
PythonPackageSpec.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PythonPackageSpec.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PythonPackageSpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PythonPackageSpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PythonPackageSpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder mergeFrom(PythonPackageSpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public PythonPackageSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PythonPackageSpec.Builder>IOExceptionpublic 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];getExecutorImageUri in interface PythonPackageSpecOrBuilderpublic 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];getExecutorImageUriBytes in interface PythonPackageSpecOrBuilderpublic 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];value - The executorImageUri to set.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];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];value - The bytes for executorImageUri to set.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];getPackageUrisList in interface PythonPackageSpecOrBuilderpublic 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];getPackageUrisCount in interface PythonPackageSpecOrBuilderpublic 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];getPackageUris in interface PythonPackageSpecOrBuilderindex - The index of the element to return.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];getPackageUrisBytes in interface PythonPackageSpecOrBuilderindex - The index of the value to return.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];index - The index to set the value at.value - The packageUris to set.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];value - The packageUris to add.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];values - The packageUris to add.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];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];value - The bytes of the packageUris to add.public String getPythonModule()
Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];getPythonModule in interface PythonPackageSpecOrBuilderpublic 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];getPythonModuleBytes in interface PythonPackageSpecOrBuilderpublic 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];value - The pythonModule to set.public PythonPackageSpec.Builder clearPythonModule()
Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];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];value - The bytes for pythonModule to set.public com.google.protobuf.ProtocolStringList getArgsList()
Command line arguments to be passed to the Python task.
repeated string args = 4;getArgsList in interface PythonPackageSpecOrBuilderpublic int getArgsCount()
Command line arguments to be passed to the Python task.
repeated string args = 4;getArgsCount in interface PythonPackageSpecOrBuilderpublic String getArgs(int index)
Command line arguments to be passed to the Python task.
repeated string args = 4;getArgs in interface PythonPackageSpecOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getArgsBytes(int index)
Command line arguments to be passed to the Python task.
repeated string args = 4;getArgsBytes in interface PythonPackageSpecOrBuilderindex - The index of the value to return.public PythonPackageSpec.Builder setArgs(int index, String value)
Command line arguments to be passed to the Python task.
repeated string args = 4;index - The index to set the value at.value - The args to set.public PythonPackageSpec.Builder addArgs(String value)
Command line arguments to be passed to the Python task.
repeated string args = 4;value - The args to add.public PythonPackageSpec.Builder addAllArgs(Iterable<String> values)
Command line arguments to be passed to the Python task.
repeated string args = 4;values - The args to add.public PythonPackageSpec.Builder clearArgs()
Command line arguments to be passed to the Python task.
repeated string args = 4;public PythonPackageSpec.Builder addArgsBytes(com.google.protobuf.ByteString value)
Command line arguments to be passed to the Python task.
repeated string args = 4;value - The bytes of the args to add.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;getEnvList in interface PythonPackageSpecOrBuilderpublic int getEnvCount()
Environment variables to be passed to the python module. Maximum limit is 100.
repeated .google.cloud.aiplatform.v1.EnvVar env = 5;getEnvCount in interface PythonPackageSpecOrBuilderpublic 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;getEnv in interface PythonPackageSpecOrBuilderpublic 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;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;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;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;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;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;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;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;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;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;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;getEnvOrBuilder in interface PythonPackageSpecOrBuilderpublic 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;getEnvOrBuilderList in interface PythonPackageSpecOrBuilderpublic EnvVar.Builder addEnvBuilder()
Environment variables to be passed to the python module. Maximum limit is 100.
repeated .google.cloud.aiplatform.v1.EnvVar env = 5;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;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;public final PythonPackageSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>public final PythonPackageSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PythonPackageSpec.Builder>Copyright © 2024 Google LLC. All rights reserved.