Class GetInsightRuleReportResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
-
- software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetInsightRuleReportResponse.Builder,GetInsightRuleReportResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetInsightRuleReportResponse extends CloudWatchResponse implements ToCopyableBuilder<GetInsightRuleReportResponse.Builder,GetInsightRuleReportResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetInsightRuleReportResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Double
aggregateValue()
The sum of the values from all individual contributors that match the rule.String
aggregationStatistic()
Specifies whether this rule aggregates contributor data by COUNT or SUM.Long
approximateUniqueCount()
An approximate count of the unique contributors found by this rule in this time period.static GetInsightRuleReportResponse.Builder
builder()
List<InsightRuleContributor>
contributors()
An array of the unique contributors found by this rule in this time period.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasContributors()
For responses, this returns true if the service returned a value for the Contributors property.int
hashCode()
boolean
hasKeyLabels()
For responses, this returns true if the service returned a value for the KeyLabels property.boolean
hasMetricDatapoints()
For responses, this returns true if the service returned a value for the MetricDatapoints property.List<String>
keyLabels()
An array of the strings used as the keys for this rule.List<InsightRuleMetricDatapoint>
metricDatapoints()
A time series of metric data points that matches the time period in the rule request.List<SdkField<?>>
sdkFields()
static Class<? extends GetInsightRuleReportResponse.Builder>
serializableBuilderClass()
GetInsightRuleReportResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.cloudwatch.model.CloudWatchResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasKeyLabels
public final boolean hasKeyLabels()
For responses, this returns true if the service returned a value for the KeyLabels property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
keyLabels
public final List<String> keyLabels()
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasKeyLabels()
method.- Returns:
- An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
-
aggregationStatistic
public final String aggregationStatistic()
Specifies whether this rule aggregates contributor data by COUNT or SUM.
- Returns:
- Specifies whether this rule aggregates contributor data by COUNT or SUM.
-
aggregateValue
public final Double aggregateValue()
The sum of the values from all individual contributors that match the rule.
- Returns:
- The sum of the values from all individual contributors that match the rule.
-
approximateUniqueCount
public final Long approximateUniqueCount()
An approximate count of the unique contributors found by this rule in this time period.
- Returns:
- An approximate count of the unique contributors found by this rule in this time period.
-
hasContributors
public final boolean hasContributors()
For responses, this returns true if the service returned a value for the Contributors property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
contributors
public final List<InsightRuleContributor> contributors()
An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasContributors()
method.- Returns:
- An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
-
hasMetricDatapoints
public final boolean hasMetricDatapoints()
For responses, this returns true if the service returned a value for the MetricDatapoints property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
metricDatapoints
public final List<InsightRuleMetricDatapoint> metricDatapoints()
A time series of metric data points that matches the time period in the rule request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetricDatapoints()
method.- Returns:
- A time series of metric data points that matches the time period in the rule request.
-
toBuilder
public GetInsightRuleReportResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetInsightRuleReportResponse.Builder,GetInsightRuleReportResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static GetInsightRuleReportResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetInsightRuleReportResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkResponse
-
-