Class Trial.Builder (3.43.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Trial.Builder

Implements

TrialOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Measurement>
Returns
Type Description
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
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.Trial.Parameter>
Returns
Type Description
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
Name Description
value Measurement
Returns
Type Description
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
Name Description
builderForValue Measurement.Builder
Returns
Type Description
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
Name Description
index int
value Measurement
Returns
Type Description
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
Name Description
index int
builderForValue Measurement.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
value Trial.Parameter
Returns
Type Description
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
Name Description
builderForValue Trial.Parameter.Builder
Returns
Type Description
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
Name Description
index int
value Trial.Parameter
Returns
Type Description
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
Name Description
index int
builderForValue Trial.Parameter.Builder
Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
Trial.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Trial.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Trial.Builder
Overrides

build()

public Trial build()
Returns
Type Description
Trial

buildPartial()

public Trial buildPartial()
Returns
Type Description
Trial

clear()

public Trial.Builder clear()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
Trial.Builder

clearField(Descriptors.FieldDescriptor field)

public Trial.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
Trial.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Trial.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
Trial.Builder

This builder for chaining.

clearWebAccessUris()

public Trial.Builder clearWebAccessUris()
Returns
Type Description
Trial.Builder

clone()

public Trial.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for customJob.

getDefaultInstanceForType()

public Trial getDefaultInstanceForType()
Returns
Type Description
Trial

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.MeasurementOrBuilder>

getMutableWebAccessUris() (deprecated)

public Map<String,String> getMutableWebAccessUris()

Use alternate mutation accessors instead.

Returns
Type Description
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
Type Description
String

The name.

getNameBytes()

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

getParametersBuilder(int index)

public Trial.Parameter.Builder getParametersBuilder(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.Builder

getParametersBuilderList()

public List<Trial.Parameter.Builder> getParametersBuilderList()

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

getParametersCount()

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

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. Time when the Trial was started.

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

Returns
Type Description
Builder

getStartTimeOrBuilder()

public 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 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 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 Map<String,String> getWebAccessUris()

Use #getWebAccessUrisMap() instead.

Returns
Type Description
Map<String,String>

getWebAccessUrisCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public Trial.Builder mergeEndTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Trial.Builder

mergeFinalMeasurement(Measurement value)

public Trial.Builder mergeFinalMeasurement(Measurement value)

Output only. The final measurement containing the objective value.

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

Parameter
Name Description
value Measurement
Returns
Type Description
Trial.Builder

mergeFrom(Trial other)

public Trial.Builder mergeFrom(Trial other)
Parameter
Name Description
other Trial
Returns
Type Description
Trial.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Trial.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Trial.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Trial.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Trial.Builder
Overrides

mergeStartTime(Timestamp value)

public Trial.Builder mergeStartTime(Timestamp value)

Output only. Time when the Trial was started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Trial.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Trial.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Trial.Builder
Overrides

putAllWebAccessUris(Map<String,String> values)

public Trial.Builder putAllWebAccessUris(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Trial.Builder

putWebAccessUris(String key, String value)

public Trial.Builder putWebAccessUris(String key, String value)

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
value String
Returns
Type Description
Trial.Builder

removeMeasurements(int index)

public Trial.Builder removeMeasurements(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
Trial.Builder

removeParameters(int index)

public Trial.Builder removeParameters(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.Builder

removeWebAccessUris(String key)

public Trial.Builder removeWebAccessUris(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
Trial.Builder

setClientId(String value)

public Trial.Builder setClientId(String value)

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

Parameter
Name Description
value String

The clientId to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setClientIdBytes(ByteString value)

public Trial.Builder setClientIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for clientId to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setCustomJob(String value)

public Trial.Builder setCustomJob(String value)

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) = { ... }

Parameter
Name Description
value String

The customJob to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setCustomJobBytes(ByteString value)

public Trial.Builder setCustomJobBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for customJob to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Trial.Builder setEndTime(Timestamp value)

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Trial.Builder

setEndTime(Timestamp.Builder builderForValue)

public Trial.Builder setEndTime(Timestamp.Builder builderForValue)

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Trial.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Trial.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Trial.Builder
Overrides

setFinalMeasurement(Measurement value)

public Trial.Builder setFinalMeasurement(Measurement value)

Output only. The final measurement containing the objective value.

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

Parameter
Name Description
value Measurement
Returns
Type Description
Trial.Builder

setFinalMeasurement(Measurement.Builder builderForValue)

public Trial.Builder setFinalMeasurement(Measurement.Builder builderForValue)

Output only. The final measurement containing the objective value.

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

Parameter
Name Description
builderForValue Measurement.Builder
Returns
Type Description
Trial.Builder

setId(String value)

public Trial.Builder setId(String value)

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

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

Parameter
Name Description
value String

The id to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Trial.Builder setIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setInfeasibleReason(String value)

public Trial.Builder setInfeasibleReason(String value)

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

Parameter
Name Description
value String

The infeasibleReason to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setInfeasibleReasonBytes(ByteString value)

public Trial.Builder setInfeasibleReasonBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for infeasibleReason to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setMeasurements(int index, Measurement value)

public Trial.Builder setMeasurements(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
Name Description
index int
value Measurement
Returns
Type Description
Trial.Builder

setMeasurements(int index, Measurement.Builder builderForValue)

public Trial.Builder setMeasurements(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
Name Description
index int
builderForValue Measurement.Builder
Returns
Type Description
Trial.Builder

setName(String value)

public Trial.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Trial.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setParameters(int index, Trial.Parameter value)

public Trial.Builder setParameters(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
Name Description
index int
value Trial.Parameter
Returns
Type Description
Trial.Builder

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

public Trial.Builder setParameters(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
Name Description
index int
builderForValue Trial.Parameter.Builder
Returns
Type Description
Trial.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Trial.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Trial.Builder
Overrides

setStartTime(Timestamp value)

public Trial.Builder setStartTime(Timestamp value)

Output only. Time when the Trial was started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Trial.Builder

setStartTime(Timestamp.Builder builderForValue)

public Trial.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. Time when the Trial was started.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Trial.Builder

setState(Trial.State value)

public Trial.Builder setState(Trial.State value)

Output only. The detailed state of the Trial.

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

Parameter
Name Description
value Trial.State

The state to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setStateValue(int value)

public Trial.Builder setStateValue(int value)

Output only. The detailed state of the Trial.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Trial.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Trial.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Trial.Builder
Overrides