public static final class Model.PageOptimizationConfig.Builder extends com.google.protobuf.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][google.cloud.retail.v2alpha.ServingConfig] to show on which panels in way that optimizes the visitors shopping journey.Protobuf type
google.cloud.retail.v2alpha.Model.PageOptimizationConfiggetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Model.PageOptimizationConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Model.PageOptimizationConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Model.PageOptimizationConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder mergeFrom(Model.PageOptimizationConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public Model.PageOptimizationConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.PageOptimizationConfig.Builder>IOExceptionpublic String getPageOptimizationEventType()
Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
getPageOptimizationEventType in interface Model.PageOptimizationConfigOrBuilderpublic com.google.protobuf.ByteString getPageOptimizationEventTypeBytes()
Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
getPageOptimizationEventTypeBytes in interface Model.PageOptimizationConfigOrBuilderpublic Model.PageOptimizationConfig.Builder setPageOptimizationEventType(String value)
Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
value - The pageOptimizationEventType to set.public Model.PageOptimizationConfig.Builder clearPageOptimizationEventType()
Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
public Model.PageOptimizationConfig.Builder setPageOptimizationEventTypeBytes(com.google.protobuf.ByteString value)
Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].
string page_optimization_event_type = 1 [(.google.api.field_behavior) = REQUIRED];
value - The bytes for pageOptimizationEventType to set.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];
getPanelsList in interface Model.PageOptimizationConfigOrBuilderpublic 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];
getPanelsCount in interface Model.PageOptimizationConfigOrBuilderpublic 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];
getPanels in interface Model.PageOptimizationConfigOrBuilderpublic 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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
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];
getPanelsOrBuilder in interface Model.PageOptimizationConfigOrBuilderpublic 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];
getPanelsOrBuilderList in interface Model.PageOptimizationConfigOrBuilderpublic 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];
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];
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];
public int getRestrictionValue()
Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.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 in interface Model.PageOptimizationConfigOrBuilderpublic Model.PageOptimizationConfig.Builder setRestrictionValue(int value)
Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.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];
value - The enum numeric value on the wire for restriction to set.public Model.PageOptimizationConfig.Restriction getRestriction()
Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.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];
getRestriction in interface Model.PageOptimizationConfigOrBuilderpublic Model.PageOptimizationConfig.Builder setRestriction(Model.PageOptimizationConfig.Restriction value)
Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.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];
value - The restriction to set.public Model.PageOptimizationConfig.Builder clearRestriction()
Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.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];
public final Model.PageOptimizationConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>public final Model.PageOptimizationConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Builder>Copyright © 2024 Google LLC. All rights reserved.