Class Model.PageOptimizationConfig.Panel (2.48.0)

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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Model.PageOptimizationConfig.Panel

Static Fields

CANDIDATES_FIELD_NUMBER

public static final int CANDIDATES_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_CANDIDATE_FIELD_NUMBER

public static final int DEFAULT_CANDIDATE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Model.PageOptimizationConfig.Panel getDefaultInstance()
Returns
Type Description
Model.PageOptimizationConfig.Panel

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Model.PageOptimizationConfig.Panel.Builder newBuilder()
Returns
Type Description
Model.PageOptimizationConfig.Panel.Builder

newBuilder(Model.PageOptimizationConfig.Panel prototype)

public static Model.PageOptimizationConfig.Panel.Builder newBuilder(Model.PageOptimizationConfig.Panel prototype)
Parameter
Name Description
prototype Model.PageOptimizationConfig.Panel
Returns
Type Description
Model.PageOptimizationConfig.Panel.Builder

parseDelimitedFrom(InputStream input)

public static Model.PageOptimizationConfig.Panel parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Model.PageOptimizationConfig.Panel parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Model.PageOptimizationConfig.Panel parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Model.PageOptimizationConfig.Panel parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Model.PageOptimizationConfig.Panel parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Model.PageOptimizationConfig.Panel parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Panel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.PageOptimizationConfig.Panel
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Model.PageOptimizationConfig.Panel> parser()
Returns
Type Description
Parser<Panel>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Name Description
index int
Returns
Type Description
Model.PageOptimizationConfig.Candidate

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.

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

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.

getParserForType()

public Parser<Model.PageOptimizationConfig.Panel> getParserForType()
Returns
Type Description
Parser<Panel>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Model.PageOptimizationConfig.Panel.Builder newBuilderForType()
Returns
Type Description
Model.PageOptimizationConfig.Panel.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.PageOptimizationConfig.Panel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Model.PageOptimizationConfig.Panel.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Model.PageOptimizationConfig.Panel.Builder toBuilder()
Returns
Type Description
Model.PageOptimizationConfig.Panel.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException