#[non_exhaustive]pub struct GetPropertyValueInput {
pub component_name: Option<String>,
pub component_path: Option<String>,
pub component_type_id: Option<String>,
pub entity_id: Option<String>,
pub selected_properties: Option<Vec<String>>,
pub workspace_id: Option<String>,
pub max_results: Option<i32>,
pub next_token: Option<String>,
pub property_group_name: Option<String>,
pub tabular_conditions: Option<TabularConditions>,
}
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.component_name: Option<String>
The name of the component whose property values the operation returns.
component_path: Option<String>
This string specifies the path to the composite component, starting from the top-level component.
component_type_id: Option<String>
The ID of the component type whose property values the operation returns.
entity_id: Option<String>
The ID of the entity whose property values the operation returns.
selected_properties: Option<Vec<String>>
The properties whose values the operation returns.
workspace_id: Option<String>
The ID of the workspace whose values the operation returns.
max_results: Option<i32>
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
next_token: Option<String>
The string that specifies the next page of results.
property_group_name: Option<String>
The property group name.
tabular_conditions: Option<TabularConditions>
The tabular conditions.
Implementations§
Source§impl GetPropertyValueInput
impl GetPropertyValueInput
Sourcepub fn component_name(&self) -> Option<&str>
pub fn component_name(&self) -> Option<&str>
The name of the component whose property values the operation returns.
Sourcepub fn component_path(&self) -> Option<&str>
pub fn component_path(&self) -> Option<&str>
This string specifies the path to the composite component, starting from the top-level component.
Sourcepub fn component_type_id(&self) -> Option<&str>
pub fn component_type_id(&self) -> Option<&str>
The ID of the component type whose property values the operation returns.
Sourcepub fn entity_id(&self) -> Option<&str>
pub fn entity_id(&self) -> Option<&str>
The ID of the entity whose property values the operation returns.
Sourcepub fn selected_properties(&self) -> &[String]
pub fn selected_properties(&self) -> &[String]
The properties whose values the operation returns.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .selected_properties.is_none()
.
Sourcepub fn workspace_id(&self) -> Option<&str>
pub fn workspace_id(&self) -> Option<&str>
The ID of the workspace whose values the operation returns.
Sourcepub fn max_results(&self) -> Option<i32>
pub fn max_results(&self) -> Option<i32>
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
Sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
The string that specifies the next page of results.
Sourcepub fn property_group_name(&self) -> Option<&str>
pub fn property_group_name(&self) -> Option<&str>
The property group name.
Sourcepub fn tabular_conditions(&self) -> Option<&TabularConditions>
pub fn tabular_conditions(&self) -> Option<&TabularConditions>
The tabular conditions.
Source§impl GetPropertyValueInput
impl GetPropertyValueInput
Sourcepub fn builder() -> GetPropertyValueInputBuilder
pub fn builder() -> GetPropertyValueInputBuilder
Creates a new builder-style object to manufacture GetPropertyValueInput
.
Trait Implementations§
Source§impl Clone for GetPropertyValueInput
impl Clone for GetPropertyValueInput
Source§fn clone(&self) -> GetPropertyValueInput
fn clone(&self) -> GetPropertyValueInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetPropertyValueInput
impl Debug for GetPropertyValueInput
Source§impl PartialEq for GetPropertyValueInput
impl PartialEq for GetPropertyValueInput
impl StructuralPartialEq for GetPropertyValueInput
Auto Trait Implementations§
impl Freeze for GetPropertyValueInput
impl RefUnwindSafe for GetPropertyValueInput
impl Send for GetPropertyValueInput
impl Sync for GetPropertyValueInput
impl Unpin for GetPropertyValueInput
impl UnwindSafe for GetPropertyValueInput
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);