Class GetInsightRuleReportRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
-
- software.amazon.awssdk.services.cloudwatch.model.GetInsightRuleReportRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetInsightRuleReportRequest extends CloudWatchRequest implements ToCopyableBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetInsightRuleReportRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetInsightRuleReportRequest.Builder
builder()
Instant
endTime()
The end time of the data to use in the report.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property.Integer
maxContributorCount()
The maximum number of contributors to include in the report.List<String>
metrics()
Specifies which metrics to use for aggregation of contributor values for the report.String
orderBy()
Determines what statistic to use to rank the contributors.Integer
period()
The period, in seconds, to use for the statistics in theInsightRuleMetricDatapoint
results.String
ruleName()
The name of the rule that you want to see data from.List<SdkField<?>>
sdkFields()
static Class<? extends GetInsightRuleReportRequest.Builder>
serializableBuilderClass()
Instant
startTime()
The start time of the data to use in the report.GetInsightRuleReportRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
ruleName
public final String ruleName()
The name of the rule that you want to see data from.
- Returns:
- The name of the rule that you want to see data from.
-
startTime
public final Instant startTime()
The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.- Returns:
- The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.
-
endTime
public final Instant endTime()
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.- Returns:
- The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.
-
period
public final Integer period()
The period, in seconds, to use for the statistics in the
InsightRuleMetricDatapoint
results.- Returns:
- The period, in seconds, to use for the statistics in the
InsightRuleMetricDatapoint
results.
-
maxContributorCount
public final Integer maxContributorCount()
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
- Returns:
- The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
-
hasMetrics
public final boolean hasMetrics()
For responses, this returns true if the service returned a value for the Metrics 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.
-
metrics
public final List<String> metrics()
Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:
-
UniqueContributors
-- the number of unique contributors for each data point. -
MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's
Value
, during that period. -
SampleCount
-- the number of data points matched by the rule. -
Sum
-- the sum of the values from all contributors during the time period represented by that data point. -
Minimum
-- the minimum value from a single observation during the time period represented by that data point. -
Maximum
-- the maximum value from a single observation during the time period represented by that data point. -
Average
-- the average value from all contributors during the time period represented by that data point.
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
hasMetrics()
method.- Returns:
- Specifies which metrics to use for aggregation of contributor values for the report. You can specify one
or more of the following metrics:
-
UniqueContributors
-- the number of unique contributors for each data point. -
MaxContributorValue
-- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's
Value
, during that period. -
SampleCount
-- the number of data points matched by the rule. -
Sum
-- the sum of the values from all contributors during the time period represented by that data point. -
Minimum
-- the minimum value from a single observation during the time period represented by that data point. -
Maximum
-- the maximum value from a single observation during the time period represented by that data point. -
Average
-- the average value from all contributors during the time period represented by that data point.
-
-
-
orderBy
public final String orderBy()
Determines what statistic to use to rank the contributors. Valid values are
Sum
andMaximum
.- Returns:
- Determines what statistic to use to rank the contributors. Valid values are
Sum
andMaximum
.
-
toBuilder
public GetInsightRuleReportRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
- Specified by:
toBuilder
in classCloudWatchRequest
-
builder
public static GetInsightRuleReportRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetInsightRuleReportRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
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 classSdkRequest
-
-