Class PythonPackageSpec.Builder (2.9.8)

Version 2.9.8

• 3.52.0 (latest)
• 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 PythonPackageSpecOrBuilder

The spec of a Python packaged code.

Protobuf type google.cloud.aiplatform.v1beta1.PythonPackageSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PythonPackageSpec.Builder

Implements

PythonPackageSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

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;

Parameter

Name	Description
values	Iterable<String> The args to add.

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

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];

Parameter

Name	Description
values	Iterable<String> The packageUris to add.

Returns

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;

Parameter

Name	Description
value	String The args to add.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes of the args to add.

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

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];

Parameter

Name	Description
value	String The packageUris to add.

Returns

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];

Parameter

Name	Description
value	ByteString The bytes of the packageUris to add.

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PythonPackageSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PythonPackageSpec build()

Returns

Type	Description
PythonPackageSpec

buildPartial()

public PythonPackageSpec buildPartial()

Returns

Type	Description
PythonPackageSpec

clear()

public PythonPackageSpec.Builder clear()

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArgs()

public PythonPackageSpec.Builder clearArgs()

Command line arguments to be passed to the Python task.

repeated string args = 4;

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

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];

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PythonPackageSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public PythonPackageSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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];

Returns

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];

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

clone()

public PythonPackageSpec.Builder clone()

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getArgs(int index)

public String getArgs(int index)

Command line arguments to be passed to the Python task.

repeated string args = 4;

Parameter

Name	Description
index	int The index of the element to return.

Returns

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;

Parameter

Name	Description
index	int The index of the value to return.

Returns

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;

Returns

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;

Returns

Type	Description
ProtocolStringList	A list containing the args.

getDefaultInstanceForType()

public PythonPackageSpec getDefaultInstanceForType()

Returns

Type	Description
PythonPackageSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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];

Returns

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];

Returns

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];

Parameter

Name	Description
index	int The index of the element to return.

Returns

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];

Parameter

Name	Description
index	int The index of the value to return.

Returns

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];

Returns

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];

Returns

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];

Returns

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];

Returns

Type	Description
ByteString	The bytes for pythonModule.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(PythonPackageSpec other)

public PythonPackageSpec.Builder mergeFrom(PythonPackageSpec other)

Parameter

Name	Description
other	PythonPackageSpec

Returns

Type	Description
PythonPackageSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PythonPackageSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public PythonPackageSpec.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PythonPackageSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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;

Parameters

Name	Description
index	int The index to set the value at.
value	String The args to set.

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

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];

Parameter

Name	Description
value	String The executorImageUri to set.

Returns

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];

Parameter

Name	Description
value	ByteString The bytes for executorImageUri to set.

Returns

Type	Description
PythonPackageSpec.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PythonPackageSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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];

Parameters

Name	Description
index	int The index to set the value at.
value	String The packageUris to set.

Returns

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];

Parameter

Name	Description
value	String The pythonModule to set.

Returns

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];

Parameter

Name	Description
value	ByteString The bytes for pythonModule to set.

Returns

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)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PythonPackageSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
PythonPackageSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)