public static final class Model.PageOptimizationConfig.Builder extends GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder> 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.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllPanels(Iterable<? extends Model.PageOptimizationConfig.Panel> values)
public Model.PageOptimizationConfig.Builder addAllPanels(Iterable<? extends Model.PageOptimizationConfig.Panel> values)
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 |
values | Iterable<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel>
|
addPanels(Model.PageOptimizationConfig.Panel value)
public Model.PageOptimizationConfig.Builder addPanels(Model.PageOptimizationConfig.Panel value)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
addPanels(Model.PageOptimizationConfig.Panel.Builder builderForValue)
public Model.PageOptimizationConfig.Builder addPanels(Model.PageOptimizationConfig.Panel.Builder builderForValue)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
addPanels(int index, Model.PageOptimizationConfig.Panel value)
public Model.PageOptimizationConfig.Builder addPanels(int index, Model.PageOptimizationConfig.Panel value)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
addPanels(int index, Model.PageOptimizationConfig.Panel.Builder builderForValue)
public Model.PageOptimizationConfig.Builder addPanels(int index, Model.PageOptimizationConfig.Panel.Builder builderForValue)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
addPanelsBuilder()
public Model.PageOptimizationConfig.Panel.Builder addPanelsBuilder()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
addPanelsBuilder(int index)
public Model.PageOptimizationConfig.Panel.Builder addPanelsBuilder(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
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Model.PageOptimizationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public Model.PageOptimizationConfig build()
buildPartial()
public Model.PageOptimizationConfig buildPartial()
clear()
public Model.PageOptimizationConfig.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public Model.PageOptimizationConfig.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Model.PageOptimizationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearPageOptimizationEventType()
public Model.PageOptimizationConfig.Builder clearPageOptimizationEventType()
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];
clearPanels()
public Model.PageOptimizationConfig.Builder clearPanels()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
clearRestriction()
public Model.PageOptimizationConfig.Builder clearRestriction()
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];
clone()
public Model.PageOptimizationConfig.Builder clone()
Overrides
getDefaultInstanceForType()
public Model.PageOptimizationConfig getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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
|
getPanelsBuilder(int index)
public Model.PageOptimizationConfig.Panel.Builder getPanelsBuilder(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
|
getPanelsBuilderList()
public List<Model.PageOptimizationConfig.Panel.Builder> getPanelsBuilderList()
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
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 |
index | int
|
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> | |
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(Model.PageOptimizationConfig other)
public Model.PageOptimizationConfig.Builder mergeFrom(Model.PageOptimizationConfig other)
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Model.PageOptimizationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Model.PageOptimizationConfig.Builder mergeFrom(Message other)
Parameter |
---|
Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Model.PageOptimizationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
removePanels(int index)
public Model.PageOptimizationConfig.Builder removePanels(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
|
setField(Descriptors.FieldDescriptor field, Object value)
public Model.PageOptimizationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setPageOptimizationEventType(String value)
public Model.PageOptimizationConfig.Builder setPageOptimizationEventType(String value)
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];
Parameter |
---|
Name | Description |
value | String
The pageOptimizationEventType to set.
|
setPageOptimizationEventTypeBytes(ByteString value)
public Model.PageOptimizationConfig.Builder setPageOptimizationEventTypeBytes(ByteString value)
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];
Parameter |
---|
Name | Description |
value | ByteString
The bytes for pageOptimizationEventType to set.
|
setPanels(int index, Model.PageOptimizationConfig.Panel value)
public Model.PageOptimizationConfig.Builder setPanels(int index, Model.PageOptimizationConfig.Panel value)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
setPanels(int index, Model.PageOptimizationConfig.Panel.Builder builderForValue)
public Model.PageOptimizationConfig.Builder setPanels(int index, Model.PageOptimizationConfig.Panel.Builder builderForValue)
Required. A list of panel configurations.
Limit = 5.
repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Panel panels = 2 [(.google.api.field_behavior) = REQUIRED];
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Model.PageOptimizationConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setRestriction(Model.PageOptimizationConfig.Restriction value)
public Model.PageOptimizationConfig.Builder setRestriction(Model.PageOptimizationConfig.Restriction value)
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];
setRestrictionValue(int value)
public Model.PageOptimizationConfig.Builder setRestrictionValue(int value)
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];
Parameter |
---|
Name | Description |
value | int
The enum numeric value on the wire for restriction to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Model.PageOptimizationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides