#[non_exhaustive]pub struct KnowledgeBaseDocumentDetailBuilder { /* private fields */ }
Expand description
A builder for KnowledgeBaseDocumentDetail
.
Implementations§
Source§impl KnowledgeBaseDocumentDetailBuilder
impl KnowledgeBaseDocumentDetailBuilder
Sourcepub fn knowledge_base_id(self, input: impl Into<String>) -> Self
pub fn knowledge_base_id(self, input: impl Into<String>) -> Self
The identifier of the knowledge base that the document was ingested into or deleted from.
This field is required.Sourcepub fn set_knowledge_base_id(self, input: Option<String>) -> Self
pub fn set_knowledge_base_id(self, input: Option<String>) -> Self
The identifier of the knowledge base that the document was ingested into or deleted from.
Sourcepub fn get_knowledge_base_id(&self) -> &Option<String>
pub fn get_knowledge_base_id(&self) -> &Option<String>
The identifier of the knowledge base that the document was ingested into or deleted from.
Sourcepub fn data_source_id(self, input: impl Into<String>) -> Self
pub fn data_source_id(self, input: impl Into<String>) -> Self
The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
This field is required.Sourcepub fn set_data_source_id(self, input: Option<String>) -> Self
pub fn set_data_source_id(self, input: Option<String>) -> Self
The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
Sourcepub fn get_data_source_id(&self) -> &Option<String>
pub fn get_data_source_id(&self) -> &Option<String>
The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
Sourcepub fn status(self, input: DocumentStatus) -> Self
pub fn status(self, input: DocumentStatus) -> Self
The ingestion status of the document. The following statuses are possible:
-
STARTED – You submitted the ingestion job containing the document.
-
PENDING – The document is waiting to be ingested.
-
IN_PROGRESS – The document is being ingested.
-
INDEXED – The document was successfully indexed.
-
PARTIALLY_INDEXED – The document was partially indexed.
-
METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
-
METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
-
FAILED – The document failed to be ingested.
-
NOT_FOUND – The document wasn't found.
-
IGNORED – The document was ignored during ingestion.
-
DELETING – You submitted the delete job containing the document.
-
DELETE_IN_PROGRESS – The document is being deleted.
Sourcepub fn set_status(self, input: Option<DocumentStatus>) -> Self
pub fn set_status(self, input: Option<DocumentStatus>) -> Self
The ingestion status of the document. The following statuses are possible:
-
STARTED – You submitted the ingestion job containing the document.
-
PENDING – The document is waiting to be ingested.
-
IN_PROGRESS – The document is being ingested.
-
INDEXED – The document was successfully indexed.
-
PARTIALLY_INDEXED – The document was partially indexed.
-
METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
-
METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
-
FAILED – The document failed to be ingested.
-
NOT_FOUND – The document wasn't found.
-
IGNORED – The document was ignored during ingestion.
-
DELETING – You submitted the delete job containing the document.
-
DELETE_IN_PROGRESS – The document is being deleted.
Sourcepub fn get_status(&self) -> &Option<DocumentStatus>
pub fn get_status(&self) -> &Option<DocumentStatus>
The ingestion status of the document. The following statuses are possible:
-
STARTED – You submitted the ingestion job containing the document.
-
PENDING – The document is waiting to be ingested.
-
IN_PROGRESS – The document is being ingested.
-
INDEXED – The document was successfully indexed.
-
PARTIALLY_INDEXED – The document was partially indexed.
-
METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
-
METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
-
FAILED – The document failed to be ingested.
-
NOT_FOUND – The document wasn't found.
-
IGNORED – The document was ignored during ingestion.
-
DELETING – You submitted the delete job containing the document.
-
DELETE_IN_PROGRESS – The document is being deleted.
Sourcepub fn identifier(self, input: DocumentIdentifier) -> Self
pub fn identifier(self, input: DocumentIdentifier) -> Self
Contains information that identifies the document.
This field is required.Sourcepub fn set_identifier(self, input: Option<DocumentIdentifier>) -> Self
pub fn set_identifier(self, input: Option<DocumentIdentifier>) -> Self
Contains information that identifies the document.
Sourcepub fn get_identifier(&self) -> &Option<DocumentIdentifier>
pub fn get_identifier(&self) -> &Option<DocumentIdentifier>
Contains information that identifies the document.
Sourcepub fn status_reason(self, input: impl Into<String>) -> Self
pub fn status_reason(self, input: impl Into<String>) -> Self
The reason for the status. Appears alongside the status IGNORED
.
Sourcepub fn set_status_reason(self, input: Option<String>) -> Self
pub fn set_status_reason(self, input: Option<String>) -> Self
The reason for the status. Appears alongside the status IGNORED
.
Sourcepub fn get_status_reason(&self) -> &Option<String>
pub fn get_status_reason(&self) -> &Option<String>
The reason for the status. Appears alongside the status IGNORED
.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The date and time at which the document was last updated.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The date and time at which the document was last updated.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The date and time at which the document was last updated.
Sourcepub fn build(self) -> Result<KnowledgeBaseDocumentDetail, BuildError>
pub fn build(self) -> Result<KnowledgeBaseDocumentDetail, BuildError>
Consumes the builder and constructs a KnowledgeBaseDocumentDetail
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for KnowledgeBaseDocumentDetailBuilder
impl Clone for KnowledgeBaseDocumentDetailBuilder
Source§fn clone(&self) -> KnowledgeBaseDocumentDetailBuilder
fn clone(&self) -> KnowledgeBaseDocumentDetailBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for KnowledgeBaseDocumentDetailBuilder
impl Default for KnowledgeBaseDocumentDetailBuilder
Source§fn default() -> KnowledgeBaseDocumentDetailBuilder
fn default() -> KnowledgeBaseDocumentDetailBuilder
Source§impl PartialEq for KnowledgeBaseDocumentDetailBuilder
impl PartialEq for KnowledgeBaseDocumentDetailBuilder
Source§fn eq(&self, other: &KnowledgeBaseDocumentDetailBuilder) -> bool
fn eq(&self, other: &KnowledgeBaseDocumentDetailBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for KnowledgeBaseDocumentDetailBuilder
Auto Trait Implementations§
impl Freeze for KnowledgeBaseDocumentDetailBuilder
impl RefUnwindSafe for KnowledgeBaseDocumentDetailBuilder
impl Send for KnowledgeBaseDocumentDetailBuilder
impl Sync for KnowledgeBaseDocumentDetailBuilder
impl Unpin for KnowledgeBaseDocumentDetailBuilder
impl UnwindSafe for KnowledgeBaseDocumentDetailBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);