Struct google_api_proto::google::cloud::discoveryengine::v1alpha::PurgeDocumentsRequest

pub struct PurgeDocumentsRequest {
    pub parent: String,
    pub filter: String,
    pub error_config: Option<PurgeErrorConfig>,
    pub force: bool,
    pub source: Option<Source>,
}

Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.

Fields

parent: String

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

filter: String

Required. Filter matching documents to purge. Only currently supported value is * (all items).

error_config: Option<PurgeErrorConfig>

The desired location of errors incurred during the purge.

force: bool

Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

source: Option<Source>

The desired input source for the purging documents based on document IDs.

Trait Implementations

impl Clone for PurgeDocumentsRequest

fn clone(&self) -> PurgeDocumentsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeDocumentsRequest

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

Formats the value using the given formatter.

impl Default for PurgeDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for PurgeDocumentsRequest

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 PurgeDocumentsRequest

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