#[non_exhaustive]pub struct DomainStatus {Show 13 fields
pub domain_id: String,
pub domain_name: String,
pub arn: Option<String>,
pub created: Option<bool>,
pub deleted: Option<bool>,
pub doc_service: Option<ServiceEndpoint>,
pub search_service: Option<ServiceEndpoint>,
pub requires_index_documents: bool,
pub processing: Option<bool>,
pub search_instance_type: Option<String>,
pub search_partition_count: Option<i32>,
pub search_instance_count: Option<i32>,
pub limits: Option<Limits>,
}
Expand description
The current status of the search domain.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.domain_id: String
An internally generated unique identifier for a domain.
domain_name: String
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
arn: Option<String>
The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
created: Option<bool>
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain
is called. Newly created search domains are returned from DescribeDomains
with a false value for Created until domain creation is complete.
deleted: Option<bool>
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain
is called. Newly deleted search domains are returned from DescribeDomains
with a true value for IsDeleted for several minutes until resource cleanup is complete.
doc_service: Option<ServiceEndpoint>
The service endpoint for updating documents in a search domain.
search_service: Option<ServiceEndpoint>
The service endpoint for requesting search results from a search domain.
requires_index_documents: bool
True if IndexDocuments
needs to be called to activate the current domain configuration.
processing: Option<bool>
True if processing is being done to activate the current domain configuration.
search_instance_type: Option<String>
The instance type that is being used to process search requests.
search_partition_count: Option<i32>
The number of partitions across which the search index is spread.
search_instance_count: Option<i32>
The number of search instances that are available to process search requests.
limits: Option<Limits>
Implementations§
Source§impl DomainStatus
impl DomainStatus
Sourcepub fn domain_name(&self) -> &str
pub fn domain_name(&self) -> &str
A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
Sourcepub fn created(&self) -> Option<bool>
pub fn created(&self) -> Option<bool>
True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain
is called. Newly created search domains are returned from DescribeDomains
with a false value for Created until domain creation is complete.
Sourcepub fn deleted(&self) -> Option<bool>
pub fn deleted(&self) -> Option<bool>
True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain
is called. Newly deleted search domains are returned from DescribeDomains
with a true value for IsDeleted for several minutes until resource cleanup is complete.
Sourcepub fn doc_service(&self) -> Option<&ServiceEndpoint>
pub fn doc_service(&self) -> Option<&ServiceEndpoint>
The service endpoint for updating documents in a search domain.
Sourcepub fn search_service(&self) -> Option<&ServiceEndpoint>
pub fn search_service(&self) -> Option<&ServiceEndpoint>
The service endpoint for requesting search results from a search domain.
Sourcepub fn requires_index_documents(&self) -> bool
pub fn requires_index_documents(&self) -> bool
True if IndexDocuments
needs to be called to activate the current domain configuration.
Sourcepub fn processing(&self) -> Option<bool>
pub fn processing(&self) -> Option<bool>
True if processing is being done to activate the current domain configuration.
Sourcepub fn search_instance_type(&self) -> Option<&str>
pub fn search_instance_type(&self) -> Option<&str>
The instance type that is being used to process search requests.
Sourcepub fn search_partition_count(&self) -> Option<i32>
pub fn search_partition_count(&self) -> Option<i32>
The number of partitions across which the search index is spread.
Sourcepub fn search_instance_count(&self) -> Option<i32>
pub fn search_instance_count(&self) -> Option<i32>
The number of search instances that are available to process search requests.
pub fn limits(&self) -> Option<&Limits>
Source§impl DomainStatus
impl DomainStatus
Sourcepub fn builder() -> DomainStatusBuilder
pub fn builder() -> DomainStatusBuilder
Creates a new builder-style object to manufacture DomainStatus
.
Trait Implementations§
Source§impl Clone for DomainStatus
impl Clone for DomainStatus
Source§fn clone(&self) -> DomainStatus
fn clone(&self) -> DomainStatus
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DomainStatus
impl Debug for DomainStatus
Source§impl PartialEq for DomainStatus
impl PartialEq for DomainStatus
impl StructuralPartialEq for DomainStatus
Auto Trait Implementations§
impl Freeze for DomainStatus
impl RefUnwindSafe for DomainStatus
impl Send for DomainStatus
impl Sync for DomainStatus
impl Unpin for DomainStatus
impl UnwindSafe for DomainStatus
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);