- 3.71.0 (latest)
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class PythonPackageSpec.Builder extends GeneratedMessageV3.Builder<PythonPackageSpec.Builder> implements PythonPackageSpecOrBuilderThe spec of a Python packaged code.
Protobuf type google.cloud.aiplatform.v1.PythonPackageSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PythonPackageSpec.BuilderImplements
PythonPackageSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllArgs(Iterable<String> values)
public PythonPackageSpec.Builder addAllArgs(Iterable<String> values)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| values | Iterable<String>The args to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addAllEnv(Iterable<? extends EnvVar> values)
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;
| Name | Description |
| values | Iterable<? extends com.google.cloud.aiplatform.v1.EnvVar> |
| Type | Description |
| PythonPackageSpec.Builder |
addAllPackageUris(Iterable<String> values)
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];
| Name | Description |
| values | Iterable<String>The packageUris to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addArgs(String value)
public PythonPackageSpec.Builder addArgs(String value)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| value | StringThe args to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addArgsBytes(ByteString value)
public PythonPackageSpec.Builder addArgsBytes(ByteString value)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| value | ByteStringThe bytes of the args to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addEnv(EnvVar value)
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;
| Name | Description |
| value | EnvVar |
| Type | Description |
| PythonPackageSpec.Builder |
addEnv(EnvVar.Builder builderForValue)
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;
| Name | Description |
| builderForValue | EnvVar.Builder |
| Type | Description |
| PythonPackageSpec.Builder |
addEnv(int index, EnvVar value)
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;
| Name | Description |
| index | int |
| value | EnvVar |
| Type | Description |
| PythonPackageSpec.Builder |
addEnv(int index, EnvVar.Builder builderForValue)
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;
| Name | Description |
| index | int |
| builderForValue | EnvVar.Builder |
| Type | Description |
| PythonPackageSpec.Builder |
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;
| Type | Description |
| EnvVar.Builder |
addEnvBuilder(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| EnvVar.Builder |
addPackageUris(String value)
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];
| Name | Description |
| value | StringThe packageUris to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addPackageUrisBytes(ByteString value)
public PythonPackageSpec.Builder addPackageUrisBytes(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];
| Name | Description |
| value | ByteStringThe bytes of the packageUris to add. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PythonPackageSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PythonPackageSpec.Builder |
build()
public PythonPackageSpec build()| Type | Description |
| PythonPackageSpec |
buildPartial()
public PythonPackageSpec buildPartial()| Type | Description |
| PythonPackageSpec |
clear()
public PythonPackageSpec.Builder clear()| Type | Description |
| PythonPackageSpec.Builder |
clearArgs()
public PythonPackageSpec.Builder clearArgs()Command line arguments to be passed to the Python task.
repeated string args = 4;
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
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;
| Type | Description |
| PythonPackageSpec.Builder |
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. You must use an image from this list.
string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public PythonPackageSpec.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| PythonPackageSpec.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PythonPackageSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| PythonPackageSpec.Builder |
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];
| Type | Description |
| PythonPackageSpec.Builder | 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];
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
clone()
public PythonPackageSpec.Builder clone()| Type | Description |
| PythonPackageSpec.Builder |
getArgs(int index)
public String getArgs(int index)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The args at the given index. |
getArgsBytes(int index)
public ByteString getArgsBytes(int index)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the args at the given index. |
getArgsCount()
public int getArgsCount()Command line arguments to be passed to the Python task.
repeated string args = 4;
| Type | Description |
| int | The count of args. |
getArgsList()
public ProtocolStringList getArgsList()Command line arguments to be passed to the Python task.
repeated string args = 4;
| Type | Description |
| ProtocolStringList | A list containing the args. |
getDefaultInstanceForType()
public PythonPackageSpec getDefaultInstanceForType()| Type | Description |
| PythonPackageSpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getEnv(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| EnvVar |
getEnvBuilder(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| EnvVar.Builder |
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;
| Type | Description |
| List<Builder> |
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;
| Type | Description |
| int |
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;
| Type | Description |
| List<EnvVar> |
getEnvOrBuilder(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| EnvVarOrBuilder |
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;
| Type | Description |
| List<? extends com.google.cloud.aiplatform.v1.EnvVarOrBuilder> |
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. You must use an image from this list.
string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The executorImageUri. |
getExecutorImageUriBytes()
public 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. You must use an image from this list.
string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for executorImageUri. |
getPackageUris(int index)
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];
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The packageUris at the given index. |
getPackageUrisBytes(int index)
public 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];
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the packageUris at the given index. |
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];
| Type | Description |
| int | The count of packageUris. |
getPackageUrisList()
public 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];
| Type | Description |
| ProtocolStringList | A list containing the packageUris. |
getPythonModule()
public String getPythonModule()Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The pythonModule. |
getPythonModuleBytes()
public ByteString getPythonModuleBytes()Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for pythonModule. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(PythonPackageSpec other)
public PythonPackageSpec.Builder mergeFrom(PythonPackageSpec other)| Name | Description |
| other | PythonPackageSpec |
| Type | Description |
| PythonPackageSpec.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PythonPackageSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| PythonPackageSpec.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public PythonPackageSpec.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| PythonPackageSpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PythonPackageSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PythonPackageSpec.Builder |
removeEnv(int index)
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;
| Name | Description |
| index | int |
| Type | Description |
| PythonPackageSpec.Builder |
setArgs(int index, String value)
public PythonPackageSpec.Builder setArgs(int index, String value)Command line arguments to be passed to the Python task.
repeated string args = 4;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe args to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setEnv(int index, EnvVar value)
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;
| Name | Description |
| index | int |
| value | EnvVar |
| Type | Description |
| PythonPackageSpec.Builder |
setEnv(int index, EnvVar.Builder builderForValue)
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;
| Name | Description |
| index | int |
| builderForValue | EnvVar.Builder |
| Type | Description |
| PythonPackageSpec.Builder |
setExecutorImageUri(String value)
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. You must use an image from this list.
string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | StringThe executorImageUri to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setExecutorImageUriBytes(ByteString value)
public PythonPackageSpec.Builder setExecutorImageUriBytes(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. You must use an image from this list.
string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteStringThe bytes for executorImageUri to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public PythonPackageSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| PythonPackageSpec.Builder |
setPackageUris(int index, String value)
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];
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe packageUris to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setPythonModule(String value)
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];
| Name | Description |
| value | StringThe pythonModule to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setPythonModuleBytes(ByteString value)
public PythonPackageSpec.Builder setPythonModuleBytes(ByteString value)Required. The Python module name to run after installing the packages.
string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | ByteStringThe bytes for pythonModule to set. |
| Type | Description |
| PythonPackageSpec.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PythonPackageSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| PythonPackageSpec.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PythonPackageSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| PythonPackageSpec.Builder |