#[non_exhaustive]pub struct ClusterInfo {Show 20 fields
pub active_operation_arn: Option<String>,
pub broker_node_group_info: Option<BrokerNodeGroupInfo>,
pub client_authentication: Option<ClientAuthentication>,
pub cluster_arn: Option<String>,
pub cluster_name: Option<String>,
pub creation_time: Option<DateTime>,
pub current_broker_software_info: Option<BrokerSoftwareInfo>,
pub current_version: Option<String>,
pub encryption_info: Option<EncryptionInfo>,
pub enhanced_monitoring: Option<EnhancedMonitoring>,
pub open_monitoring: Option<OpenMonitoring>,
pub logging_info: Option<LoggingInfo>,
pub number_of_broker_nodes: Option<i32>,
pub state: Option<ClusterState>,
pub state_info: Option<StateInfo>,
pub tags: Option<HashMap<String, String>>,
pub zookeeper_connect_string: Option<String>,
pub zookeeper_connect_string_tls: Option<String>,
pub storage_mode: Option<StorageMode>,
pub customer_action_status: Option<CustomerActionStatus>,
}
Expand description
Returns information about a cluster.
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.active_operation_arn: Option<String>
Arn of active cluster operation.
broker_node_group_info: Option<BrokerNodeGroupInfo>
Information about the broker nodes.
client_authentication: Option<ClientAuthentication>
Includes all client authentication information.
cluster_arn: Option<String>
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
cluster_name: Option<String>
The name of the cluster.
creation_time: Option<DateTime>
The time when the cluster was created.
current_broker_software_info: Option<BrokerSoftwareInfo>
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
current_version: Option<String>
The current version of the MSK cluster.
encryption_info: Option<EncryptionInfo>
Includes all encryption-related information.
enhanced_monitoring: Option<EnhancedMonitoring>
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
open_monitoring: Option<OpenMonitoring>
Settings for open monitoring using Prometheus.
logging_info: Option<LoggingInfo>
§number_of_broker_nodes: Option<i32>
The number of broker nodes in the cluster.
state: Option<ClusterState>
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
state_info: Option<StateInfo>
Tags attached to the cluster.
zookeeper_connect_string: Option<String>
The connection string to use to connect to the Apache ZooKeeper cluster.
zookeeper_connect_string_tls: Option<String>
The connection string to use to connect to zookeeper cluster on Tls port.
storage_mode: Option<StorageMode>
This controls storage mode for supported storage tiers.
customer_action_status: Option<CustomerActionStatus>
Determines if there is an action required from the customer.
Implementations§
Source§impl ClusterInfo
impl ClusterInfo
Sourcepub fn active_operation_arn(&self) -> Option<&str>
pub fn active_operation_arn(&self) -> Option<&str>
Arn of active cluster operation.
Sourcepub fn broker_node_group_info(&self) -> Option<&BrokerNodeGroupInfo>
pub fn broker_node_group_info(&self) -> Option<&BrokerNodeGroupInfo>
Information about the broker nodes.
Sourcepub fn client_authentication(&self) -> Option<&ClientAuthentication>
pub fn client_authentication(&self) -> Option<&ClientAuthentication>
Includes all client authentication information.
Sourcepub fn cluster_arn(&self) -> Option<&str>
pub fn cluster_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Sourcepub fn cluster_name(&self) -> Option<&str>
pub fn cluster_name(&self) -> Option<&str>
The name of the cluster.
Sourcepub fn creation_time(&self) -> Option<&DateTime>
pub fn creation_time(&self) -> Option<&DateTime>
The time when the cluster was created.
Sourcepub fn current_broker_software_info(&self) -> Option<&BrokerSoftwareInfo>
pub fn current_broker_software_info(&self) -> Option<&BrokerSoftwareInfo>
Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.
Sourcepub fn current_version(&self) -> Option<&str>
pub fn current_version(&self) -> Option<&str>
The current version of the MSK cluster.
Sourcepub fn encryption_info(&self) -> Option<&EncryptionInfo>
pub fn encryption_info(&self) -> Option<&EncryptionInfo>
Includes all encryption-related information.
Sourcepub fn enhanced_monitoring(&self) -> Option<&EnhancedMonitoring>
pub fn enhanced_monitoring(&self) -> Option<&EnhancedMonitoring>
Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
Sourcepub fn open_monitoring(&self) -> Option<&OpenMonitoring>
pub fn open_monitoring(&self) -> Option<&OpenMonitoring>
Settings for open monitoring using Prometheus.
pub fn logging_info(&self) -> Option<&LoggingInfo>
Sourcepub fn number_of_broker_nodes(&self) -> Option<i32>
pub fn number_of_broker_nodes(&self) -> Option<i32>
The number of broker nodes in the cluster.
Sourcepub fn state(&self) -> Option<&ClusterState>
pub fn state(&self) -> Option<&ClusterState>
The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
pub fn state_info(&self) -> Option<&StateInfo>
Tags attached to the cluster.
Sourcepub fn zookeeper_connect_string(&self) -> Option<&str>
pub fn zookeeper_connect_string(&self) -> Option<&str>
The connection string to use to connect to the Apache ZooKeeper cluster.
Sourcepub fn zookeeper_connect_string_tls(&self) -> Option<&str>
pub fn zookeeper_connect_string_tls(&self) -> Option<&str>
The connection string to use to connect to zookeeper cluster on Tls port.
Sourcepub fn storage_mode(&self) -> Option<&StorageMode>
pub fn storage_mode(&self) -> Option<&StorageMode>
This controls storage mode for supported storage tiers.
Sourcepub fn customer_action_status(&self) -> Option<&CustomerActionStatus>
pub fn customer_action_status(&self) -> Option<&CustomerActionStatus>
Determines if there is an action required from the customer.
Source§impl ClusterInfo
impl ClusterInfo
Sourcepub fn builder() -> ClusterInfoBuilder
pub fn builder() -> ClusterInfoBuilder
Creates a new builder-style object to manufacture ClusterInfo
.
Trait Implementations§
Source§impl Clone for ClusterInfo
impl Clone for ClusterInfo
Source§fn clone(&self) -> ClusterInfo
fn clone(&self) -> ClusterInfo
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterInfo
impl Debug for ClusterInfo
Source§impl PartialEq for ClusterInfo
impl PartialEq for ClusterInfo
impl StructuralPartialEq for ClusterInfo
Auto Trait Implementations§
impl Freeze for ClusterInfo
impl RefUnwindSafe for ClusterInfo
impl Send for ClusterInfo
impl Sync for ClusterInfo
impl Unpin for ClusterInfo
impl UnwindSafe for ClusterInfo
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);