Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Model.PageOptimizationConfig.Panel.Builder (2.89.0)

public static final class Model.PageOptimizationConfig.Panel.Builder extends GeneratedMessage.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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Model.PageOptimizationConfig.Panel.Builder

Implements

Model.PageOptimizationConfig.PanelOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate>`

Returns
Type	Description
`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
Name	Description
`value`	`Model.PageOptimizationConfig.Candidate`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`Model.PageOptimizationConfig.Candidate.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`Model.PageOptimizationConfig.Candidate`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`Model.PageOptimizationConfig.Candidate.Builder`

Returns
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`Model.PageOptimizationConfig.Candidate.Builder`

build()

public Model.PageOptimizationConfig.Panel build()

Returns
Type	Description
`Model.PageOptimizationConfig.Panel`

buildPartial()

public Model.PageOptimizationConfig.Panel buildPartial()

Returns
Type	Description
`Model.PageOptimizationConfig.Panel`

clear()

public Model.PageOptimizationConfig.Panel.Builder clear()

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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
Type	Description
`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
Type	Description
`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
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`	This builder for chaining.

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`Model.PageOptimizationConfig.CandidateOrBuilder`

getDefaultInstanceForType()

public Model.PageOptimizationConfig.Panel getDefaultInstanceForType()

Returns
Type	Description
`Model.PageOptimizationConfig.Panel`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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. 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
Type	Description
`boolean`	Whether the defaultCandidate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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
Name	Description
`value`	`Model.PageOptimizationConfig.Candidate`

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`

mergeFrom(Model.PageOptimizationConfig.Panel other)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Model.PageOptimizationConfig.Panel other)

Parameter
Name	Description
`other`	`Model.PageOptimizationConfig.Panel`

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`Model.PageOptimizationConfig.Candidate`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`Model.PageOptimizationConfig.Candidate.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`Model.PageOptimizationConfig.Candidate`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`Model.PageOptimizationConfig.Candidate.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`Model.PageOptimizationConfig.Panel.Builder`	This builder for chaining.