Class Model.PageOptimizationConfig (2.11.0)

Version 2.11.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

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

Implements

Model.PageOptimizationConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException