Struct google_api_proto::google::cloud::retail::v2beta::ListCatalogsRequest

pub struct ListCatalogsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
}

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] method.

Fields

parent: String

Required. The account resource name with an associated location.

If the caller does not have permission to list [Catalog][google.cloud.retail.v2beta.Catalog]s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

page_size: i32

Maximum number of [Catalog][google.cloud.retail.v2beta.Catalog]s to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.

page_token: String

A page token [ListCatalogsResponse.next_page_token][google.cloud.retail.v2beta.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2beta.CatalogService.ListCatalogs] call. Provide this to retrieve the subsequent page.

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

Trait Implementations

impl Clone for ListCatalogsRequest

fn clone(&self) -> ListCatalogsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListCatalogsRequest

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

Formats the value using the given formatter.

impl Default for ListCatalogsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListCatalogsRequest

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for ListCatalogsRequest

fn eq(&self, other: &ListCatalogsRequest) -> 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 ListCatalogsRequest