com.google.cloud.aiplatform.v1beta1

Class CustomJobSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.CustomJobSpec

All Implemented Interfaces:

CustomJobSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CustomJobSpec
extends com.google.protobuf.GeneratedMessageV3
implements CustomJobSpecOrBuilder

 Represents the spec of a CustomJob.
 

Protobuf type google.cloud.aiplatform.v1beta1.CustomJobSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomJobSpec.Builder Represents the spec of a CustomJob.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE_OUTPUT_DIRECTORY_FIELD_NUMBER
static int	ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER
static int	ENABLE_WEB_ACCESS_FIELD_NUMBER
static int	EXPERIMENT_FIELD_NUMBER
static int	EXPERIMENT_RUN_FIELD_NUMBER
static int	MODELS_FIELD_NUMBER
static int	NETWORK_FIELD_NUMBER
static int	PERSISTENT_RESOURCE_ID_FIELD_NUMBER
static int	PROTECTED_ARTIFACT_LOCATION_ID_FIELD_NUMBER
static int	RESERVED_IP_RANGES_FIELD_NUMBER
static int	SCHEDULING_FIELD_NUMBER
static int	SERVICE_ACCOUNT_FIELD_NUMBER
static int	TENSORBOARD_FIELD_NUMBER
static int	WORKER_POOL_SPECS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
GcsDestination	getBaseOutputDirectory() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
GcsDestinationOrBuilder	getBaseOutputDirectoryOrBuilder() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
static CustomJobSpec	getDefaultInstance()
CustomJobSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnableDashboardAccess() Optional.
boolean	getEnableWebAccess() Optional.
String	getExperiment() Optional.
com.google.protobuf.ByteString	getExperimentBytes() Optional.
String	getExperimentRun() Optional.
com.google.protobuf.ByteString	getExperimentRunBytes() Optional.
String	getModels(int index) Optional.
com.google.protobuf.ByteString	getModelsBytes(int index) Optional.
int	getModelsCount() Optional.
com.google.protobuf.ProtocolStringList	getModelsList() Optional.
String	getNetwork() Optional.
com.google.protobuf.ByteString	getNetworkBytes() Optional.
com.google.protobuf.Parser<CustomJobSpec>	getParserForType()
String	getPersistentResourceId() Optional.
com.google.protobuf.ByteString	getPersistentResourceIdBytes() Optional.
String	getProtectedArtifactLocationId() The ID of the location to store protected artifacts.
com.google.protobuf.ByteString	getProtectedArtifactLocationIdBytes() The ID of the location to store protected artifacts.
String	getReservedIpRanges(int index) Optional.
com.google.protobuf.ByteString	getReservedIpRangesBytes(int index) Optional.
int	getReservedIpRangesCount() Optional.
com.google.protobuf.ProtocolStringList	getReservedIpRangesList() Optional.
Scheduling	getScheduling() Scheduling options for a CustomJob.
SchedulingOrBuilder	getSchedulingOrBuilder() Scheduling options for a CustomJob.
int	getSerializedSize()
String	getServiceAccount() Specifies the service account for workload run-as account.
com.google.protobuf.ByteString	getServiceAccountBytes() Specifies the service account for workload run-as account.
String	getTensorboard() Optional.
com.google.protobuf.ByteString	getTensorboardBytes() Optional.
WorkerPoolSpec	getWorkerPoolSpecs(int index) Required.
int	getWorkerPoolSpecsCount() Required.
List<WorkerPoolSpec>	getWorkerPoolSpecsList() Required.
WorkerPoolSpecOrBuilder	getWorkerPoolSpecsOrBuilder(int index) Required.
List<? extends WorkerPoolSpecOrBuilder>	getWorkerPoolSpecsOrBuilderList() Required.
boolean	hasBaseOutputDirectory() The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
int	hashCode()
boolean	hasScheduling() Scheduling options for a CustomJob.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CustomJobSpec.Builder	newBuilder()
static CustomJobSpec.Builder	newBuilder(CustomJobSpec prototype)
CustomJobSpec.Builder	newBuilderForType()
protected CustomJobSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CustomJobSpec	parseDelimitedFrom(InputStream input)
static CustomJobSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomJobSpec	parseFrom(byte[] data)
static CustomJobSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomJobSpec	parseFrom(ByteBuffer data)
static CustomJobSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomJobSpec	parseFrom(com.google.protobuf.ByteString data)
static CustomJobSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomJobSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static CustomJobSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CustomJobSpec	parseFrom(InputStream input)
static CustomJobSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CustomJobSpec>	parser()
CustomJobSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PERSISTENT_RESOURCE_ID_FIELD_NUMBER

public static final int PERSISTENT_RESOURCE_ID_FIELD_NUMBER

See Also:

Constant Field Values

WORKER_POOL_SPECS_FIELD_NUMBER

public static final int WORKER_POOL_SPECS_FIELD_NUMBER

See Also:

Constant Field Values

SCHEDULING_FIELD_NUMBER

public static final int SCHEDULING_FIELD_NUMBER

See Also:

Constant Field Values

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER

See Also:

Constant Field Values

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER

See Also:

Constant Field Values

RESERVED_IP_RANGES_FIELD_NUMBER

public static final int RESERVED_IP_RANGES_FIELD_NUMBER

See Also:

Constant Field Values

BASE_OUTPUT_DIRECTORY_FIELD_NUMBER

public static final int BASE_OUTPUT_DIRECTORY_FIELD_NUMBER

See Also:

Constant Field Values

PROTECTED_ARTIFACT_LOCATION_ID_FIELD_NUMBER

public static final int PROTECTED_ARTIFACT_LOCATION_ID_FIELD_NUMBER

See Also:

Constant Field Values

TENSORBOARD_FIELD_NUMBER

public static final int TENSORBOARD_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_WEB_ACCESS_FIELD_NUMBER

public static final int ENABLE_WEB_ACCESS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER

public static final int ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER

See Also:

Constant Field Values

EXPERIMENT_FIELD_NUMBER

public static final int EXPERIMENT_FIELD_NUMBER

See Also:

Constant Field Values

EXPERIMENT_RUN_FIELD_NUMBER

public static final int EXPERIMENT_RUN_FIELD_NUMBER

See Also:

Constant Field Values

MODELS_FIELD_NUMBER

public static final int MODELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPersistentResourceId

public String getPersistentResourceId()

 Optional. The ID of the PersistentResource in the same Project and Location
 which to run

 If this is specified, the job will be run on existing machines held by the
 PersistentResource instead of on-demand short-live machines.
 The network and CMEK configs on the job should be consistent with those on
 the PersistentResource, otherwise, the job will be rejected.
 

string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getPersistentResourceId in interface CustomJobSpecOrBuilder

Returns:

The persistentResourceId.

getPersistentResourceIdBytes

public com.google.protobuf.ByteString getPersistentResourceIdBytes()

 Optional. The ID of the PersistentResource in the same Project and Location
 which to run

 If this is specified, the job will be run on existing machines held by the
 PersistentResource instead of on-demand short-live machines.
 The network and CMEK configs on the job should be consistent with those on
 the PersistentResource, otherwise, the job will be rejected.
 

string persistent_resource_id = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getPersistentResourceIdBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for persistentResourceId.

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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsList in interface CustomJobSpecOrBuilder

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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsOrBuilderList in interface CustomJobSpecOrBuilder

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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsCount in interface CustomJobSpecOrBuilder

getWorkerPoolSpecs

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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecs in interface CustomJobSpecOrBuilder

getWorkerPoolSpecsOrBuilder

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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getWorkerPoolSpecsOrBuilder in interface CustomJobSpecOrBuilder

hasScheduling

public boolean hasScheduling()

 Scheduling options for a CustomJob.
 

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

Specified by:

hasScheduling in interface CustomJobSpecOrBuilder

Returns:

Whether the scheduling field is set.

getScheduling

public Scheduling getScheduling()

 Scheduling options for a CustomJob.
 

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

Specified by:

getScheduling in interface CustomJobSpecOrBuilder

Returns:

The scheduling.

getSchedulingOrBuilder

public SchedulingOrBuilder getSchedulingOrBuilder()

 Scheduling options for a CustomJob.
 

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

Specified by:

getSchedulingOrBuilder in interface CustomJobSpecOrBuilder

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](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Specified by:

getServiceAccount in interface CustomJobSpecOrBuilder

Returns:

The serviceAccount.

getServiceAccountBytes

public com.google.protobuf.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](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 for the CustomJob's project is used.
 

string service_account = 4;

Specified by:

getServiceAccountBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for serviceAccount.

getNetwork

public String getNetwork()

 Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 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](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 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) = { ... }

Specified by:

getNetwork in interface CustomJobSpecOrBuilder

Returns:

The network.

getNetworkBytes

public com.google.protobuf.ByteString getNetworkBytes()

 Optional. The full name of the Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the Job
 should be peered. For example, `projects/12345/global/networks/myVPC`.
 [Format](/compute/docs/reference/rest/v1/networks/insert)
 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](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).

 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) = { ... }

Specified by:

getNetworkBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for network.

getReservedIpRangesList

public com.google.protobuf.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];

Specified by:

getReservedIpRangesList in interface CustomJobSpecOrBuilder

Returns:

A list containing the reservedIpRanges.

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

Specified by:

getReservedIpRangesCount in interface CustomJobSpecOrBuilder

Returns:

The count of reservedIpRanges.

getReservedIpRanges

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

Specified by:

getReservedIpRanges in interface CustomJobSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The reservedIpRanges at the given index.

getReservedIpRangesBytes

public com.google.protobuf.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];

Specified by:

getReservedIpRangesBytes in interface CustomJobSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the reservedIpRanges at the given index.

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][google.cloud.aiplatform.v1beta1.Trial.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.v1beta1.GcsDestination base_output_directory = 6;

Specified by:

hasBaseOutputDirectory in interface CustomJobSpecOrBuilder

Returns:

Whether the baseOutputDirectory field is set.

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][google.cloud.aiplatform.v1beta1.Trial.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.v1beta1.GcsDestination base_output_directory = 6;

Specified by:

getBaseOutputDirectory in interface CustomJobSpecOrBuilder

Returns:

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][google.cloud.aiplatform.v1beta1.Trial.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.v1beta1.GcsDestination base_output_directory = 6;

Specified by:

getBaseOutputDirectoryOrBuilder in interface CustomJobSpecOrBuilder

getProtectedArtifactLocationId

public String getProtectedArtifactLocationId()

 The ID of the location to store protected artifacts. e.g. us-central1.
 Populate only when the location is different than CustomJob location.
 List of supported locations:
 https://cloud.google.com/vertex-ai/docs/general/locations
 

string protected_artifact_location_id = 19;

Specified by:

getProtectedArtifactLocationId in interface CustomJobSpecOrBuilder

Returns:

The protectedArtifactLocationId.

getProtectedArtifactLocationIdBytes

public com.google.protobuf.ByteString getProtectedArtifactLocationIdBytes()

 The ID of the location to store protected artifacts. e.g. us-central1.
 Populate only when the location is different than CustomJob location.
 List of supported locations:
 https://cloud.google.com/vertex-ai/docs/general/locations
 

string protected_artifact_location_id = 19;

Specified by:

getProtectedArtifactLocationIdBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for protectedArtifactLocationId.

getTensorboard

public String getTensorboard()

 Optional. The name of a Vertex AI
 [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }

Specified by:

getTensorboard in interface CustomJobSpecOrBuilder

Returns:

The tensorboard.

getTensorboardBytes

public com.google.protobuf.ByteString getTensorboardBytes()

 Optional. The name of a Vertex AI
 [Tensorboard][google.cloud.aiplatform.v1beta1.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) = { ... }

Specified by:

getTensorboardBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for tensorboard.

getEnableWebAccess

public boolean getEnableWebAccess()

 Optional. Whether you want Vertex AI to enable [interactive shell
 access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)
 to training containers.

 If set to `true`, you can access interactive shells at the URIs given
 by
 [CustomJob.web_access_uris][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris]
 or
 [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris]
 (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
 

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

Specified by:

getEnableWebAccess in interface CustomJobSpecOrBuilder

Returns:

The enableWebAccess.

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][google.cloud.aiplatform.v1beta1.CustomJob.web_access_uris]
 or
 [Trial.web_access_uris][google.cloud.aiplatform.v1beta1.Trial.web_access_uris]
 (within
 [HyperparameterTuningJob.trials][google.cloud.aiplatform.v1beta1.HyperparameterTuningJob.trials]).
 

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

Specified by:

getEnableDashboardAccess in interface CustomJobSpecOrBuilder

Returns:

The enableDashboardAccess.

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) = { ... }

Specified by:

getExperiment in interface CustomJobSpecOrBuilder

Returns:

The experiment.

getExperimentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getExperimentBytes in interface CustomJobSpecOrBuilder

Returns:

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) = { ... }

Specified by:

getExperimentRun in interface CustomJobSpecOrBuilder

Returns:

The experimentRun.

getExperimentRunBytes

public com.google.protobuf.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) = { ... }

Specified by:

getExperimentRunBytes in interface CustomJobSpecOrBuilder

Returns:

The bytes for experimentRun.

getModelsList

public com.google.protobuf.ProtocolStringList getModelsList()

 Optional. The name of the Model resources for which to generate a mapping
 to artifact URIs. Applicable only to some of the Google-provided custom
 jobs. Format: `projects/{project}/locations/{location}/models/{model}`

 In order to retrieve a specific version of the model, also provide
 the version ID or version alias.
   Example: `projects/{project}/locations/{location}/models/{model}@2`
              or
            `projects/{project}/locations/{location}/models/{model}@golden`
 If no version ID or alias is specified, the "default" version will be
 returned. The "default" version alias is created for the first version of
 the model, and can be moved to other versions later on. There will be
 exactly one default version.
 

repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getModelsList in interface CustomJobSpecOrBuilder

Returns:

A list containing the models.

getModelsCount

public int getModelsCount()

 Optional. The name of the Model resources for which to generate a mapping
 to artifact URIs. Applicable only to some of the Google-provided custom
 jobs. Format: `projects/{project}/locations/{location}/models/{model}`

 In order to retrieve a specific version of the model, also provide
 the version ID or version alias.
   Example: `projects/{project}/locations/{location}/models/{model}@2`
              or
            `projects/{project}/locations/{location}/models/{model}@golden`
 If no version ID or alias is specified, the "default" version will be
 returned. The "default" version alias is created for the first version of
 the model, and can be moved to other versions later on. There will be
 exactly one default version.
 

repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getModelsCount in interface CustomJobSpecOrBuilder

Returns:

The count of models.

getModels

public String getModels(int index)

 Optional. The name of the Model resources for which to generate a mapping
 to artifact URIs. Applicable only to some of the Google-provided custom
 jobs. Format: `projects/{project}/locations/{location}/models/{model}`

 In order to retrieve a specific version of the model, also provide
 the version ID or version alias.
   Example: `projects/{project}/locations/{location}/models/{model}@2`
              or
            `projects/{project}/locations/{location}/models/{model}@golden`
 If no version ID or alias is specified, the "default" version will be
 returned. The "default" version alias is created for the first version of
 the model, and can be moved to other versions later on. There will be
 exactly one default version.
 

repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getModels in interface CustomJobSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The models at the given index.

getModelsBytes

public com.google.protobuf.ByteString getModelsBytes(int index)

 Optional. The name of the Model resources for which to generate a mapping
 to artifact URIs. Applicable only to some of the Google-provided custom
 jobs. Format: `projects/{project}/locations/{location}/models/{model}`

 In order to retrieve a specific version of the model, also provide
 the version ID or version alias.
   Example: `projects/{project}/locations/{location}/models/{model}@2`
              or
            `projects/{project}/locations/{location}/models/{model}@golden`
 If no version ID or alias is specified, the "default" version will be
 returned. The "default" version alias is created for the first version of
 the model, and can be moved to other versions later on. There will be
 exactly one default version.
 

repeated string models = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getModelsBytes in interface CustomJobSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the models at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CustomJobSpec parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CustomJobSpec parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CustomJobSpec parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static CustomJobSpec parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static CustomJobSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public CustomJobSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CustomJobSpec.Builder newBuilder()

newBuilder

public static CustomJobSpec.Builder newBuilder(CustomJobSpec prototype)

toBuilder

public CustomJobSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CustomJobSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CustomJobSpec getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<CustomJobSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CustomJobSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder