Class CustomJobSpec (3.20.0)

Version 3.20.0

• 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 final class CustomJobSpec extends GeneratedMessageV3 implements CustomJobSpecOrBuilder

Represents the spec of a CustomJob.

Protobuf type google.cloud.aiplatform.v1.CustomJobSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomJobSpec

Implements

CustomJobSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BASE_OUTPUT_DIRECTORY_FIELD_NUMBER

public static final int BASE_OUTPUT_DIRECTORY_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER

public static final int ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER

Field Value
Type	Description
int

ENABLE_WEB_ACCESS_FIELD_NUMBER

public static final int ENABLE_WEB_ACCESS_FIELD_NUMBER

Field Value
Type	Description
int

EXPERIMENT_FIELD_NUMBER

public static final int EXPERIMENT_FIELD_NUMBER

Field Value
Type	Description
int

EXPERIMENT_RUN_FIELD_NUMBER

public static final int EXPERIMENT_RUN_FIELD_NUMBER

Field Value
Type	Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER

Field Value
Type	Description
int

RESERVED_IP_RANGES_FIELD_NUMBER

public static final int RESERVED_IP_RANGES_FIELD_NUMBER

Field Value
Type	Description
int

SCHEDULING_FIELD_NUMBER

public static final int SCHEDULING_FIELD_NUMBER

Field Value
Type	Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER

Field Value
Type	Description
int

TENSORBOARD_FIELD_NUMBER

public static final int TENSORBOARD_FIELD_NUMBER

Field Value
Type	Description
int

WORKER_POOL_SPECS_FIELD_NUMBER

public static final int WORKER_POOL_SPECS_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static CustomJobSpec getDefaultInstance()

Returns
Type	Description
CustomJobSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static CustomJobSpec.Builder newBuilder()

Returns
Type	Description
CustomJobSpec.Builder

newBuilder(CustomJobSpec prototype)

public static CustomJobSpec.Builder newBuilder(CustomJobSpec prototype)

Parameter
Name	Description
prototype	CustomJobSpec

Returns
Type	Description
CustomJobSpec.Builder

parseDelimitedFrom(InputStream input)

public static CustomJobSpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static CustomJobSpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CustomJobSpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CustomJobSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static CustomJobSpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static CustomJobSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomJobSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
CustomJobSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<CustomJobSpec> parser()

Returns
Type	Description
Parser<CustomJobSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBaseOutputDirectory()

public GcsDestination getBaseOutputDirectory()

The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

For CustomJob:

• AIP_MODEL_DIR = <base_output_directory>/model/
• AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/

• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

  For CustomJob backing a Trial of HyperparameterTuningJob:

• AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/

• AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Returns
Type	Description
GcsDestination	The baseOutputDirectory.

getBaseOutputDirectoryOrBuilder()

public GcsDestinationOrBuilder getBaseOutputDirectoryOrBuilder()

The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

For CustomJob:

• AIP_MODEL_DIR = <base_output_directory>/model/
• AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/

• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

  For CustomJob backing a Trial of HyperparameterTuningJob:

• AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/

• AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Returns
Type	Description
GcsDestinationOrBuilder

getDefaultInstanceForType()

public CustomJobSpec getDefaultInstanceForType()

Returns
Type	Description
CustomJobSpec

getEnableDashboardAccess()

public boolean getEnableDashboardAccess()

Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container.

If set to true, you can access the dashboard at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).

bool enable_dashboard_access = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableDashboardAccess.

getEnableWebAccess()

public boolean getEnableWebAccess()

Optional. Whether you want Vertex AI to enable interactive shell access to training containers.

If set to true, you can access interactive shells at the URIs given by CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).

bool enable_web_access = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enableWebAccess.

getExperiment()

public String getExperiment()

Optional. The Experiment associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}

string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The experiment.

getExperimentBytes()

public ByteString getExperimentBytes()

Optional. The Experiment associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}

string experiment = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for experiment.

getExperimentRun()

public String getExperimentRun()

Optional. The Experiment Run associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}

string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The experimentRun.

getExperimentRunBytes()

public ByteString getExperimentRunBytes()

Optional. The Experiment Run associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}

string experiment_run = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for experimentRun.

getNetwork()

public String getNetwork()

Optional. The full name of the Compute Engine network to which the Job should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.

To specify this field, you must have already configured VPC Network Peering for Vertex AI.

If this field is left unspecified, the job is not peered with any network.

string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Optional. The full name of the Compute Engine network to which the Job should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.

To specify this field, you must have already configured VPC Network Peering for Vertex AI.

If this field is left unspecified, the job is not peered with any network.

string network = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for network.

getParserForType()

public Parser<CustomJobSpec> getParserForType()

Returns
Type	Description
Parser<CustomJobSpec>

Overrides

GeneratedMessageV3.getParserForType()

getReservedIpRanges(int index)

public String getReservedIpRanges(int index)

Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.

If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
String	The reservedIpRanges at the given index.

getReservedIpRangesBytes(int index)

public ByteString getReservedIpRangesBytes(int index)

Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.

If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
ByteString	The bytes of the reservedIpRanges at the given index.

getReservedIpRangesCount()

public int getReservedIpRangesCount()

Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.

If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of reservedIpRanges.

getReservedIpRangesList()

public ProtocolStringList getReservedIpRangesList()

Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.

If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.

Example: ['vertex-ai-ip-range'].

repeated string reserved_ip_ranges = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the reservedIpRanges.

getScheduling()

public Scheduling getScheduling()

Scheduling options for a CustomJob.

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Returns
Type	Description
Scheduling	The scheduling.

getSchedulingOrBuilder()

public SchedulingOrBuilder getSchedulingOrBuilder()

Scheduling options for a CustomJob.

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Returns
Type	Description
SchedulingOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getServiceAccount()

public String getServiceAccount()

Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the Vertex AI Custom Code Service Agent for the CustomJob's project is used.

string service_account = 4;

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the Vertex AI Custom Code Service Agent for the CustomJob's project is used.

string service_account = 4;

Returns
Type	Description
ByteString	The bytes for serviceAccount.

getTensorboard()

public String getTensorboard()

Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The tensorboard.

getTensorboardBytes()

public ByteString getTensorboardBytes()

Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

string tensorboard = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for tensorboard.

getWorkerPoolSpecs(int index)

public WorkerPoolSpec getWorkerPoolSpecs(int index)

Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
WorkerPoolSpec

getWorkerPoolSpecsCount()

public int getWorkerPoolSpecsCount()

Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getWorkerPoolSpecsList()

public List<WorkerPoolSpec> getWorkerPoolSpecsList()

Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<WorkerPoolSpec>

getWorkerPoolSpecsOrBuilder(int index)

public WorkerPoolSpecOrBuilder getWorkerPoolSpecsOrBuilder(int index)

Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
WorkerPoolSpecOrBuilder

getWorkerPoolSpecsOrBuilderList()

public List<? extends WorkerPoolSpecOrBuilder> getWorkerPoolSpecsOrBuilderList()

Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.

repeated .google.cloud.aiplatform.v1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.cloud.aiplatform.v1.WorkerPoolSpecOrBuilder>

hasBaseOutputDirectory()

public boolean hasBaseOutputDirectory()

The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.

The following Vertex AI environment variables will be passed to containers or python modules when this field is set:

For CustomJob:

• AIP_MODEL_DIR = <base_output_directory>/model/
• AIP_CHECKPOINT_DIR = <base_output_directory>/checkpoints/

• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/logs/

  For CustomJob backing a Trial of HyperparameterTuningJob:

• AIP_MODEL_DIR = <base_output_directory>/<trial_id>/model/

• AIP_CHECKPOINT_DIR = <base_output_directory>/<trial_id>/checkpoints/
• AIP_TENSORBOARD_LOG_DIR = <base_output_directory>/<trial_id>/logs/

.google.cloud.aiplatform.v1.GcsDestination base_output_directory = 6;

Returns
Type	Description
boolean	Whether the baseOutputDirectory field is set.

hasScheduling()

public boolean hasScheduling()

Scheduling options for a CustomJob.

.google.cloud.aiplatform.v1.Scheduling scheduling = 3;

Returns
Type	Description
boolean	Whether the scheduling field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CustomJobSpec.Builder newBuilderForType()

Returns
Type	Description
CustomJobSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomJobSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
CustomJobSpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CustomJobSpec.Builder toBuilder()

Returns
Type	Description
CustomJobSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException