#[non_exhaustive]pub struct ServiceBuilder { /* private fields */ }
Expand description
A builder for Service
.
Implementations§
Source§impl ServiceBuilder
impl ServiceBuilder
Sourcepub fn key_attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn key_attributes(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to key_attributes
.
To override the contents of this collection use set_key_attributes
.
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
Sourcepub fn set_key_attributes(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_key_attributes(self, input: Option<HashMap<String, String>>) -> Self
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
Sourcepub fn get_key_attributes(&self) -> &Option<HashMap<String, String>>
pub fn get_key_attributes(&self) -> &Option<HashMap<String, String>>
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
Sourcepub fn attribute_maps(self, input: HashMap<String, String>) -> Self
pub fn attribute_maps(self, input: HashMap<String, String>) -> Self
Appends an item to attribute_maps
.
To override the contents of this collection use set_attribute_maps
.
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
-
PlatformType
defines the hosted-in platform. -
EKS.Cluster
is the name of the Amazon EKS cluster. -
K8s.Cluster
is the name of the self-hosted Kubernetes cluster. -
K8s.Namespace
is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters. -
K8s.Workload
is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters. -
K8s.Node
is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters. -
K8s.Pod
is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters. -
EC2.AutoScalingGroup
is the name of the Amazon EC2 Auto Scaling group. -
EC2.InstanceId
is the ID of the Amazon EC2 instance. -
Host
is the name of the host, for all platform types.
Application attributes contain information about the application.
-
AWS.Application
is the application's name in Amazon Web Services Service Catalog AppRegistry. -
AWS.Application.ARN
is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
-
Telemetry.SDK
is the fingerprint of the OpenTelemetry SDK version for instrumented services. -
Telemetry.Agent
is the fingerprint of the agent used to collect and send telemetry data. -
Telemetry.Source
Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
Sourcepub fn set_attribute_maps(
self,
input: Option<Vec<HashMap<String, String>>>,
) -> Self
pub fn set_attribute_maps( self, input: Option<Vec<HashMap<String, String>>>, ) -> Self
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
-
PlatformType
defines the hosted-in platform. -
EKS.Cluster
is the name of the Amazon EKS cluster. -
K8s.Cluster
is the name of the self-hosted Kubernetes cluster. -
K8s.Namespace
is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters. -
K8s.Workload
is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters. -
K8s.Node
is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters. -
K8s.Pod
is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters. -
EC2.AutoScalingGroup
is the name of the Amazon EC2 Auto Scaling group. -
EC2.InstanceId
is the ID of the Amazon EC2 instance. -
Host
is the name of the host, for all platform types.
Application attributes contain information about the application.
-
AWS.Application
is the application's name in Amazon Web Services Service Catalog AppRegistry. -
AWS.Application.ARN
is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
-
Telemetry.SDK
is the fingerprint of the OpenTelemetry SDK version for instrumented services. -
Telemetry.Agent
is the fingerprint of the agent used to collect and send telemetry data. -
Telemetry.Source
Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
Sourcepub fn get_attribute_maps(&self) -> &Option<Vec<HashMap<String, String>>>
pub fn get_attribute_maps(&self) -> &Option<Vec<HashMap<String, String>>>
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
-
PlatformType
defines the hosted-in platform. -
EKS.Cluster
is the name of the Amazon EKS cluster. -
K8s.Cluster
is the name of the self-hosted Kubernetes cluster. -
K8s.Namespace
is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters. -
K8s.Workload
is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters. -
K8s.Node
is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters. -
K8s.Pod
is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters. -
EC2.AutoScalingGroup
is the name of the Amazon EC2 Auto Scaling group. -
EC2.InstanceId
is the ID of the Amazon EC2 instance. -
Host
is the name of the host, for all platform types.
Application attributes contain information about the application.
-
AWS.Application
is the application's name in Amazon Web Services Service Catalog AppRegistry. -
AWS.Application.ARN
is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
-
Telemetry.SDK
is the fingerprint of the OpenTelemetry SDK version for instrumented services. -
Telemetry.Agent
is the fingerprint of the agent used to collect and send telemetry data. -
Telemetry.Source
Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
Sourcepub fn service_groups(self, input: ServiceGroup) -> Self
pub fn service_groups(self, input: ServiceGroup) -> Self
Appends an item to service_groups
.
To override the contents of this collection use set_service_groups
.
An array of service groups that this service belongs to, based on the configured grouping attributes.
Sourcepub fn set_service_groups(self, input: Option<Vec<ServiceGroup>>) -> Self
pub fn set_service_groups(self, input: Option<Vec<ServiceGroup>>) -> Self
An array of service groups that this service belongs to, based on the configured grouping attributes.
Sourcepub fn get_service_groups(&self) -> &Option<Vec<ServiceGroup>>
pub fn get_service_groups(&self) -> &Option<Vec<ServiceGroup>>
An array of service groups that this service belongs to, based on the configured grouping attributes.
Sourcepub fn metric_references(self, input: MetricReference) -> Self
pub fn metric_references(self, input: MetricReference) -> Self
Appends an item to metric_references
.
To override the contents of this collection use set_metric_references
.
An array of structures that each contain information about one metric associated with this service.
Sourcepub fn set_metric_references(self, input: Option<Vec<MetricReference>>) -> Self
pub fn set_metric_references(self, input: Option<Vec<MetricReference>>) -> Self
An array of structures that each contain information about one metric associated with this service.
Sourcepub fn get_metric_references(&self) -> &Option<Vec<MetricReference>>
pub fn get_metric_references(&self) -> &Option<Vec<MetricReference>>
An array of structures that each contain information about one metric associated with this service.
Sourcepub fn log_group_references(self, input: HashMap<String, String>) -> Self
pub fn log_group_references(self, input: HashMap<String, String>) -> Self
Appends an item to log_group_references
.
To override the contents of this collection use set_log_group_references
.
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
-
"Type": "AWS::Resource"
-
"ResourceType": "AWS::Logs::LogGroup"
-
"Identifier": "name-of-log-group"
Sourcepub fn set_log_group_references(
self,
input: Option<Vec<HashMap<String, String>>>,
) -> Self
pub fn set_log_group_references( self, input: Option<Vec<HashMap<String, String>>>, ) -> Self
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
-
"Type": "AWS::Resource"
-
"ResourceType": "AWS::Logs::LogGroup"
-
"Identifier": "name-of-log-group"
Sourcepub fn get_log_group_references(&self) -> &Option<Vec<HashMap<String, String>>>
pub fn get_log_group_references(&self) -> &Option<Vec<HashMap<String, String>>>
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
-
"Type": "AWS::Resource"
-
"ResourceType": "AWS::Logs::LogGroup"
-
"Identifier": "name-of-log-group"
Trait Implementations§
Source§impl Clone for ServiceBuilder
impl Clone for ServiceBuilder
Source§fn clone(&self) -> ServiceBuilder
fn clone(&self) -> ServiceBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ServiceBuilder
impl Debug for ServiceBuilder
Source§impl Default for ServiceBuilder
impl Default for ServiceBuilder
Source§fn default() -> ServiceBuilder
fn default() -> ServiceBuilder
Source§impl PartialEq for ServiceBuilder
impl PartialEq for ServiceBuilder
impl StructuralPartialEq for ServiceBuilder
Auto Trait Implementations§
impl Freeze for ServiceBuilder
impl RefUnwindSafe for ServiceBuilder
impl Send for ServiceBuilder
impl Sync for ServiceBuilder
impl Unpin for ServiceBuilder
impl UnwindSafe for ServiceBuilder
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);