Class Model.PageOptimizationConfig.Panel.Builder (2.41.0)

public static final class Model.PageOptimizationConfig.Panel.Builder extends GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Panel.Builder> implements Model.PageOptimizationConfig.PanelOrBuilder

An individual panel with a list of ServingConfigs to consider for it.

Protobuf type google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel

Static Methods

getDescriptor()

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

Methods

addAllCandidates(Iterable<? extends Model.PageOptimizationConfig.Candidate> values)

public Model.PageOptimizationConfig.Panel.Builder addAllCandidates(Iterable<? extends Model.PageOptimizationConfig.Candidate> values)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate>
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

addCandidates(Model.PageOptimizationConfig.Candidate value)

public Model.PageOptimizationConfig.Panel.Builder addCandidates(Model.PageOptimizationConfig.Candidate value)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

addCandidates(Model.PageOptimizationConfig.Candidate.Builder builderForValue)

public Model.PageOptimizationConfig.Panel.Builder addCandidates(Model.PageOptimizationConfig.Candidate.Builder builderForValue)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueModel.PageOptimizationConfig.Candidate.Builder
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

addCandidates(int index, Model.PageOptimizationConfig.Candidate value)

public Model.PageOptimizationConfig.Panel.Builder addCandidates(int index, Model.PageOptimizationConfig.Candidate value)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

addCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)

public Model.PageOptimizationConfig.Panel.Builder addCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueModel.PageOptimizationConfig.Candidate.Builder
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

addCandidatesBuilder()

public Model.PageOptimizationConfig.Candidate.Builder addCandidatesBuilder()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

addCandidatesBuilder(int index)

public Model.PageOptimizationConfig.Candidate.Builder addCandidatesBuilder(int index)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Model.PageOptimizationConfig.Panel build()
Returns
TypeDescription
Model.PageOptimizationConfig.Panel

buildPartial()

public Model.PageOptimizationConfig.Panel buildPartial()
Returns
TypeDescription
Model.PageOptimizationConfig.Panel

clear()

public Model.PageOptimizationConfig.Panel.Builder clear()
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

clearCandidates()

public Model.PageOptimizationConfig.Panel.Builder clearCandidates()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

clearDefaultCandidate()

public Model.PageOptimizationConfig.Panel.Builder clearDefaultCandidate()

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

clearDisplayName()

public Model.PageOptimizationConfig.Panel.Builder clearDisplayName()

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Model.PageOptimizationConfig.Panel.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Model.PageOptimizationConfig.Panel.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

clone()

public Model.PageOptimizationConfig.Panel.Builder clone()
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

getCandidates(int index)

public Model.PageOptimizationConfig.Candidate getCandidates(int index)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

getCandidatesBuilder(int index)

public Model.PageOptimizationConfig.Candidate.Builder getCandidatesBuilder(int index)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

getCandidatesBuilderList()

public List<Model.PageOptimizationConfig.Candidate.Builder> getCandidatesBuilderList()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Builder>

getCandidatesCount()

public int getCandidatesCount()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getCandidatesList()

public List<Model.PageOptimizationConfig.Candidate> getCandidatesList()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Candidate>

getCandidatesOrBuilder(int index)

public Model.PageOptimizationConfig.CandidateOrBuilder getCandidatesOrBuilder(int index)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.CandidateOrBuilder

getCandidatesOrBuilderList()

public List<? extends Model.PageOptimizationConfig.CandidateOrBuilder> getCandidatesOrBuilderList()

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.CandidateOrBuilder>

getDefaultCandidate()

public Model.PageOptimizationConfig.Candidate getDefaultCandidate()

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

The defaultCandidate.

getDefaultCandidateBuilder()

public Model.PageOptimizationConfig.Candidate.Builder getDefaultCandidateBuilder()

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

getDefaultCandidateOrBuilder()

public Model.PageOptimizationConfig.CandidateOrBuilder getDefaultCandidateOrBuilder()

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.CandidateOrBuilder

getDefaultInstanceForType()

public Model.PageOptimizationConfig.Panel getDefaultInstanceForType()
Returns
TypeDescription
Model.PageOptimizationConfig.Panel

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for displayName.

hasDefaultCandidate()

public boolean hasDefaultCandidate()

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the defaultCandidate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDefaultCandidate(Model.PageOptimizationConfig.Candidate value)

public Model.PageOptimizationConfig.Panel.Builder mergeDefaultCandidate(Model.PageOptimizationConfig.Candidate value)

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

mergeFrom(Model.PageOptimizationConfig.Panel other)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Model.PageOptimizationConfig.Panel other)
Parameter
NameDescription
otherModel.PageOptimizationConfig.Panel
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Panel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

removeCandidates(int index)

public Model.PageOptimizationConfig.Panel.Builder removeCandidates(int index)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

setCandidates(int index, Model.PageOptimizationConfig.Candidate value)

public Model.PageOptimizationConfig.Panel.Builder setCandidates(int index, Model.PageOptimizationConfig.Candidate value)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
valueModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

setCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)

public Model.PageOptimizationConfig.Panel.Builder setCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)

Required. The candidates to consider on the panel.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint
builderForValueModel.PageOptimizationConfig.Candidate.Builder
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

setDefaultCandidate(Model.PageOptimizationConfig.Candidate value)

public Model.PageOptimizationConfig.Panel.Builder setDefaultCandidate(Model.PageOptimizationConfig.Candidate value)

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

setDefaultCandidate(Model.PageOptimizationConfig.Candidate.Builder builderForValue)

public Model.PageOptimizationConfig.Panel.Builder setDefaultCandidate(Model.PageOptimizationConfig.Candidate.Builder builderForValue)

Required. The default candidate. If the model fails at serving time, we fall back to the default.

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueModel.PageOptimizationConfig.Candidate.Builder
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

setDisplayName(String value)

public Model.PageOptimizationConfig.Panel.Builder setDisplayName(String value)

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Model.PageOptimizationConfig.Panel.Builder setDisplayNameBytes(ByteString value)

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Model.PageOptimizationConfig.Panel.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

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

public Model.PageOptimizationConfig.Panel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Panel.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Model.PageOptimizationConfig.Panel.Builder
Overrides