Package software.amazon.awssdk.metrics
Enum MetricCategory
- All Implemented Interfaces:
Serializable
,Comparable<MetricCategory>
A enum class representing the different types of metric categories in the SDK.
A metric can be tagged with multiple categories. Clients can enable/disable metric collection
at a MetricCategory
level.
-
Enum Constant Summary
Enum ConstantDescriptionThis is an umbrella category (provided for convenience) that records metrics belonging to every category defined in this enum.Metrics collected by the core SDK are classified under this category.Metrics specified by the customer should be classified under this category.Metrics collected at the http client level are classified under this category. -
Method Summary
Modifier and TypeMethodDescriptionstatic MetricCategory
fromString
(String value) Create aMetricCategory
from the given String value.getValue()
static MetricCategory
Returns the enum constant of this type with the specified name.static MetricCategory[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
CORE
Metrics collected by the core SDK are classified under this category. -
HTTP_CLIENT
Metrics collected at the http client level are classified under this category. -
CUSTOM
Metrics specified by the customer should be classified under this category. -
ALL
This is an umbrella category (provided for convenience) that records metrics belonging to every category defined in this enum. Clients who wish to collect lot of SDK metrics data should use this.Note: Enabling this option along with
MetricLevel.TRACE
is verbose and can be expensive based on the platform the metrics are uploaded to. Please make sure you need all this data before using this category.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getValue
-
fromString
Create aMetricCategory
from the given String value. This method is case insensitive.- Parameters:
value
- the value to create theMetricCategory
from- Returns:
- A
MetricCategory
if the givenvalue
matches one of the enum values. Otherwise throwsIllegalArgumentException
-