Retail V2 API - Class Google::Cloud::Retail::V2::Control (v0.16.1)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Control.

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#associated_serving_config_ids

def associated_serving_config_ids() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. List of serving config ids that are associated with this control in the same Catalog.

    Note the association is managed via the ServingConfig, this is an output only denormalized view.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human readable control display name. Used in Retail UI.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human readable control display name. Used in Retail UI.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

Returns
  • (::String) — Required. The human readable control display name. Used in Retail UI.

    This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

#name

def name() -> ::String
Returns
  • (::String) — Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
Returns
  • (::String) — Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

#rule

def rule() -> ::Google::Cloud::Retail::V2::Rule
Returns
  • (::Google::Cloud::Retail::V2::Rule) — A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

#rule=

def rule=(value) -> ::Google::Cloud::Retail::V2::Rule
Parameter
  • value (::Google::Cloud::Retail::V2::Rule) — A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
Returns
  • (::Google::Cloud::Retail::V2::Rule) — A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

#search_solution_use_case

def search_solution_use_case() -> ::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>
Returns

#search_solution_use_case=

def search_solution_use_case=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>
Parameter
Returns

#solution_types

def solution_types() -> ::Array<::Google::Cloud::Retail::V2::SolutionType>
Returns
  • (::Array<::Google::Cloud::Retail::V2::SolutionType>) — Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time.

    Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

#solution_types=

def solution_types=(value) -> ::Array<::Google::Cloud::Retail::V2::SolutionType>
Parameter
  • value (::Array<::Google::Cloud::Retail::V2::SolutionType>) — Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time.

    Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

Returns
  • (::Array<::Google::Cloud::Retail::V2::SolutionType>) — Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time.

    Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.