Package com.google.cloud.retail.v2alpha

Enum Model.PageOptimizationConfig.Restriction

java.lang.Object

java.lang.Enum<Model.PageOptimizationConfig.Restriction>

com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Model.PageOptimizationConfig.Restriction>

Enclosing class:

Model.PageOptimizationConfig

public static enum Model.PageOptimizationConfig.Restriction
extends Enum<Model.PageOptimizationConfig.Restriction>
implements com.google.protobuf.ProtocolMessageEnum

 Restrictions of expected returned results.
 

Protobuf enum google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Restriction

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_RESTRICTION	Allow any [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] to be show on any number of panels.
RESTRICTION_UNSPECIFIED	Unspecified value for restriction.
UNIQUE_MODEL_RESTRICTION	Do not allow multiple [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same [Model.name][google.cloud.retail.v2alpha.Model.name] to be show on on different panels.
UNIQUE_MODEL_TYPE_RESTRICTION	Do not allow multiple [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same [Model.type][google.cloud.retail.v2alpha.Model.type] to be shown on different panels.
UNIQUE_SERVING_CONFIG_RESTRICTION	Do not allow the same [ServingConfig.name][google.cloud.retail.v2alpha.ServingConfig.name] to be shown on multiple panels.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	NO_RESTRICTION_VALUE	Allow any [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] to be show on any number of panels.
static int	RESTRICTION_UNSPECIFIED_VALUE	Unspecified value for restriction.
static int	UNIQUE_MODEL_RESTRICTION_VALUE	Do not allow multiple [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same [Model.name][google.cloud.retail.v2alpha.Model.name] to be show on on different panels.
static int	UNIQUE_MODEL_TYPE_RESTRICTION_VALUE	Do not allow multiple [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same [Model.type][google.cloud.retail.v2alpha.Model.type] to be shown on different panels.
static int	UNIQUE_SERVING_CONFIG_RESTRICTION_VALUE	Do not allow the same [ServingConfig.name][google.cloud.retail.v2alpha.ServingConfig.name] to be shown on multiple panels.

Method Summary

Modifier and Type	Method	Description
static Model.PageOptimizationConfig.Restriction	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<Model.PageOptimizationConfig.Restriction>	internalGetValueMap()
static Model.PageOptimizationConfig.Restriction	valueOf(int value)	Deprecated.
static Model.PageOptimizationConfig.Restriction	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static Model.PageOptimizationConfig.Restriction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Model.PageOptimizationConfig.Restriction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESTRICTION_UNSPECIFIED

public static final Model.PageOptimizationConfig.Restriction RESTRICTION_UNSPECIFIED

 Unspecified value for restriction.
 

RESTRICTION_UNSPECIFIED = 0;

NO_RESTRICTION

public static final Model.PageOptimizationConfig.Restriction NO_RESTRICTION

 Allow any [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] to
 be show on any number of panels.

 Example:

 `Panel1 candidates`: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity

 `Panel2 candidates`: home_page_ctr_no_diversity,
 home_page_ctr_diversity,
  pdp_cvr_no_diversity

 `Restriction` = NO_RESTRICTION

 `Valid combinations`:

   * <i> (pdp_ctr, home_page_ctr_no_diversity)
   * (pdp_ctr, home_page_ctr_diversity)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_cvr, home_page_ctr_no_diversity)
   * (pdp_cvr, home_page_ctr_diversity)
   * (pdp_cvr, pdp_cvr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_diversity)
   * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`: []
 

NO_RESTRICTION = 1;

UNIQUE_SERVING_CONFIG_RESTRICTION

public static final Model.PageOptimizationConfig.Restriction UNIQUE_SERVING_CONFIG_RESTRICTION

 Do not allow the same
 [ServingConfig.name][google.cloud.retail.v2alpha.ServingConfig.name] to
 be shown on multiple panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
    pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION`

 `Valid combinations`:

   * <i> (pdp_ctr, home_page_ctr_no_diversity)
   * (pdp_ctr, home_page_ctr_diversity_low)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_cvr, home_page_ctr_no_diversity)
   * (pdp_cvr, home_page_ctr_diversity_low)
   * (pdp_cvr, pdp_cvr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_diversity_low)
   * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  * <i> (home_page_ctr_no_diversity, home_page_ctr_no_diversity) </i>
 

UNIQUE_SERVING_CONFIG_RESTRICTION = 2;

UNIQUE_MODEL_RESTRICTION

public static final Model.PageOptimizationConfig.Restriction UNIQUE_MODEL_RESTRICTION

 Do not allow multiple
 [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same
 [Model.name][google.cloud.retail.v2alpha.Model.name] to be show on on
 different panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
  pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_MODEL_RESTRICTION`

 `Valid combinations`:

  * <i> (pdp_ctr, home_page_ctr_no_diversity)
  * (pdp_ctr, home_page_ctr_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_cvr, home_page_ctr_no_diversity)
  * (pdp_cvr, home_page_ctr_diversity_low)
  * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  *  <i> (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
  * (pdp_cvr, pdp_cvr_no_diversity) </i>
 

UNIQUE_MODEL_RESTRICTION = 3;

UNIQUE_MODEL_TYPE_RESTRICTION

public static final Model.PageOptimizationConfig.Restriction UNIQUE_MODEL_TYPE_RESTRICTION

 Do not allow multiple
 [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same
 [Model.type][google.cloud.retail.v2alpha.Model.type] to be shown on
 different panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
  pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_MODEL_RESTRICTION`

 `Valid combinations`:

 * <i> (pdp_ctr, home_page_ctr_no_diversity)
 * (pdp_ctr, home_page_ctr_diversity)
 * (pdp_cvr, home_page_ctr_no_diversity)
 *   (pdp_cvr, home_page_ctr_diversity_low)
 * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  *  <i> (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_cvr, pdp_cvr_no_diversity)
  * (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
  *  (home_page_ctr_no_diversity, home_page_ctr_diversity) </i>
 

UNIQUE_MODEL_TYPE_RESTRICTION = 4;

UNRECOGNIZED

public static final Model.PageOptimizationConfig.Restriction UNRECOGNIZED

Field Detail

RESTRICTION_UNSPECIFIED_VALUE

public static final int RESTRICTION_UNSPECIFIED_VALUE

 Unspecified value for restriction.
 

RESTRICTION_UNSPECIFIED = 0;

See Also:

Constant Field Values

NO_RESTRICTION_VALUE

public static final int NO_RESTRICTION_VALUE

 Allow any [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] to
 be show on any number of panels.

 Example:

 `Panel1 candidates`: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity

 `Panel2 candidates`: home_page_ctr_no_diversity,
 home_page_ctr_diversity,
  pdp_cvr_no_diversity

 `Restriction` = NO_RESTRICTION

 `Valid combinations`:

   * <i> (pdp_ctr, home_page_ctr_no_diversity)
   * (pdp_ctr, home_page_ctr_diversity)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_cvr, home_page_ctr_no_diversity)
   * (pdp_cvr, home_page_ctr_diversity)
   * (pdp_cvr, pdp_cvr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_diversity)
   * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`: []
 

NO_RESTRICTION = 1;

See Also:

Constant Field Values

UNIQUE_SERVING_CONFIG_RESTRICTION_VALUE

public static final int UNIQUE_SERVING_CONFIG_RESTRICTION_VALUE

 Do not allow the same
 [ServingConfig.name][google.cloud.retail.v2alpha.ServingConfig.name] to
 be shown on multiple panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
    pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION`

 `Valid combinations`:

   * <i> (pdp_ctr, home_page_ctr_no_diversity)
   * (pdp_ctr, home_page_ctr_diversity_low)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_ctr, pdp_cvr_no_diversity)
   * (pdp_cvr, home_page_ctr_no_diversity)
   * (pdp_cvr, home_page_ctr_diversity_low)
   * (pdp_cvr, pdp_cvr_no_diversity)
   * (home_page_ctr_no_diversity, home_page_ctr_diversity_low)
   * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  * <i> (home_page_ctr_no_diversity, home_page_ctr_no_diversity) </i>
 

UNIQUE_SERVING_CONFIG_RESTRICTION = 2;

See Also:

Constant Field Values

UNIQUE_MODEL_RESTRICTION_VALUE

public static final int UNIQUE_MODEL_RESTRICTION_VALUE

 Do not allow multiple
 [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same
 [Model.name][google.cloud.retail.v2alpha.Model.name] to be show on on
 different panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
  pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_MODEL_RESTRICTION`

 `Valid combinations`:

  * <i> (pdp_ctr, home_page_ctr_no_diversity)
  * (pdp_ctr, home_page_ctr_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_cvr, home_page_ctr_no_diversity)
  * (pdp_cvr, home_page_ctr_diversity_low)
  * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  *  <i> (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
  * (pdp_cvr, pdp_cvr_no_diversity) </i>
 

UNIQUE_MODEL_RESTRICTION = 3;

See Also:

Constant Field Values

UNIQUE_MODEL_TYPE_RESTRICTION_VALUE

public static final int UNIQUE_MODEL_TYPE_RESTRICTION_VALUE

 Do not allow multiple
 [ServingConfigs][google.cloud.retail.v2alpha.ServingConfig] with same
 [Model.type][google.cloud.retail.v2alpha.Model.type] to be shown on
 different panels.

 Example:

 `Panel1 candidates`: <i> pdp_ctr, pdp_cvr, home_page_ctr_no_diversity
 </i>

 `Panel2 candidates`: <i> home_page_ctr_no_diversity,
 home_page_ctr_diversity_low,
  pdp_cvr_no_diversity </i>

 `Restriction` = `UNIQUE_MODEL_RESTRICTION`

 `Valid combinations`:

 * <i> (pdp_ctr, home_page_ctr_no_diversity)
 * (pdp_ctr, home_page_ctr_diversity)
 * (pdp_cvr, home_page_ctr_no_diversity)
 *   (pdp_cvr, home_page_ctr_diversity_low)
 * (home_page_ctr_no_diversity, pdp_cvr_no_diversity) </i>

 `Invalid combinations`:

  *  <i> (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_ctr, pdp_cvr_no_diversity)
  * (pdp_cvr, pdp_cvr_no_diversity)
  * (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
  *  (home_page_ctr_no_diversity, home_page_ctr_diversity) </i>
 

UNIQUE_MODEL_TYPE_RESTRICTION = 4;

See Also:

Constant Field Values

Method Detail

values

public static Model.PageOptimizationConfig.Restriction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Model.PageOptimizationConfig.Restriction c : Model.PageOptimizationConfig.Restriction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Model.PageOptimizationConfig.Restriction 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.PageOptimizationConfig.Restriction 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.PageOptimizationConfig.Restriction 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.PageOptimizationConfig.Restriction> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Model.PageOptimizationConfig.Restriction 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