Class Model.PageOptimizationConfig.Builder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 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.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

Inheritance

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

Implements

Model.PageOptimizationConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

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>

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Parameter
Name	Description
value	Model.PageOptimizationConfig.Panel

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Parameter
Name	Description
builderForValue	Model.PageOptimizationConfig.Panel.Builder

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Parameters
Name	Description
index	int
value	Model.PageOptimizationConfig.Panel

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Parameters
Name	Description
index	int
builderForValue	Model.PageOptimizationConfig.Panel.Builder

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Returns
Type	Description
Model.PageOptimizationConfig.Panel.Builder

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

Returns
Type	Description
Model.PageOptimizationConfig.Panel.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Model.PageOptimizationConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Model.PageOptimizationConfig build()

Returns
Type	Description
Model.PageOptimizationConfig

buildPartial()

public Model.PageOptimizationConfig buildPartial()

Returns
Type	Description
Model.PageOptimizationConfig

clear()

public Model.PageOptimizationConfig.Builder clear()

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Model.PageOptimizationConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Model.PageOptimizationConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

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

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

clone()

public Model.PageOptimizationConfig.Builder clone()

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Model.PageOptimizationConfig getDefaultInstanceForType()

Returns
Type	Description
Model.PageOptimizationConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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

Returns
Type	Description
Model.PageOptimizationConfig.Panel.Builder

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

Returns
Type	Description
List<Builder>

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>

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Model.PageOptimizationConfig other)

public Model.PageOptimizationConfig.Builder mergeFrom(Model.PageOptimizationConfig other)

Parameter
Name	Description
other	Model.PageOptimizationConfig

Returns
Type	Description
Model.PageOptimizationConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Model.PageOptimizationConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Model.PageOptimizationConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Returns
Type	Description
Model.PageOptimizationConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Model.PageOptimizationConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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.

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

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.

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

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

Parameters
Name	Description
index	int
value	Model.PageOptimizationConfig.Panel

Returns
Type	Description
Model.PageOptimizationConfig.Builder

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

Parameters
Name	Description
index	int
builderForValue	Model.PageOptimizationConfig.Panel.Builder

Returns
Type	Description
Model.PageOptimizationConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Model.PageOptimizationConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameter
Name	Description
value	Model.PageOptimizationConfig.Restriction The restriction to set.

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

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.

Returns
Type	Description
Model.PageOptimizationConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Model.PageOptimizationConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)