- 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 interface TrialOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsWebAccessUris(String key)
public abstract boolean containsWebAccessUris(String key) Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if this trial is part of
a
HyperparameterTuningJob
and the job's
trial_job_spec.enable_web_access
field is true.
The keys are names of each node used for the trial; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getClientId()
public abstract String getClientId()Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The clientId. |
getClientIdBytes()
public abstract ByteString getClientIdBytes()Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial.
string client_id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for clientId. |
getCustomJob()
public abstract String getCustomJob()Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The customJob. |
getCustomJobBytes()
public abstract ByteString getCustomJobBytes()Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial.
string custom_job = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customJob. |
getEndTime()
public abstract Timestamp getEndTime() Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeOrBuilder()
public abstract TimestampOrBuilder getEndTimeOrBuilder() Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getFinalMeasurement()
public abstract Measurement getFinalMeasurement()Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Measurement |
The finalMeasurement. |
getFinalMeasurementOrBuilder()
public abstract MeasurementOrBuilder getFinalMeasurementOrBuilder()Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
MeasurementOrBuilder |
|
getId()
public abstract String getId()Output only. The identifier of the Trial assigned by the service.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public abstract ByteString getIdBytes()Output only. The identifier of the Trial assigned by the service.
string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getInfeasibleReason()
public abstract String getInfeasibleReason() Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE.
string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The infeasibleReason. |
getInfeasibleReasonBytes()
public abstract ByteString getInfeasibleReasonBytes() Output only. A human readable string describing why the Trial is
infeasible. This is set only if Trial state is INFEASIBLE.
string infeasible_reason = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for infeasibleReason. |
getMeasurements(int index)
public abstract Measurement getMeasurements(int index)Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Measurement |
|
getMeasurementsCount()
public abstract int getMeasurementsCount()Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMeasurementsList()
public abstract List<Measurement> getMeasurementsList()Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Measurement> |
|
getMeasurementsOrBuilder(int index)
public abstract MeasurementOrBuilder getMeasurementsOrBuilder(int index)Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MeasurementOrBuilder |
|
getMeasurementsOrBuilderList()
public abstract List<? extends MeasurementOrBuilder> getMeasurementsOrBuilderList()Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations.
repeated .google.cloud.aiplatform.v1beta1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.MeasurementOrBuilder> |
|
getName()
public abstract String getName()Output only. Resource name of the Trial assigned by the service.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. Resource name of the Trial assigned by the service.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParameters(int index)
public abstract Trial.Parameter getParameters(int index)Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Trial.Parameter |
|
getParametersCount()
public abstract int getParametersCount()Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getParametersList()
public abstract List<Trial.Parameter> getParametersList()Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Parameter> |
|
getParametersOrBuilder(int index)
public abstract Trial.ParameterOrBuilder getParametersOrBuilder(int index)Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Trial.ParameterOrBuilder |
|
getParametersOrBuilderList()
public abstract List<? extends Trial.ParameterOrBuilder> getParametersOrBuilderList()Output only. The parameters of the Trial.
repeated .google.cloud.aiplatform.v1beta1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.Trial.ParameterOrBuilder> |
|
getStartTime()
public abstract Timestamp getStartTime()Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder()Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
public abstract Trial.State getState()Output only. The detailed state of the Trial.
.google.cloud.aiplatform.v1beta1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Trial.State |
The state. |
getStateValue()
public abstract int getStateValue()Output only. The detailed state of the Trial.
.google.cloud.aiplatform.v1beta1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getWebAccessUris() (deprecated)
public abstract Map<String,String> getWebAccessUris()Use #getWebAccessUrisMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getWebAccessUrisCount()
public abstract int getWebAccessUrisCount() Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if this trial is part of
a
HyperparameterTuningJob
and the job's
trial_job_spec.enable_web_access
field is true.
The keys are names of each node used for the trial; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getWebAccessUrisMap()
public abstract Map<String,String> getWebAccessUrisMap() Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if this trial is part of
a
HyperparameterTuningJob
and the job's
trial_job_spec.enable_web_access
field is true.
The keys are names of each node used for the trial; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getWebAccessUrisOrDefault(String key, String defaultValue)
public abstract String getWebAccessUrisOrDefault(String key, String defaultValue) Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if this trial is part of
a
HyperparameterTuningJob
and the job's
trial_job_spec.enable_web_access
field is true.
The keys are names of each node used for the trial; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getWebAccessUrisOrThrow(String key)
public abstract String getWebAccessUrisOrThrow(String key) Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if this trial is part of
a
HyperparameterTuningJob
and the job's
trial_job_spec.enable_web_access
field is true.
The keys are names of each node used for the trial; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
map<string, string> web_access_uris = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
hasEndTime()
public abstract boolean hasEndTime() Output only. Time when the Trial's status changed to SUCCEEDED or
INFEASIBLE.
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasFinalMeasurement()
public abstract boolean hasFinalMeasurement()Output only. The final measurement containing the objective value.
.google.cloud.aiplatform.v1beta1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the finalMeasurement field is set. |
hasStartTime()
public abstract boolean hasStartTime()Output only. Time when the Trial was started.
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |