Class Model.PageOptimizationConfig (2.39.0)
Version 2.39.0keyboard_arrow_down
public static final class Model . PageOptimizationConfig extends GeneratedMessageV3 implements Model . PageOptimizationConfigOrBuilder
The PageOptimizationConfig for model training.
This determines how many panels to optimize for, and which serving
configs to consider for each panel.
The purpose of this model is to optimize which
ServingConfig to show on which
panels in way that optimizes the visitors shopping journey.
Protobuf type google.cloud.retail.v2alpha.Model.PageOptimizationConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PAGE_OPTIMIZATION_EVENT_TYPE_FIELD_NUMBER
public static final int PAGE_OPTIMIZATION_EVENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int
PANELS_FIELD_NUMBER
public static final int PANELS_FIELD_NUMBER
Field Value
Type Description
int
RESTRICTION_FIELD_NUMBER
public static final int RESTRICTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Model . PageOptimizationConfig getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Model . PageOptimizationConfig . Builder newBuilder ()
newBuilder(Model.PageOptimizationConfig prototype)
public static Model . PageOptimizationConfig . Builder newBuilder ( Model . PageOptimizationConfig prototype )
parseDelimitedFrom(InputStream input)
public static Model . PageOptimizationConfig parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Model . PageOptimizationConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Model . PageOptimizationConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static Model . PageOptimizationConfig parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static Model . PageOptimizationConfig parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Model . PageOptimizationConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Model . PageOptimizationConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Model . PageOptimizationConfig > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Model . PageOptimizationConfig getDefaultInstanceForType ()
getPageOptimizationEventType()
public String getPageOptimizationEventType ()
Required. The type of UserEvent
this page optimization is shown for.
Each page has an associated event type - this will be the
corresponding event type for the page that the page optimization
model is used on.
Supported types:
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The pageOptimizationEventType.
getPageOptimizationEventTypeBytes()
public ByteString getPageOptimizationEventTypeBytes ()
Required. The type of UserEvent
this page optimization is shown for.
Each page has an associated event type - this will be the
corresponding event type for the page that the page optimization
model is used on.
Supported types:
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for pageOptimizationEventType.
getPanels(int index)
public Model . PageOptimizationConfig . Panel getPanels ( int index )
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description
indexint
getPanelsCount()
public int getPanelsCount ()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int
getPanelsList()
public List<Model . PageOptimizationConfig . Panel > getPanelsList ()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
getPanelsOrBuilder(int index)
public Model . PageOptimizationConfig . PanelOrBuilder getPanelsOrBuilder ( int index )
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description
indexint
getPanelsOrBuilderList()
public List <? extends Model . PageOptimizationConfig . PanelOrBuilder > getPanelsOrBuilderList ()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
List <? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.PanelOrBuilder >
getParserForType()
public Parser<Model . PageOptimizationConfig > getParserForType ()
Overrides
getRestriction()
public Model . PageOptimizationConfig . Restriction getRestriction ()
Optional. How to restrict results across panels e.g. can the same
ServingConfig be shown on
multiple panels at once.
If unspecified, default to UNIQUE_MODEL_RESTRICTION.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction restriction = 3 [(.google.api.field_behavior) = OPTIONAL];
getRestrictionValue()
public int getRestrictionValue ()
Optional. How to restrict results across panels e.g. can the same
ServingConfig be shown on
multiple panels at once.
If unspecified, default to UNIQUE_MODEL_RESTRICTION.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction restriction = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The enum numeric value on the wire for restriction.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Model . PageOptimizationConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Model . PageOptimizationConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Model . PageOptimizationConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
