Retail V2 API - Class Google::Cloud::Retail::V2::ListControlsRequest (v1.2.0)

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

Request for ListControls method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    Optional. A filter to apply on the list results. Supported features:

    • List all the products under the parent branch if filter is unset.
    • List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    Optional. A filter to apply on the list results. Supported features:

    • List all the products under the parent branch if filter is unset.
    • List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
Returns
  • (::String) —

    Optional. A filter to apply on the list results. Supported features:

    • List all the products under the parent branch if filter is unset.
    • List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Returns
  • (::Integer) — Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.
Returns
  • (::String) — Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Returns
  • (::String) — Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}