Struct PurgeDocumentsRequest 

#[non_exhaustive]
pub struct PurgeDocumentsRequest {
    pub parent: String,
    pub filter: String,
    pub error_config: Option<PurgeErrorConfig>,
    pub force: bool,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate feature document-service only.

Request message for DocumentService.PurgeDocuments method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

Implementations

impl PurgeDocumentsRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = PurgeDocumentsRequest::new().set_parent("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = PurgeDocumentsRequest::new().set_filter("example");

pub fn set_error_config<T>(self, v: T) -> Self

where T: Into<PurgeErrorConfig>,

Sets the value of error_config.

Example

use google_cloud_discoveryengine_v1::model::PurgeErrorConfig;
let x = PurgeDocumentsRequest::new().set_error_config(PurgeErrorConfig::default()/* use setters */);

pub fn set_or_clear_error_config<T>(self, v: Option<T>) -> Self

where T: Into<PurgeErrorConfig>,

Sets or clears the value of error_config.

Example

use google_cloud_discoveryengine_v1::model::PurgeErrorConfig;
let x = PurgeDocumentsRequest::new().set_or_clear_error_config(Some(PurgeErrorConfig::default()/* use setters */));
let x = PurgeDocumentsRequest::new().set_or_clear_error_config(None::<PurgeErrorConfig>);

pub fn set_force<T: Into<bool>>(self, v: T) -> Self

Sets the value of force.

Example

let x = PurgeDocumentsRequest::new().set_force(true);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::GcsSource;
let x = PurgeDocumentsRequest::new().set_source(Some(
    google_cloud_discoveryengine_v1::model::purge_documents_request::Source::GcsSource(GcsSource::default().into())));

pub fn gcs_source(&self) -> Option<&Box<GcsSource>>

The value of source if it holds a GcsSource, None if the field is not set or holds a different branch.

pub fn set_gcs_source<T: Into<Box<GcsSource>>>(self, v: T) -> Self

Sets the value of source to hold a GcsSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::GcsSource;
let x = PurgeDocumentsRequest::new().set_gcs_source(GcsSource::default()/* use setters */);
assert!(x.gcs_source().is_some());
assert!(x.inline_source().is_none());

pub fn inline_source(&self) -> Option<&Box<InlineSource>>

The value of source if it holds a InlineSource, None if the field is not set or holds a different branch.

pub fn set_inline_source<T: Into<Box<InlineSource>>>(self, v: T) -> Self

Sets the value of source to hold a InlineSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::purge_documents_request::InlineSource;
let x = PurgeDocumentsRequest::new().set_inline_source(InlineSource::default()/* use setters */);
assert!(x.inline_source().is_some());
assert!(x.gcs_source().is_none());

Trait Implementations

impl Clone for PurgeDocumentsRequest

fn clone(&self) -> PurgeDocumentsRequest

Returns a duplicate 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() -> PurgeDocumentsRequest

Returns the “default value” for a type.

impl Message for PurgeDocumentsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PurgeDocumentsRequest

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