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
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name | Description |
values | Iterable<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate>
|
Returns
addCandidates(Model.PageOptimizationConfig.Candidate value)
public Model.PageOptimizationConfig.Panel.Builder addCandidates(Model.PageOptimizationConfig.Candidate value)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
addCandidatesBuilder()
public Model.PageOptimizationConfig.Candidate.Builder addCandidatesBuilder()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
addCandidatesBuilder(int index)
public Model.PageOptimizationConfig.Candidate.Builder addCandidatesBuilder(int index)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Model.PageOptimizationConfig.Panel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public Model.PageOptimizationConfig.Panel build()
Returns
buildPartial()
public Model.PageOptimizationConfig.Panel buildPartial()
Returns
clear()
public Model.PageOptimizationConfig.Panel.Builder clear()
Returns
Overrides
clearCandidates()
public Model.PageOptimizationConfig.Panel.Builder clearCandidates()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
clearDefaultCandidate()
public Model.PageOptimizationConfig.Panel.Builder clearDefaultCandidate()
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
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
clearField(Descriptors.FieldDescriptor field)
public Model.PageOptimizationConfig.Panel.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Model.PageOptimizationConfig.Panel.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public Model.PageOptimizationConfig.Panel.Builder clone()
Returns
Overrides
getCandidates(int index)
public Model.PageOptimizationConfig.Candidate getCandidates(int index)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
getCandidatesBuilder(int index)
public Model.PageOptimizationConfig.Candidate.Builder getCandidatesBuilder(int index)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
getCandidatesBuilderList()
public List<Model.PageOptimizationConfig.Candidate.Builder> getCandidatesBuilderList()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
getCandidatesCount()
public int getCandidatesCount()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
getCandidatesList()
public List<Model.PageOptimizationConfig.Candidate> getCandidatesList()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
getCandidatesOrBuilder(int index)
public Model.PageOptimizationConfig.CandidateOrBuilder getCandidatesOrBuilder(int index)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
getCandidatesOrBuilderList()
public List<? extends Model.PageOptimizationConfig.CandidateOrBuilder> getCandidatesOrBuilderList()
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
List<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.CandidateOrBuilder> | |
getDefaultCandidate()
public Model.PageOptimizationConfig.Candidate getDefaultCandidate()
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getDefaultCandidateBuilder()
public Model.PageOptimizationConfig.Candidate.Builder getDefaultCandidateBuilder()
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getDefaultCandidateOrBuilder()
public Model.PageOptimizationConfig.CandidateOrBuilder getDefaultCandidateOrBuilder()
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getDefaultInstanceForType()
public Model.PageOptimizationConfig.Panel getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getDisplayName()
public String getDisplayName()
Optional. The name to display for the panel.
string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
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
Type | Description |
ByteString | The bytes for displayName.
|
hasDefaultCandidate()
public boolean hasDefaultCandidate()
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the defaultCandidate field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeDefaultCandidate(Model.PageOptimizationConfig.Candidate value)
public Model.PageOptimizationConfig.Panel.Builder mergeDefaultCandidate(Model.PageOptimizationConfig.Candidate value)
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
mergeFrom(Model.PageOptimizationConfig.Panel other)
public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Model.PageOptimizationConfig.Panel other)
Parameter
Returns
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Model.PageOptimizationConfig.Panel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Model.PageOptimizationConfig.Panel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
removeCandidates(int index)
public Model.PageOptimizationConfig.Panel.Builder removeCandidates(int index)
Required. The candidates to consider on the panel.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
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.
Limit = 10.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];
Parameters
Returns
setDefaultCandidate(Model.PageOptimizationConfig.Candidate value)
public Model.PageOptimizationConfig.Panel.Builder setDefaultCandidate(Model.PageOptimizationConfig.Candidate value)
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
setDefaultCandidate(Model.PageOptimizationConfig.Candidate.Builder builderForValue)
public Model.PageOptimizationConfig.Panel.Builder setDefaultCandidate(Model.PageOptimizationConfig.Candidate.Builder builderForValue)
Required. The default candidate (in case the model fails at serving
time, we can fall back to the default).
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Returns
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
Name | Description |
value | String
The displayName to set.
|
Returns
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
Name | Description |
value | ByteString
The bytes for displayName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Model.PageOptimizationConfig.Panel.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Model.PageOptimizationConfig.Panel.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Model.PageOptimizationConfig.Panel.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides