Struct google_api_proto::google::cloud::retail::v2alpha::GetBranchRequest

pub struct GetBranchRequest {
    pub name: String,
    pub view: i32,
}

Request for [BranchService.GetBranch][google.cloud.retail.v2alpha.BranchService.GetBranch] method.

Fields

name: String

Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id.

“default_branch” can be used as a special branch_id, it returns the default branch that has been set for the catalog.

view: i32

The view to apply to the returned [Branch][google.cloud.retail.v2alpha.Branch]. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of [Branch][google.cloud.retail.v2alpha.Branch] to find what fields are excluded from BASIC view.

Implementations

impl GetBranchRequest

pub fn view(&self) -> BranchView

Returns the enum value of view, or the default if the field is set to an invalid enum value.

pub fn set_view(&mut self, value: BranchView)

Sets view to the provided enum value.

Trait Implementations

impl Clone for GetBranchRequest

fn clone(&self) -> GetBranchRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetBranchRequest

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

Formats the value using the given formatter.

impl Default for GetBranchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetBranchRequest

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 GetBranchRequest

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