Struct google_api_proto::google::cloud::retail::v2::RemoveFulfillmentPlacesRequest

pub struct RemoveFulfillmentPlacesRequest {
    pub product: String,
    pub type: String,
    pub place_ids: Vec<String>,
    pub remove_time: Option<Timestamp>,
    pub allow_missing: bool,
}

Request message for [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces] method.

Fields

product: String

Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

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

type: String

Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types.

Supported values:

• “pickup-in-store”
• “ship-to-store”
• “same-day-delivery”
• “next-day-delivery”
• “custom-type-1”
• “custom-type-2”
• “custom-type-3”
• “custom-type-4”
• “custom-type-5”

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

This field directly corresponds to [Product.fulfillment_info.type][google.cloud.retail.v2.FulfillmentInfo.type].

place_ids: Vec<String>

Required. The IDs for this [type][google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type], such as the store IDs for “pickup-in-store” or the region IDs for “same-day-delivery”, to be removed for this [type][google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type].

At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern \[a-zA-Z0-9_-\]+, such as “store1” or “REGION-2”. Otherwise, an INVALID_ARGUMENT error is returned.

remove_time: Option<Timestamp>

The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.

allow_missing: bool

If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Trait Implementations

impl Clone for RemoveFulfillmentPlacesRequest

fn clone(&self) -> RemoveFulfillmentPlacesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RemoveFulfillmentPlacesRequest

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

Formats the value using the given formatter.

impl Default for RemoveFulfillmentPlacesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for RemoveFulfillmentPlacesRequest

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 RemoveFulfillmentPlacesRequest

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