Class Trial.Builder (3.32.0)

public static final class Trial.Builder extends GeneratedMessageV3.Builder<Trial.Builder> implements TrialOrBuilder

A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.

Protobuf type google.cloud.aiplatform.v1beta1.Trial

Implements

TrialOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllMeasurements(Iterable<? extends Measurement> values)

public Trial.Builder addAllMeasurements(Iterable<? extends Measurement> values)

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
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.Measurement>
Returns
TypeDescription
Trial.Builder

addAllParameters(Iterable<? extends Trial.Parameter> values)

public Trial.Builder addAllParameters(Iterable<? extends Trial.Parameter> values)

Output only. The parameters of the Trial.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1beta1.Trial.Parameter>
Returns
TypeDescription
Trial.Builder

addMeasurements(Measurement value)

public Trial.Builder addMeasurements(Measurement value)

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
NameDescription
valueMeasurement
Returns
TypeDescription
Trial.Builder

addMeasurements(Measurement.Builder builderForValue)

public Trial.Builder addMeasurements(Measurement.Builder builderForValue)

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
NameDescription
builderForValueMeasurement.Builder
Returns
TypeDescription
Trial.Builder

addMeasurements(int index, Measurement value)

public Trial.Builder addMeasurements(int index, Measurement value)

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

Parameters
NameDescription
indexint
valueMeasurement
Returns
TypeDescription
Trial.Builder

addMeasurements(int index, Measurement.Builder builderForValue)

public Trial.Builder addMeasurements(int index, Measurement.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueMeasurement.Builder
Returns
TypeDescription
Trial.Builder

addMeasurementsBuilder()

public Measurement.Builder addMeasurementsBuilder()

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
TypeDescription
Measurement.Builder

addMeasurementsBuilder(int index)

public Measurement.Builder addMeasurementsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Measurement.Builder

addParameters(Trial.Parameter value)

public Trial.Builder addParameters(Trial.Parameter value)

Output only. The parameters of the Trial.

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

Parameter
NameDescription
valueTrial.Parameter
Returns
TypeDescription
Trial.Builder

addParameters(Trial.Parameter.Builder builderForValue)

public Trial.Builder addParameters(Trial.Parameter.Builder builderForValue)

Output only. The parameters of the Trial.

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

Parameter
NameDescription
builderForValueTrial.Parameter.Builder
Returns
TypeDescription
Trial.Builder

addParameters(int index, Trial.Parameter value)

public Trial.Builder addParameters(int index, Trial.Parameter value)

Output only. The parameters of the Trial.

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

Parameters
NameDescription
indexint
valueTrial.Parameter
Returns
TypeDescription
Trial.Builder

addParameters(int index, Trial.Parameter.Builder builderForValue)

public Trial.Builder addParameters(int index, Trial.Parameter.Builder builderForValue)

Output only. The parameters of the Trial.

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

Parameters
NameDescription
indexint
builderForValueTrial.Parameter.Builder
Returns
TypeDescription
Trial.Builder

addParametersBuilder()

public Trial.Parameter.Builder addParametersBuilder()

Output only. The parameters of the Trial.

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

Returns
TypeDescription
Trial.Parameter.Builder

addParametersBuilder(int index)

public Trial.Parameter.Builder addParametersBuilder(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
NameDescription
indexint
Returns
TypeDescription
Trial.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Trial.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Trial.Builder
Overrides

build()

public Trial build()
Returns
TypeDescription
Trial

buildPartial()

public Trial buildPartial()
Returns
TypeDescription
Trial

clear()

public Trial.Builder clear()
Returns
TypeDescription
Trial.Builder
Overrides

clearClientId()

public Trial.Builder clearClientId()

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
Trial.Builder

This builder for chaining.

clearCustomJob()

public Trial.Builder clearCustomJob()

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
Trial.Builder

This builder for chaining.

clearEndTime()

public Trial.Builder clearEndTime()

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
Trial.Builder

clearField(Descriptors.FieldDescriptor field)

public Trial.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Trial.Builder
Overrides

clearFinalMeasurement()

public Trial.Builder clearFinalMeasurement()

Output only. The final measurement containing the objective value.

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

Returns
TypeDescription
Trial.Builder

clearId()

public Trial.Builder clearId()

Output only. The identifier of the Trial assigned by the service.

string id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Trial.Builder

This builder for chaining.

clearInfeasibleReason()

public Trial.Builder clearInfeasibleReason()

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
Trial.Builder

This builder for chaining.

clearMeasurements()

public Trial.Builder clearMeasurements()

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
TypeDescription
Trial.Builder

clearName()

public Trial.Builder clearName()

Output only. Resource name of the Trial assigned by the service.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Trial.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Trial.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Trial.Builder
Overrides

clearParameters()

public Trial.Builder clearParameters()

Output only. The parameters of the Trial.

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

Returns
TypeDescription
Trial.Builder

clearStartTime()

public Trial.Builder clearStartTime()

Output only. Time when the Trial was started.

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Trial.Builder

clearState()

public Trial.Builder clearState()

Output only. The detailed state of the Trial.

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

Returns
TypeDescription
Trial.Builder

This builder for chaining.

clearWebAccessUris()

public Trial.Builder clearWebAccessUris()
Returns
TypeDescription
Trial.Builder

clone()

public Trial.Builder clone()
Returns
TypeDescription
Trial.Builder
Overrides

containsWebAccessUris(String key)

public 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 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 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 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 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.

getDefaultInstanceForType()

public Trial getDefaultInstanceForType()
Returns
TypeDescription
Trial

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public 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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

getEndTimeOrBuilder()

public 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 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
TypeDescription
Measurement

The finalMeasurement.

getFinalMeasurementBuilder()

public Measurement.Builder getFinalMeasurementBuilder()

Output only. The final measurement containing the objective value.

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

Returns
TypeDescription
Measurement.Builder

getFinalMeasurementOrBuilder()

public 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
TypeDescription
MeasurementOrBuilder

getId()

public 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 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 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 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 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
NameDescription
indexint
Returns
TypeDescription
Measurement

getMeasurementsBuilder(int index)

public Measurement.Builder getMeasurementsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Measurement.Builder

getMeasurementsBuilderList()

public List<Measurement.Builder> getMeasurementsBuilderList()

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
TypeDescription
List<Builder>

getMeasurementsCount()

public 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
TypeDescription
int

getMeasurementsList()

public 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
TypeDescription
List<Measurement>

getMeasurementsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
MeasurementOrBuilder

getMeasurementsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.MeasurementOrBuilder>

getMutableWebAccessUris() (deprecated)

public Map<String,String> getMutableWebAccessUris()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public 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.