GetInsightRuleReportRequest (AWS Java SDK for Amazon CloudWatch 1.12.657 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudwatch.model.GetInsightRuleReportRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetInsightRuleReportRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetInsightRuleReportRequest()

Constructors
Constructor and Description
`GetInsightRuleReportRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetInsightRuleReportRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getEndTime()` The end time of the data to use in the report.
`Integer`	`getMaxContributorCount()` The maximum number of contributors to include in the report.
`List<String>`	`getMetrics()` Specifies which metrics to use for aggregation of contributor values for the report.
`String`	`getOrderBy()` Determines what statistic to use to rank the contributors.
`Integer`	`getPeriod()` The period, in seconds, to use for the statistics in the `InsightRuleMetricDatapoint` results.
`String`	`getRuleName()` The name of the rule that you want to see data from.
`Date`	`getStartTime()` The start time of the data to use in the report.
`int`	`hashCode()`
`void`	`setEndTime(Date endTime)` The end time of the data to use in the report.
`void`	`setMaxContributorCount(Integer maxContributorCount)` The maximum number of contributors to include in the report.
`void`	`setMetrics(Collection<String> metrics)` Specifies which metrics to use for aggregation of contributor values for the report.
`void`	`setOrderBy(String orderBy)` Determines what statistic to use to rank the contributors.
`void`	`setPeriod(Integer period)` The period, in seconds, to use for the statistics in the `InsightRuleMetricDatapoint` results.
`void`	`setRuleName(String ruleName)` The name of the rule that you want to see data from.
`void`	`setStartTime(Date startTime)` The start time of the data to use in the report.
`String`	`toString()` Returns a string representation of this object.
`GetInsightRuleReportRequest`	`withEndTime(Date endTime)` The end time of the data to use in the report.
`GetInsightRuleReportRequest`	`withMaxContributorCount(Integer maxContributorCount)` The maximum number of contributors to include in the report.
`GetInsightRuleReportRequest`	`withMetrics(Collection<String> metrics)` Specifies which metrics to use for aggregation of contributor values for the report.
`GetInsightRuleReportRequest`	`withMetrics(String... metrics)` Specifies which metrics to use for aggregation of contributor values for the report.
`GetInsightRuleReportRequest`	`withOrderBy(String orderBy)` Determines what statistic to use to rank the contributors.
`GetInsightRuleReportRequest`	`withPeriod(Integer period)` The period, in seconds, to use for the statistics in the `InsightRuleMetricDatapoint` results.
`GetInsightRuleReportRequest`	`withRuleName(String ruleName)` The name of the rule that you want to see data from.
`GetInsightRuleReportRequest`	`withStartTime(Date startTime)` The start time of the data to use in the report.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetInsightRuleReportRequest
```
public GetInsightRuleReportRequest()
```
- Method Detail
  - setRuleName
```
public void setRuleName(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.
  - getRuleName
```
public String getRuleName()
```
    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.
  - withRuleName
```
public GetInsightRuleReportRequest withRuleName(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.
  - setStartTime
```
public void setStartTime(Date 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 as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
  - getStartTime
```
public Date getStartTime()
```
    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.
  - withStartTime
```
public GetInsightRuleReportRequest withStartTime(Date 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 as yyyy-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.
  - setEndTime
```
public void setEndTime(Date 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 as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
  - getEndTime
```
public Date getEndTime()
```
    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.
  - withEndTime
```
public GetInsightRuleReportRequest withEndTime(Date 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 as yyyy-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.
  - setPeriod
```
public void setPeriod(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 the InsightRuleMetricDatapoint results.
  - getPeriod
```
public Integer getPeriod()
```
    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.
  - withPeriod
```
public GetInsightRuleReportRequest withPeriod(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 the InsightRuleMetricDatapoint results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxContributorCount
```
public void setMaxContributorCount(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.
  - getMaxContributorCount
```
public Integer getMaxContributorCount()
```
    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.
  - withMaxContributorCount
```
public GetInsightRuleReportRequest withMaxContributorCount(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.
  - getMetrics
```
public List<String> getMetrics()
```
    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:
    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.
  - setMetrics
```
public void setMetrics(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.
  - withMetrics
```
public GetInsightRuleReportRequest withMetrics(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.
    NOTE: This method appends the values to the existing list (if any). Use setMetrics(java.util.Collection) or withMetrics(java.util.Collection) if you want to override the existing values.
    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.
  - withMetrics
```
public GetInsightRuleReportRequest withMetrics(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.
  - setOrderBy
```
public void setOrderBy(String orderBy)
```
    Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
    
    Parameters:
    
    orderBy - Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
  - getOrderBy
```
public String getOrderBy()
```
    Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
    
    Returns:
    
    Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
  - withOrderBy
```
public GetInsightRuleReportRequest withOrderBy(String orderBy)
```
    Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
    
    Parameters:
    
    orderBy - Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetInsightRuleReportRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class GetInsightRuleReportRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetInsightRuleReportRequest

Method Detail

setRuleName

getRuleName

withRuleName

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setPeriod

getPeriod

withPeriod

setMaxContributorCount

getMaxContributorCount

withMaxContributorCount

getMetrics

setMetrics

withMetrics

withMetrics

setOrderBy

getOrderBy

withOrderBy

toString

equals

hashCode

clone