Struct google_api_proto::google::cloud::retail::v2alpha::ListProductsRequest

pub struct ListProductsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    pub read_mask: Option<FieldMask>,
    pub require_total_size: bool,
}

Request message for [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] method.

Fields

parent: 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 [Product][google.cloud.retail.v2alpha.Product]s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

page_size: i32

Maximum number of [Product][google.cloud.retail.v2alpha.Product]s 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.

page_token: String

A page token [ListProductsResponse.next_page_token][google.cloud.retail.v2alpha.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] call. Provide this to retrieve the subsequent page.

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

filter: String

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

• List all the products under the parent branch if [filter][google.cloud.retail.v2alpha.ListProductsRequest.filter] is unset.
• List [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product]s sharing the same [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product]. For example: primary_product_id = "some_product_id"
• List [Product][google.cloud.retail.v2alpha.Product]s bundled in a [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION] [Product][google.cloud.retail.v2alpha.Product]. For example: collection_product_id = "some_product_id"
• List [Product][google.cloud.retail.v2alpha.Product]s with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION"

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

If the specified [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] [Product][google.cloud.retail.v2alpha.Product] or [Product.Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION] [Product][google.cloud.retail.v2alpha.Product] does not exist, a NOT_FOUND error is returned.

read_mask: Option<FieldMask>

The fields of [Product][google.cloud.retail.v2alpha.Product] to return in the responses. If not set or empty, the following fields are returned:

• [Product.name][google.cloud.retail.v2alpha.Product.name]
• [Product.id][google.cloud.retail.v2alpha.Product.id]
• [Product.title][google.cloud.retail.v2alpha.Product.title]
• [Product.uri][google.cloud.retail.v2alpha.Product.uri]
• [Product.images][google.cloud.retail.v2alpha.Product.images]
• [Product.price_info][google.cloud.retail.v2alpha.Product.price_info]
• [Product.brands][google.cloud.retail.v2alpha.Product.brands]

If “*” is provided, all fields are returned. [Product.name][google.cloud.retail.v2alpha.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.

require_total_size: bool

If true and [page_token][google.cloud.retail.v2alpha.ListProductsRequest.page_token] is empty, [ListProductsResponse.total_size][google.cloud.retail.v2alpha.ListProductsResponse.total_size] is set to the total count of matched items irrespective of pagination.

Notice that setting this field to true affects the performance.

Trait Implementations

impl Clone for ListProductsRequest

fn clone(&self) -> ListProductsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListProductsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListProductsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListProductsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListProductsRequest

fn eq(&self, other: &ListProductsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListProductsRequest