Enum google_api_proto::google::cloud::retail::v2alpha::product::Expiration

pub enum Expiration {
    ExpireTime(Timestamp),
    Ttl(Duration),
}

Variants

ExpireTime(Timestamp)

Note that this field is applied in the following ways:

• If the [Product][google.cloud.retail.v2alpha.Product] is already expired when it is uploaded, this product is not indexed for search.

• If the [Product][google.cloud.retail.v2alpha.Product] is not expired when it is uploaded, only the [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]’s and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION]’s expireTime is respected, and [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]’s expireTime is not used.

In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

[expire_time][google.cloud.retail.v2alpha.Product.expire_time] must be later than [available_time][google.cloud.retail.v2alpha.Product.available_time] and [publish_time][google.cloud.retail.v2alpha.Product.publish_time], otherwise an INVALID_ARGUMENT error is thrown.

Corresponding properties: Google Merchant Center property expiration_date.

Ttl(Duration)

Input only. The TTL (time to live) of the product. Note that this is only applicable to [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] and [Type.COLLECTION][google.cloud.retail.v2alpha.Product.Type.COLLECTION], and ignored for [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness.

If it is set, it must be a non-negative value, and [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is set as current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. The derived [expire_time][google.cloud.retail.v2alpha.Product.expire_time] is returned in the output and [ttl][google.cloud.retail.v2alpha.Product.ttl] is left blank when retrieving the [Product][google.cloud.retail.v2alpha.Product].

If it is set, the product is not available for [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search] after current timestamp plus [ttl][google.cloud.retail.v2alpha.Product.ttl]. However, the product can still be retrieved by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] and [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].

Implementations

impl Expiration

pub fn encode(&self, buf: &mut impl BufMut)

Encodes the message to a buffer.

pub fn merge( field: &mut Option<Expiration>, tag: u32, wire_type: WireType, buf: &mut impl Buf, ctx: DecodeContext, ) -> Result<(), DecodeError>

Decodes an instance of the message from a buffer, and merges it into self.

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

Trait Implementations

impl Clone for Expiration

fn clone(&self) -> Expiration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expiration

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

Formats the value using the given formatter.

impl PartialEq for Expiration

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

impl StructuralPartialEq for Expiration