com.google.cloud.retail.v2alpha

Class Model.PageOptimizationConfig.Panel

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

Model.PageOptimizationConfig

public static final class Model.PageOptimizationConfig.Panel
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Model.PageOptimizationConfig.Panel.Builder An individual panel with a list of [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] to consider for it.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANDIDATES_FIELD_NUMBER
static int	DEFAULT_CANDIDATE_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Model.PageOptimizationConfig.Candidate	getCandidates(int index) 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.CandidateOrBuilder	getDefaultCandidateOrBuilder() Required.
static Model.PageOptimizationConfig.Panel	getDefaultInstance()
Model.PageOptimizationConfig.Panel	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
com.google.protobuf.Parser<Model.PageOptimizationConfig.Panel>	getParserForType()
int	getSerializedSize()
boolean	hasDefaultCandidate() Required.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Model.PageOptimizationConfig.Panel.Builder	newBuilder()
static Model.PageOptimizationConfig.Panel.Builder	newBuilder(Model.PageOptimizationConfig.Panel prototype)
Model.PageOptimizationConfig.Panel.Builder	newBuilderForType()
protected Model.PageOptimizationConfig.Panel.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Model.PageOptimizationConfig.Panel	parseDelimitedFrom(InputStream input)
static Model.PageOptimizationConfig.Panel	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model.PageOptimizationConfig.Panel	parseFrom(byte[] data)
static Model.PageOptimizationConfig.Panel	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model.PageOptimizationConfig.Panel	parseFrom(ByteBuffer data)
static Model.PageOptimizationConfig.Panel	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model.PageOptimizationConfig.Panel	parseFrom(com.google.protobuf.ByteString data)
static Model.PageOptimizationConfig.Panel	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model.PageOptimizationConfig.Panel	parseFrom(com.google.protobuf.CodedInputStream input)
static Model.PageOptimizationConfig.Panel	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Model.PageOptimizationConfig.Panel	parseFrom(InputStream input)
static Model.PageOptimizationConfig.Panel	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Model.PageOptimizationConfig.Panel>	parser()
Model.PageOptimizationConfig.Panel.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CANDIDATES_FIELD_NUMBER

public static final int CANDIDATES_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_CANDIDATE_FIELD_NUMBER

public static final int DEFAULT_CANDIDATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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.

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

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

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

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

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Model.PageOptimizationConfig.Panel parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Model.PageOptimizationConfig.Panel parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static Model.PageOptimizationConfig.Panel parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Model.PageOptimizationConfig.Panel.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Model.PageOptimizationConfig.Panel.Builder newBuilder()

newBuilder

public static Model.PageOptimizationConfig.Panel.Builder newBuilder(Model.PageOptimizationConfig.Panel prototype)

toBuilder

public Model.PageOptimizationConfig.Panel.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Model.PageOptimizationConfig.Panel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Model.PageOptimizationConfig.Panel getDefaultInstance()

parser

public static com.google.protobuf.Parser<Model.PageOptimizationConfig.Panel> parser()

getParserForType

public com.google.protobuf.Parser<Model.PageOptimizationConfig.Panel> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Model.PageOptimizationConfig.Panel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder