Package com.google.cloud.retail.v2alpha

Class Model.PageOptimizationConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig
All Implemented Interfaces:
Model.PageOptimizationConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Model
public static final class Model.PageOptimizationConfig extends com.google.protobuf.GeneratedMessage 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.PageOptimizationConfig
See Also:

  • Field Details

    • PAGE_OPTIMIZATION_EVENT_TYPE_FIELD_NUMBER

      public static final int PAGE_OPTIMIZATION_EVENT_TYPE_FIELD_NUMBER
      See Also:

    • PANELS_FIELD_NUMBER

      public static final int PANELS_FIELD_NUMBER
      See Also:

    • RESTRICTION_FIELD_NUMBER

      public static final int RESTRICTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPageOptimizationEventType

      public 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];
      Specified by:
      getPageOptimizationEventType in interface Model.PageOptimizationConfigOrBuilder
      Returns:
      The pageOptimizationEventType.

    • getPageOptimizationEventTypeBytes

      public 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];
      Specified by:
      getPageOptimizationEventTypeBytes in interface Model.PageOptimizationConfigOrBuilder
      Returns:
      The bytes for pageOptimizationEventType.

    • 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];
      Specified by:
      getPanelsList in interface Model.PageOptimizationConfigOrBuilder

    • 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];
      Specified by:
      getPanelsOrBuilderList in interface Model.PageOptimizationConfigOrBuilder

    • 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];
      Specified by:
      getPanelsCount in interface Model.PageOptimizationConfigOrBuilder

    • getPanels

      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];
      Specified by:
      getPanels in interface Model.PageOptimizationConfigOrBuilder

    • getPanelsOrBuilder

      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];
      Specified by:
      getPanelsOrBuilder in interface Model.PageOptimizationConfigOrBuilder

    • getRestrictionValue

      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];
      Specified by:
      getRestrictionValue in interface Model.PageOptimizationConfigOrBuilder
      Returns:
      The enum numeric value on the wire for restriction.

    • getRestriction

      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];
      Specified by:
      getRestriction in interface Model.PageOptimizationConfigOrBuilder
      Returns:
      The restriction.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Model.PageOptimizationConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Model.PageOptimizationConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Model.PageOptimizationConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Model.PageOptimizationConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Model.PageOptimizationConfig.Builder newBuilder()

    • newBuilder

      public static Model.PageOptimizationConfig.Builder newBuilder(Model.PageOptimizationConfig prototype)

    • toBuilder

      public Model.PageOptimizationConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Model.PageOptimizationConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Model.PageOptimizationConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Model.PageOptimizationConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Model.PageOptimizationConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Model.PageOptimizationConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder