Struct google_api_proto::google::cloud::retail::v2alpha::PurgeProductsRequest

pub struct PurgeProductsRequest {
    pub parent: String,
    pub filter: String,
    pub force: bool,
}

Request message for PurgeProducts method.

Fields

parent: String

Required. The resource name of the branch under which the products are created. The format is projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}

filter: String

Required. The filter string to specify the products to be deleted with a length limit of 5,000 characters.

Empty string filter is not allowed. “*” implies delete all items in a branch.

The eligible fields for filtering are:

• availability: Double quoted [Product.availability][google.cloud.retail.v2alpha.Product.availability] string.
• create_time : in ISO 8601 “zulu” format.

Supported syntax:

• Comparators (“>”, “<”, “>=”, “<=”, “=”). Examples:

  • create_time <= “2015-02-13T17:05:46Z”
  • availability = “IN_STOCK”

• Conjunctions (“AND”) Examples:

  • create_time <= “2015-02-13T17:05:46Z” AND availability = “PREORDER”

• Disjunctions (“OR”) Examples:

  • create_time <= “2015-02-13T17:05:46Z” OR availability = “IN_STOCK”

• Can support nested queries. Examples:

  • (create_time <= “2015-02-13T17:05:46Z” AND availability = “PREORDER”) OR (create_time >= “2015-02-14T13:03:32Z” AND availability = “IN_STOCK”)

• Filter Limits:

  • Filter should not contain more than 6 conditions.
  • Max nesting depth should not exceed 2 levels.

Examples queries:

• Delete back order products created before a timestamp. create_time <= “2015-02-13T17:05:46Z” OR availability = “BACKORDER”

force: bool

Actually perform the purge. If force is set to false, the method will return the expected purge count without deleting any products.

Trait Implementations

impl Clone for PurgeProductsRequest

fn clone(&self) -> PurgeProductsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeProductsRequest

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

Formats the value using the given formatter.

impl Default for PurgeProductsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for PurgeProductsRequest

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 PurgeProductsRequest

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