Struct gapi_grpc::google::cloud::retail::v2alpha::ListCatalogsRequest

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

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.ListCatalogsResponse.next_page_token], received from a previous [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.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.

pub 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() -> ListCatalogsRequest

Returns the “default value” for a type.

impl Message for ListCatalogsRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<ListCatalogsRequest> 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: &ListCatalogsRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for ListCatalogsRequest