Interface GetInsightRuleReportRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchRequest.Builder
,CopyableBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
,SdkBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- GetInsightRuleReportRequest
public static interface GetInsightRuleReportRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<GetInsightRuleReportRequest.Builder,GetInsightRuleReportRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetInsightRuleReportRequest.Builder
endTime(Instant endTime)
The end time of the data to use in the report.GetInsightRuleReportRequest.Builder
maxContributorCount(Integer maxContributorCount)
The maximum number of contributors to include in the report.GetInsightRuleReportRequest.Builder
metrics(String... metrics)
Specifies which metrics to use for aggregation of contributor values for the report.GetInsightRuleReportRequest.Builder
metrics(Collection<String> metrics)
Specifies which metrics to use for aggregation of contributor values for the report.GetInsightRuleReportRequest.Builder
orderBy(String orderBy)
Determines what statistic to use to rank the contributors.GetInsightRuleReportRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetInsightRuleReportRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetInsightRuleReportRequest.Builder
period(Integer period)
The period, in seconds, to use for the statistics in theInsightRuleMetricDatapoint
results.GetInsightRuleReportRequest.Builder
ruleName(String ruleName)
The name of the rule that you want to see data from.GetInsightRuleReportRequest.Builder
startTime(Instant startTime)
The start time of the data to use in the report.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
ruleName
GetInsightRuleReportRequest.Builder ruleName(String ruleName)
The name of the rule that you want to see data from.
- Parameters:
ruleName
- The name of the rule that you want to see data from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTime
GetInsightRuleReportRequest.Builder startTime(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
.- Parameters:
startTime
- The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted asyyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
GetInsightRuleReportRequest.Builder endTime(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
.- Parameters:
endTime
- The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted asyyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
period
GetInsightRuleReportRequest.Builder period(Integer period)
The period, in seconds, to use for the statistics in the
InsightRuleMetricDatapoint
results.- Parameters:
period
- The period, in seconds, to use for the statistics in theInsightRuleMetricDatapoint
results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxContributorCount
GetInsightRuleReportRequest.Builder maxContributorCount(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
GetInsightRuleReportRequest.Builder metrics(Collection<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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
metrics
GetInsightRuleReportRequest.Builder metrics(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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
orderBy
GetInsightRuleReportRequest.Builder orderBy(String orderBy)
Determines what statistic to use to rank the contributors. Valid values are
Sum
andMaximum
.- Parameters:
orderBy
- Determines what statistic to use to rank the contributors. Valid values areSum
andMaximum
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetInsightRuleReportRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
GetInsightRuleReportRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-