Struct google_api_proto::google::cloud::retail::v2alpha::SetDefaultBranchRequest

pub struct SetDefaultBranchRequest {
    pub catalog: String,
    pub branch_id: String,
    pub note: String,
    pub force: bool,
}

Request message to set a specified branch as new default_branch.

Fields

catalog: String

Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

branch_id: String

The final component of the resource name of a branch.

This field must be one of “0”, “1” or “2”. Otherwise, an INVALID_ARGUMENT error is returned.

If there are no sufficient active products in the targeted branch and [force][google.cloud.retail.v2alpha.SetDefaultBranchRequest.force] is not set, a FAILED_PRECONDITION error is returned.

note: String

Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch] before next valid default branch set occurs.

This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

force: bool

If set to true, it permits switching to a branch with [branch_id][google.cloud.retail.v2alpha.SetDefaultBranchRequest.branch_id] even if it has no sufficient active products.

Trait Implementations

impl Clone for SetDefaultBranchRequest

fn clone(&self) -> SetDefaultBranchRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetDefaultBranchRequest

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

Formats the value using the given formatter.

impl Default for SetDefaultBranchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SetDefaultBranchRequest

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 SetDefaultBranchRequest

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