Package com.google.cloud.retail.v2alpha

Class Model.PageOptimizationConfig.Panel.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel.Builder

All Implemented Interfaces:

Model.PageOptimizationConfig.PanelOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Model.PageOptimizationConfig.Panel

public static final class Model.PageOptimizationConfig.Panel.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>
implements Model.PageOptimizationConfig.PanelOrBuilder

 An individual panel with a list of
 [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] to consider
 for it.
 

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

Method Summary

Modifier and Type	Method	Description
Model.PageOptimizationConfig.Panel.Builder	addAllCandidates(Iterable<? extends Model.PageOptimizationConfig.Candidate> values)	Required.
Model.PageOptimizationConfig.Panel.Builder	addCandidates(int index, Model.PageOptimizationConfig.Candidate value)	Required.
Model.PageOptimizationConfig.Panel.Builder	addCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)	Required.
Model.PageOptimizationConfig.Panel.Builder	addCandidates(Model.PageOptimizationConfig.Candidate value)	Required.
Model.PageOptimizationConfig.Panel.Builder	addCandidates(Model.PageOptimizationConfig.Candidate.Builder builderForValue)	Required.
Model.PageOptimizationConfig.Candidate.Builder	addCandidatesBuilder()	Required.
Model.PageOptimizationConfig.Candidate.Builder	addCandidatesBuilder(int index)	Required.
Model.PageOptimizationConfig.Panel	build()
Model.PageOptimizationConfig.Panel	buildPartial()
Model.PageOptimizationConfig.Panel.Builder	clear()
Model.PageOptimizationConfig.Panel.Builder	clearCandidates()	Required.
Model.PageOptimizationConfig.Panel.Builder	clearDefaultCandidate()	Required.
Model.PageOptimizationConfig.Panel.Builder	clearDisplayName()	Optional.
Model.PageOptimizationConfig.Candidate	getCandidates(int index)	Required.
Model.PageOptimizationConfig.Candidate.Builder	getCandidatesBuilder(int index)	Required.
List<Model.PageOptimizationConfig.Candidate.Builder>	getCandidatesBuilderList()	Required.
int	getCandidatesCount()	Required.
List<Model.PageOptimizationConfig.Candidate>	getCandidatesList()	Required.
Model.PageOptimizationConfig.CandidateOrBuilder	getCandidatesOrBuilder(int index)	Required.
List<? extends Model.PageOptimizationConfig.CandidateOrBuilder>	getCandidatesOrBuilderList()	Required.
Model.PageOptimizationConfig.Candidate	getDefaultCandidate()	Required.
Model.PageOptimizationConfig.Candidate.Builder	getDefaultCandidateBuilder()	Required.
Model.PageOptimizationConfig.CandidateOrBuilder	getDefaultCandidateOrBuilder()	Required.
Model.PageOptimizationConfig.Panel	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getDisplayName()	Optional.
com.google.protobuf.ByteString	getDisplayNameBytes()	Optional.
boolean	hasDefaultCandidate()	Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Model.PageOptimizationConfig.Panel.Builder	mergeDefaultCandidate(Model.PageOptimizationConfig.Candidate value)	Required.
Model.PageOptimizationConfig.Panel.Builder	mergeFrom(Model.PageOptimizationConfig.Panel other)
Model.PageOptimizationConfig.Panel.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Model.PageOptimizationConfig.Panel.Builder	mergeFrom(com.google.protobuf.Message other)
Model.PageOptimizationConfig.Panel.Builder	removeCandidates(int index)	Required.
Model.PageOptimizationConfig.Panel.Builder	setCandidates(int index, Model.PageOptimizationConfig.Candidate value)	Required.
Model.PageOptimizationConfig.Panel.Builder	setCandidates(int index, Model.PageOptimizationConfig.Candidate.Builder builderForValue)	Required.
Model.PageOptimizationConfig.Panel.Builder	setDefaultCandidate(Model.PageOptimizationConfig.Candidate value)	Required.
Model.PageOptimizationConfig.Panel.Builder	setDefaultCandidate(Model.PageOptimizationConfig.Candidate.Builder builderForValue)	Required.
Model.PageOptimizationConfig.Panel.Builder	setDisplayName(String value)	Optional.
Model.PageOptimizationConfig.Panel.Builder	setDisplayNameBytes(com.google.protobuf.ByteString value)	Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

clear

public Model.PageOptimizationConfig.Panel.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

getDefaultInstanceForType

public Model.PageOptimizationConfig.Panel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Model.PageOptimizationConfig.Panel build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Model.PageOptimizationConfig.Panel buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

mergeFrom

public Model.PageOptimizationConfig.Panel.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.PageOptimizationConfig.Panel.Builder>

Throws:

IOException

getDisplayName

public String getDisplayName()

 Optional. The name to display for the panel.
 

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

Specified by:

getDisplayName in interface Model.PageOptimizationConfig.PanelOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Optional. The name to display for the panel.
 

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

Specified by:

getDisplayNameBytes in interface Model.PageOptimizationConfig.PanelOrBuilder

Returns:

The bytes for displayName.

setDisplayName

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

Parameters:

value - The displayName to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setDisplayNameBytes

public Model.PageOptimizationConfig.Panel.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)

 Optional. The name to display for the panel.
 

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

Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

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

Specified by:

getCandidatesList in interface Model.PageOptimizationConfig.PanelOrBuilder

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

Specified by:

getCandidatesCount in interface Model.PageOptimizationConfig.PanelOrBuilder

getCandidates

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

Specified by:

getCandidates in interface Model.PageOptimizationConfig.PanelOrBuilder

setCandidates

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

setCandidates

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

addCandidates

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

addCandidates

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

addCandidates

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

addCandidates

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

addAllCandidates

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

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

removeCandidates

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

getCandidatesBuilder

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

getCandidatesOrBuilder

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

Specified by:

getCandidatesOrBuilder in interface Model.PageOptimizationConfig.PanelOrBuilder

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

Specified by:

getCandidatesOrBuilderList in interface Model.PageOptimizationConfig.PanelOrBuilder

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

addCandidatesBuilder

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

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

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

Specified by:

hasDefaultCandidate in interface Model.PageOptimizationConfig.PanelOrBuilder

Returns:

Whether the defaultCandidate field is set.

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

Specified by:

getDefaultCandidate in interface Model.PageOptimizationConfig.PanelOrBuilder

Returns:

The defaultCandidate.

setDefaultCandidate

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

setDefaultCandidate

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

mergeDefaultCandidate

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

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

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

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

Specified by:

getDefaultCandidateOrBuilder in interface Model.PageOptimizationConfig.PanelOrBuilder