Interface TrialOrBuilder (3.8.0)

public interface TrialOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getFinalMeasurement()

public abstract Measurement getFinalMeasurement()

Output only. The final measurement containing the objective value.

.google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Measurement

The finalMeasurement.

getFinalMeasurementOrBuilder()

public abstract MeasurementOrBuilder getFinalMeasurementOrBuilder()

Output only. The final measurement containing the objective value.

.google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1.Measurement measurements = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.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
TypeDescription
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
TypeDescription
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.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Trial.Parameter

getParametersCount()

public abstract int getParametersCount()

Output only. The parameters of the Trial.

repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getParametersList()

public abstract List<Trial.Parameter> getParametersList()

Output only. The parameters of the Trial.

repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<Parameter>

getParametersOrBuilder(int index)

public abstract Trial.ParameterOrBuilder getParametersOrBuilder(int index)

Output only. The parameters of the Trial.

repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
Trial.ParameterOrBuilder

getParametersOrBuilderList()

public abstract List<? extends Trial.ParameterOrBuilder> getParametersOrBuilderList()

Output only. The parameters of the Trial.

repeated .google.cloud.aiplatform.v1.Trial.Parameter parameters = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getState()

public abstract Trial.State getState()

Output only. The detailed state of the Trial.

.google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Trial.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The detailed state of the Trial.

.google.cloud.aiplatform.v1.Trial.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getWebAccessUris()

public abstract Map<String,String> getWebAccessUris()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

Whether the endTime field is set.

hasFinalMeasurement()

public abstract boolean hasFinalMeasurement()

Output only. The final measurement containing the objective value.

.google.cloud.aiplatform.v1.Measurement final_measurement = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.