Class: Google::Cloud::Retail::V2::ListControlsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/control_service.rb

Overview

Request for ListControls method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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"'


103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/control_service.rb', line 103

class ListControlsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/control_service.rb', line 103

class ListControlsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/control_service.rb', line 103

class ListControlsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}



103
104
105
106
 
# File 'proto_docs/google/cloud/retail/v2/control_service.rb', line 103

class ListControlsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end