Struct google_api_proto::google::cloud::retail::v2beta::UpdateProductRequest

pub struct UpdateProductRequest {
    pub product: Option<Product>,
    pub update_mask: Option<FieldMask>,
    pub allow_missing: bool,
}

Request message for [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] method.

Fields

product: Option<Product>

Required. The product to update/create.

If the caller does not have permission to update the [Product][google.cloud.retail.v2beta.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [Product][google.cloud.retail.v2beta.Product] to update does not exist and [allow_missing][google.cloud.retail.v2beta.UpdateProductRequest.allow_missing] is not set, a NOT_FOUND error is returned.

update_mask: Option<FieldMask>

Indicates which fields in the provided [Product][google.cloud.retail.v2beta.Product] to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

The attribute key can be updated by setting the mask path as “attributes.${key_name}”. If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

allow_missing: bool

If set to true, and the [Product][google.cloud.retail.v2beta.Product] is not found, a new [Product][google.cloud.retail.v2beta.Product] will be created. In this situation, update_mask is ignored.

Trait Implementations

impl Clone for UpdateProductRequest

fn clone(&self) -> UpdateProductRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateProductRequest

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

Formats the value using the given formatter.

impl Default for UpdateProductRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for UpdateProductRequest

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 UpdateProductRequest

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