Enum Model.ContextProductsType

java.lang.Object
java.lang.Enum<Model.ContextProductsType>
com.google.cloud.retail.v2alpha.Model.ContextProductsType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Model.ContextProductsType>
Enclosing class:
Model

public static enum Model.ContextProductsType extends Enum<Model.ContextProductsType> implements com.google.protobuf.ProtocolMessageEnum
 Use single or multiple context products for recommendations.
 
Protobuf enum google.cloud.retail.v2alpha.Model.ContextProductsType
  • Enum Constant Details

    • CONTEXT_PRODUCTS_TYPE_UNSPECIFIED

      public static final Model.ContextProductsType CONTEXT_PRODUCTS_TYPE_UNSPECIFIED
       Unspecified default value, should never be explicitly set.
       Defaults to
       [MULTIPLE_CONTEXT_PRODUCTS][google.cloud.retail.v2alpha.Model.ContextProductsType.MULTIPLE_CONTEXT_PRODUCTS].
       
      CONTEXT_PRODUCTS_TYPE_UNSPECIFIED = 0;
    • SINGLE_CONTEXT_PRODUCT

      public static final Model.ContextProductsType SINGLE_CONTEXT_PRODUCT
       Use only a single product as context for the recommendation. Typically
       used on pages like add-to-cart or product details.
       
      SINGLE_CONTEXT_PRODUCT = 1;
    • MULTIPLE_CONTEXT_PRODUCTS

      public static final Model.ContextProductsType MULTIPLE_CONTEXT_PRODUCTS
       Use one or multiple products as context for the recommendation. Typically
       used on shopping cart pages.
       
      MULTIPLE_CONTEXT_PRODUCTS = 2;
    • UNRECOGNIZED

      public static final Model.ContextProductsType UNRECOGNIZED
  • Field Details

    • CONTEXT_PRODUCTS_TYPE_UNSPECIFIED_VALUE

      public static final int CONTEXT_PRODUCTS_TYPE_UNSPECIFIED_VALUE
       Unspecified default value, should never be explicitly set.
       Defaults to
       [MULTIPLE_CONTEXT_PRODUCTS][google.cloud.retail.v2alpha.Model.ContextProductsType.MULTIPLE_CONTEXT_PRODUCTS].
       
      CONTEXT_PRODUCTS_TYPE_UNSPECIFIED = 0;
      See Also:
    • SINGLE_CONTEXT_PRODUCT_VALUE

      public static final int SINGLE_CONTEXT_PRODUCT_VALUE
       Use only a single product as context for the recommendation. Typically
       used on pages like add-to-cart or product details.
       
      SINGLE_CONTEXT_PRODUCT = 1;
      See Also:
    • MULTIPLE_CONTEXT_PRODUCTS_VALUE

      public static final int MULTIPLE_CONTEXT_PRODUCTS_VALUE
       Use one or multiple products as context for the recommendation. Typically
       used on shopping cart pages.
       
      MULTIPLE_CONTEXT_PRODUCTS = 2;
      See Also:
  • Method Details

    • values

      public static Model.ContextProductsType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Model.ContextProductsType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum
    • valueOf

      @Deprecated public static Model.ContextProductsType valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • forNumber

      public static Model.ContextProductsType forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.
    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Model.ContextProductsType> internalGetValueMap()
    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
    • valueOf

      public static Model.ContextProductsType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null