Class: Google::Cloud::Retail::V2::ListProductsRequest

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

Overview

Request message for ProductService.ListProducts method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

Returns:



227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 227

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

#page_size ⇒ ::Integer

Returns Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

Returns:

  • (::Integer) —

    Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

    If this field is negative, an INVALID_ARGUMENT error is returned.



227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 227

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

#page_token ⇒ ::String

Returns A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:



227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 227

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

#parent ⇒ ::String

Returns Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Returns:

  • (::String) —

    Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

    If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.



227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 227

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

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns The fields of Product to return in the responses. If not set or empty, the following fields are returned:

If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

Returns:



227
228
229
230
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 227

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