Struct DeleteObjectRequest

pub struct DeleteObjectRequest {
    pub store_id: String,
    pub key_value: Option<KeyValue>,
}

Request payload to be used for DeleteObject API call to server.

Fields

store_id: String

store_id is a keyspace identifier. Ref: https://en.wikipedia.org/wiki/Keyspace_(distributed_data_store) All APIs operate within a single store_id. It is up to clients to use single or multiple stores for their use-case. This can be used for client-isolation/ rate-limiting / throttling on the server-side. Authorization and billing can also be performed at the store_id level.

key_value: Option<KeyValue>

Item to be deleted as a result of this DeleteObjectRequest.

An item consists of a key and its corresponding version.

Key-level Versioning (Conditional Delete): The item is only deleted if the current database version against the key is the same as the version specified in the request.

Skipping key-level versioning (Non-conditional Delete): If you wish to skip key-level version checks, set the version against the key to ‘-1’. This will perform a non-conditional delete query.

This operation is idempotent, that is, multiple delete calls for the same item will not fail.

If the requested item does not exist, this operation will not fail. If you wish to perform stricter checks while deleting an item, consider using PutObject API.

Trait Implementations

impl Clone for DeleteObjectRequest

fn clone(&self) -> DeleteObjectRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteObjectRequest

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

Formats the value using the given formatter.

impl Default for DeleteObjectRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for DeleteObjectRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

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

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DeleteObjectRequest

fn eq(&self, other: &DeleteObjectRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DeleteObjectRequest