Class Restriction (1.23.0)

Restriction(value)

Restrictions of expected returned results.

    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`:

    -   (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)

    `Invalid combinations`: []
UNIQUE_SERVING_CONFIG_RESTRICTION (2):
    Do not allow the same
    <xref uid="google.cloud.retail.v2alpha.ServingConfig.name">ServingConfig.name</xref>
    to be shown on multiple panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION`

    `Valid combinations`:

    -   (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)

    `Invalid combinations`:

    -   (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
UNIQUE_MODEL_RESTRICTION (3):
    Do not allow multiple
    <xref uid="google.cloud.retail.v2alpha.ServingConfig">ServingConfigs</xref>
    with same
    <xref uid="google.cloud.retail.v2alpha.Model.name">Model.name</xref> to be
    show on on different panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_MODEL_RESTRICTION`

    `Valid combinations`:

    -   (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)

    `Invalid combinations`:

    -   (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
    -  (pdp_cvr, pdp_cvr_no_diversity)
UNIQUE_MODEL_TYPE_RESTRICTION (4):
    Do not allow multiple
    <xref uid="google.cloud.retail.v2alpha.ServingConfig">ServingConfigs</xref>
    with same
    <xref uid="google.cloud.retail.v2alpha.Model.type">Model.type</xref> to be
    shown on different panels.

    Example:

    `Panel1 candidates`: pdp_ctr, pdp_cvr,
    home_page_ctr_no_diversity

    `Panel2 candidates`: home_page_ctr_no_diversity,
    home_page_ctr_diversity_low, pdp_cvr_no_diversity

    `Restriction` = `UNIQUE_MODEL_RESTRICTION`

    `Valid combinations`:

    -   (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)

    `Invalid combinations`:

    -   (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)

Enums

Name Description
RESTRICTION_UNSPECIFIED Unspecified value for restriction.
NO_RESTRICTION Allow any ServingConfig to be show on any number of panels.