public final class CustomJobSpec extends GeneratedMessageV3 implements CustomJobSpecOrBuilder
Represents the spec of a CustomJob.
Protobuf type google.cloud.aiplatform.v1.CustomJobSpec
Static Fields
public static final int BASE_OUTPUT_DIRECTORY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENABLE_DASHBOARD_ACCESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENABLE_WEB_ACCESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXPERIMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXPERIMENT_RUN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int RESERVED_IP_RANGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SCHEDULING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TENSORBOARD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int WORKER_POOL_SPECS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static CustomJobSpec getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static CustomJobSpec.Builder newBuilder()
public static CustomJobSpec.Builder newBuilder(CustomJobSpec prototype)
public static CustomJobSpec parseDelimitedFrom(InputStream input)
public static CustomJobSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJobSpec parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static CustomJobSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomJobSpec parseFrom(ByteString data)
public static CustomJobSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomJobSpec parseFrom(CodedInputStream input)
public static CustomJobSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJobSpec parseFrom(InputStream input)
public static CustomJobSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static CustomJobSpec parseFrom(ByteBuffer data)
public static CustomJobSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<CustomJobSpec> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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;
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;
public CustomJobSpec getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
public Parser<CustomJobSpec> getParserForType()
Overrides
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.
|
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.
|
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.
|
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];
public Scheduling getScheduling()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;
public SchedulingOrBuilder getSchedulingOrBuilder()
Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1.Scheduling scheduling = 3;
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
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.
|
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.
|
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.
|
public final UnknownFieldSet getUnknownFields()
Overrides
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
|
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 | |
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];
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
|
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> | |
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.
|
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.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public CustomJobSpec.Builder newBuilderForType()
protected CustomJobSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public CustomJobSpec.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
