- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class CustomJobSpec extends GeneratedMessageV3 implements CustomJobSpecOrBuilderRepresents the spec of a CustomJob.
Protobuf type google.cloud.aiplatform.v1beta1.CustomJobSpec
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomJobSpecImplements
CustomJobSpecOrBuilderStatic 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 |
|
MODELS_FIELD_NUMBER
public static final int MODELS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PERSISTENT_RESOURCE_ID_FIELD_NUMBER
public static final int PERSISTENT_RESOURCE_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROTECTED_ARTIFACT_LOCATION_ID_FIELD_NUMBER
public static final int PROTECTED_ARTIFACT_LOCATION_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PSC_INTERFACE_CONFIG_FIELD_NUMBER
public static final int PSC_INTERFACE_CONFIG_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 |
|
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.v1beta1.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.v1beta1.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. |
getModels(int index)
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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The models at the given index. |
getModelsBytes(int index)
public 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the models at the given index. |
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of models. |
getModelsList()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the models. |
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> |
|
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The persistentResourceId. |
getPersistentResourceIdBytes()
public 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for persistentResourceId. |
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;
| Returns | |
|---|---|
| Type | Description |
String |
The protectedArtifactLocationId. |
getProtectedArtifactLocationIdBytes()
public 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for protectedArtifactLocationId. |
getPscInterfaceConfig()
public PscInterfaceConfig getPscInterfaceConfig()Optional. Configuration for PSC-I for CustomJob.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PscInterfaceConfig |
The pscInterfaceConfig. |
getPscInterfaceConfigOrBuilder()
public PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()Optional. Configuration for PSC-I for CustomJob.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PscInterfaceConfigOrBuilder |
|
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 |
intThe 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 |
intThe 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.v1beta1.Scheduling scheduling = 3;
| Returns | |
|---|---|
| Type | Description |
Scheduling |
The scheduling. |
getSchedulingOrBuilder()
public SchedulingOrBuilder getSchedulingOrBuilder()Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
| Returns | |
|---|---|
| Type | Description |
SchedulingOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.WorkerPoolSpec worker_pool_specs = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.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.v1beta1.GcsDestination base_output_directory = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the baseOutputDirectory field is set. |
hasPscInterfaceConfig()
public boolean hasPscInterfaceConfig()Optional. Configuration for PSC-I for CustomJob.
.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pscInterfaceConfig field is set. |
hasScheduling()
public boolean hasScheduling()Scheduling options for a CustomJob.
.google.cloud.aiplatform.v1beta1.Scheduling scheduling = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the scheduling field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public CustomJobSpec.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
CustomJobSpec.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|