Struct google_api_proto::google::cloud::retail::v2beta::ListProductsRequest
source · pub struct ListProductsRequest {
pub parent: String,
pub page_size: i32,
pub page_token: String,
pub filter: String,
pub read_mask: Option<FieldMask>,
}
Expand description
Request message for [ProductService.ListProducts][google.cloud.retail.v2beta.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.v2beta.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.v2beta.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.v2beta.ListProductsResponse.next_page_token], received from a previous [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to [ProductService.ListProducts][google.cloud.retail.v2beta.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.v2beta.ListProductsRequest.filter] is unset.
- List
[Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
[Product][google.cloud.retail.v2beta.Product]s sharing the same
[Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
[Product][google.cloud.retail.v2beta.Product]. For example:
primary_product_id = "some_product_id"
- List [Product][google.cloud.retail.v2beta.Product]s bundled in a
[Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION]
[Product][google.cloud.retail.v2beta.Product].
For example:
collection_product_id = "some_product_id"
- List [Product][google.cloud.retail.v2beta.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.v2beta.Product.Type.PRIMARY] [Product][google.cloud.retail.v2beta.Product] or [Product.Type.COLLECTION][google.cloud.retail.v2beta.Product.Type.COLLECTION] [Product][google.cloud.retail.v2beta.Product] does not exist, a NOT_FOUND error is returned.
read_mask: Option<FieldMask>
The fields of [Product][google.cloud.retail.v2beta.Product] to return in the responses. If not set or empty, the following fields are returned:
- [Product.name][google.cloud.retail.v2beta.Product.name]
- [Product.id][google.cloud.retail.v2beta.Product.id]
- [Product.title][google.cloud.retail.v2beta.Product.title]
- [Product.uri][google.cloud.retail.v2beta.Product.uri]
- [Product.images][google.cloud.retail.v2beta.Product.images]
- [Product.price_info][google.cloud.retail.v2beta.Product.price_info]
- [Product.brands][google.cloud.retail.v2beta.Product.brands]
If “*” is provided, all fields are returned. [Product.name][google.cloud.retail.v2beta.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.
Trait Implementations§
source§impl Clone for ListProductsRequest
impl Clone for ListProductsRequest
source§fn clone(&self) -> ListProductsRequest
fn clone(&self) -> ListProductsRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListProductsRequest
impl Debug for ListProductsRequest
source§impl Default for ListProductsRequest
impl Default for ListProductsRequest
source§impl Message for ListProductsRequest
impl Message for ListProductsRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq for ListProductsRequest
impl PartialEq for ListProductsRequest
source§fn eq(&self, other: &ListProductsRequest) -> bool
fn eq(&self, other: &ListProductsRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListProductsRequest
Auto Trait Implementations§
impl Freeze for ListProductsRequest
impl RefUnwindSafe for ListProductsRequest
impl Send for ListProductsRequest
impl Sync for ListProductsRequest
impl Unpin for ListProductsRequest
impl UnwindSafe for ListProductsRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request