Class Model.PageOptimizationConfig (2.47.0)

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

Inheritance

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

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()
Returns
Type Description
Model.PageOptimizationConfig

getDescriptor()

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

newBuilder()

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

newBuilder(Model.PageOptimizationConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Model.PageOptimizationConfig getDefaultInstanceForType()
Returns
Type Description
Model.PageOptimizationConfig

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:

  • add-to-cart: Products being added to cart.
  • detail-page-view: Products detail page viewed.
  • home-page-view: Homepage viewed
  • category-page-view: Homepage viewed

  • shopping-cart-page-view: User viewing a shopping cart.

    home-page-view only allows models with type recommended-for-you. All other page_optimization_event_type allow all Model.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:

  • add-to-cart: Products being added to cart.
  • detail-page-view: Products detail page viewed.
  • home-page-view: Homepage viewed
  • category-page-view: Homepage viewed

  • shopping-cart-page-view: User viewing a shopping cart.

    home-page-view only allows models with type recommended-for-you. All other page_optimization_event_type allow all Model.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
index int
Returns
Type Description
Model.PageOptimizationConfig.Panel

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

Returns
Type Description
List<Panel>

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
index int
Returns
Type Description
Model.PageOptimizationConfig.PanelOrBuilder

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()
Returns
Type Description
Parser<PageOptimizationConfig>
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];

Returns
Type Description
Model.PageOptimizationConfig.Restriction

The restriction.

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()

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.Builder newBuilderForType()
Returns
Type Description
Model.PageOptimizationConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.PageOptimizationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Model.PageOptimizationConfig.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.Builder toBuilder()
Returns
Type Description
Model.PageOptimizationConfig.Builder

writeTo(CodedOutputStream output)

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