SummaryMetricQueryResult (AWS Java SDK for AWS IoT Wireless 1.12.692 API)

java.lang.Object
- com.amazonaws.services.iotwireless.model.SummaryMetricQueryResult

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The result of metrics aggregation operation.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SummaryMetricQueryResult()

Constructors
Constructor and Description
`SummaryMetricQueryResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SummaryMetricQueryResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAggregationPeriod()` The aggregation period of the metric.
`List<Dimension>`	`getDimensions()` The dimensions of the metric.
`Date`	`getEndTimestamp()` The end timestamp for summary metric query.
`String`	`getError()` The error message for the summary metric query.
`String`	`getMetricName()` The name of the metric.
`String`	`getQueryId()` The id of the query.
`String`	`getQueryStatus()` The status of the metric query.
`Date`	`getStartTimestamp()` The start timestamp for summary metric query.
`List<Date>`	`getTimestamps()` The timestamp of each aggregation result.
`String`	`getUnit()` The units of measurement to be used for interpreting the aggregation result.
`List<MetricQueryValue>`	`getValues()` The list of aggregated metrics.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAggregationPeriod(String aggregationPeriod)` The aggregation period of the metric.
`void`	`setDimensions(Collection<Dimension> dimensions)` The dimensions of the metric.
`void`	`setEndTimestamp(Date endTimestamp)` The end timestamp for summary metric query.
`void`	`setError(String error)` The error message for the summary metric query.
`void`	`setMetricName(String metricName)` The name of the metric.
`void`	`setQueryId(String queryId)` The id of the query.
`void`	`setQueryStatus(String queryStatus)` The status of the metric query.
`void`	`setStartTimestamp(Date startTimestamp)` The start timestamp for summary metric query.
`void`	`setTimestamps(Collection<Date> timestamps)` The timestamp of each aggregation result.
`void`	`setUnit(String unit)` The units of measurement to be used for interpreting the aggregation result.
`void`	`setValues(Collection<MetricQueryValue> values)` The list of aggregated metrics.
`String`	`toString()` Returns a string representation of this object.
`SummaryMetricQueryResult`	`withAggregationPeriod(AggregationPeriod aggregationPeriod)` The aggregation period of the metric.
`SummaryMetricQueryResult`	`withAggregationPeriod(String aggregationPeriod)` The aggregation period of the metric.
`SummaryMetricQueryResult`	`withDimensions(Collection<Dimension> dimensions)` The dimensions of the metric.
`SummaryMetricQueryResult`	`withDimensions(Dimension... dimensions)` The dimensions of the metric.
`SummaryMetricQueryResult`	`withEndTimestamp(Date endTimestamp)` The end timestamp for summary metric query.
`SummaryMetricQueryResult`	`withError(String error)` The error message for the summary metric query.
`SummaryMetricQueryResult`	`withMetricName(MetricName metricName)` The name of the metric.
`SummaryMetricQueryResult`	`withMetricName(String metricName)` The name of the metric.
`SummaryMetricQueryResult`	`withQueryId(String queryId)` The id of the query.
`SummaryMetricQueryResult`	`withQueryStatus(MetricQueryStatus queryStatus)` The status of the metric query.
`SummaryMetricQueryResult`	`withQueryStatus(String queryStatus)` The status of the metric query.
`SummaryMetricQueryResult`	`withStartTimestamp(Date startTimestamp)` The start timestamp for summary metric query.
`SummaryMetricQueryResult`	`withTimestamps(Collection<Date> timestamps)` The timestamp of each aggregation result.
`SummaryMetricQueryResult`	`withTimestamps(Date... timestamps)` The timestamp of each aggregation result.
`SummaryMetricQueryResult`	`withUnit(String unit)` The units of measurement to be used for interpreting the aggregation result.
`SummaryMetricQueryResult`	`withValues(Collection<MetricQueryValue> values)` The list of aggregated metrics.
`SummaryMetricQueryResult`	`withValues(MetricQueryValue... values)` The list of aggregated metrics.

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

- Constructor Detail
  - SummaryMetricQueryResult
```
public SummaryMetricQueryResult()
```
- Method Detail
  - setQueryId
```
public void setQueryId(String queryId)
```
    The id of the query.
    
    Parameters:
    
    queryId - The id of the query.
  - getQueryId
```
public String getQueryId()
```
    The id of the query.
    
    Returns:
    
    The id of the query.
  - withQueryId
```
public SummaryMetricQueryResult withQueryId(String queryId)
```
    The id of the query.
    
    Parameters:
    
    queryId - The id of the query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryStatus
```
public void setQueryStatus(String queryStatus)
```
    The status of the metric query.
    
    Parameters:
    
    queryStatus - The status of the metric query.
    
    See Also:
    
    MetricQueryStatus
  - getQueryStatus
```
public String getQueryStatus()
```
    The status of the metric query.
    
    Returns:
    
    The status of the metric query.
    
    See Also:
    
    MetricQueryStatus
  - withQueryStatus
```
public SummaryMetricQueryResult withQueryStatus(String queryStatus)
```
    The status of the metric query.
    
    Parameters:
    
    queryStatus - The status of the metric query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricQueryStatus
  - withQueryStatus
```
public SummaryMetricQueryResult withQueryStatus(MetricQueryStatus queryStatus)
```
    The status of the metric query.
    
    Parameters:
    
    queryStatus - The status of the metric query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricQueryStatus
  - setError
```
public void setError(String error)
```
    The error message for the summary metric query.
    
    Parameters:
    
    error - The error message for the summary metric query.
  - getError
```
public String getError()
```
    The error message for the summary metric query.
    
    Returns:
    
    The error message for the summary metric query.
  - withError
```
public SummaryMetricQueryResult withError(String error)
```
    The error message for the summary metric query.
    
    Parameters:
    
    error - The error message for the summary metric query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the metric.
    
    Parameters:
    
    metricName - The name of the metric.
    
    See Also:
    
    MetricName
  - getMetricName
```
public String getMetricName()
```
    The name of the metric.
    
    Returns:
    
    The name of the metric.
    
    See Also:
    
    MetricName
  - withMetricName
```
public SummaryMetricQueryResult withMetricName(String metricName)
```
    The name of the metric.
    
    Parameters:
    
    metricName - The name of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricName
  - withMetricName
```
public SummaryMetricQueryResult withMetricName(MetricName metricName)
```
    The name of the metric.
    
    Parameters:
    
    metricName - The name of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricName
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions of the metric.
    
    Returns:
    
    The dimensions of the metric.
  - setDimensions
```
public void setDimensions(Collection<Dimension> dimensions)
```
    The dimensions of the metric.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
  - withDimensions
```
public SummaryMetricQueryResult withDimensions(Dimension... dimensions)
```
    The dimensions of the metric.
    
    NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public SummaryMetricQueryResult withDimensions(Collection<Dimension> dimensions)
```
    The dimensions of the metric.
    
    Parameters:
    
    dimensions - The dimensions of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAggregationPeriod
```
public void setAggregationPeriod(String aggregationPeriod)
```
    The aggregation period of the metric.
    
    Parameters:
    
    aggregationPeriod - The aggregation period of the metric.
    
    See Also:
    
    AggregationPeriod
  - getAggregationPeriod
```
public String getAggregationPeriod()
```
    The aggregation period of the metric.
    
    Returns:
    
    The aggregation period of the metric.
    
    See Also:
    
    AggregationPeriod
  - withAggregationPeriod
```
public SummaryMetricQueryResult withAggregationPeriod(String aggregationPeriod)
```
    The aggregation period of the metric.
    
    Parameters:
    
    aggregationPeriod - The aggregation period of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AggregationPeriod
  - withAggregationPeriod
```
public SummaryMetricQueryResult withAggregationPeriod(AggregationPeriod aggregationPeriod)
```
    The aggregation period of the metric.
    
    Parameters:
    
    aggregationPeriod - The aggregation period of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AggregationPeriod
  - setStartTimestamp
```
public void setStartTimestamp(Date startTimestamp)
```
    The start timestamp for summary metric query.
    
    Parameters:
    
    startTimestamp - The start timestamp for summary metric query.
  - getStartTimestamp
```
public Date getStartTimestamp()
```
    The start timestamp for summary metric query.
    
    Returns:
    
    The start timestamp for summary metric query.
  - withStartTimestamp
```
public SummaryMetricQueryResult withStartTimestamp(Date startTimestamp)
```
    The start timestamp for summary metric query.
    
    Parameters:
    
    startTimestamp - The start timestamp for summary metric query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTimestamp
```
public void setEndTimestamp(Date endTimestamp)
```
    The end timestamp for summary metric query.
    
    Parameters:
    
    endTimestamp - The end timestamp for summary metric query.
  - getEndTimestamp
```
public Date getEndTimestamp()
```
    The end timestamp for summary metric query.
    
    Returns:
    
    The end timestamp for summary metric query.
  - withEndTimestamp
```
public SummaryMetricQueryResult withEndTimestamp(Date endTimestamp)
```
    The end timestamp for summary metric query.
    
    Parameters:
    
    endTimestamp - The end timestamp for summary metric query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTimestamps
```
public List<Date> getTimestamps()
```
    The timestamp of each aggregation result.
    
    Returns:
    
    The timestamp of each aggregation result.
  - setTimestamps
```
public void setTimestamps(Collection<Date> timestamps)
```
    The timestamp of each aggregation result.
    
    Parameters:
    
    timestamps - The timestamp of each aggregation result.
  - withTimestamps
```
public SummaryMetricQueryResult withTimestamps(Date... timestamps)
```
    The timestamp of each aggregation result.
    
    NOTE: This method appends the values to the existing list (if any). Use setTimestamps(java.util.Collection) or withTimestamps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    timestamps - The timestamp of each aggregation result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTimestamps
```
public SummaryMetricQueryResult withTimestamps(Collection<Date> timestamps)
```
    The timestamp of each aggregation result.
    
    Parameters:
    
    timestamps - The timestamp of each aggregation result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValues
```
public List<MetricQueryValue> getValues()
```
    The list of aggregated metrics.
    
    Returns:
    
    The list of aggregated metrics.
  - setValues
```
public void setValues(Collection<MetricQueryValue> values)
```
    The list of aggregated metrics.
    
    Parameters:
    
    values - The list of aggregated metrics.
  - withValues
```
public SummaryMetricQueryResult withValues(MetricQueryValue... values)
```
    The list of aggregated metrics.
    
    NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    values - The list of aggregated metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public SummaryMetricQueryResult withValues(Collection<MetricQueryValue> values)
```
    The list of aggregated metrics.
    
    Parameters:
    
    values - The list of aggregated metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    The units of measurement to be used for interpreting the aggregation result.
    
    Parameters:
    
    unit - The units of measurement to be used for interpreting the aggregation result.
  - getUnit
```
public String getUnit()
```
    The units of measurement to be used for interpreting the aggregation result.
    
    Returns:
    
    The units of measurement to be used for interpreting the aggregation result.
  - withUnit
```
public SummaryMetricQueryResult withUnit(String unit)
```
    The units of measurement to be used for interpreting the aggregation result.
    
    Parameters:
    
    unit - The units of measurement to be used for interpreting the aggregation result.
    
    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 SummaryMetricQueryResult clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SummaryMetricQueryResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SummaryMetricQueryResult

Method Detail

setQueryId

getQueryId

withQueryId

setQueryStatus

getQueryStatus

withQueryStatus

withQueryStatus

setError

getError

withError

setMetricName

getMetricName

withMetricName

withMetricName

getDimensions

setDimensions

withDimensions

withDimensions

setAggregationPeriod

getAggregationPeriod

withAggregationPeriod

withAggregationPeriod

setStartTimestamp

getStartTimestamp

withStartTimestamp

setEndTimestamp

getEndTimestamp

withEndTimestamp

getTimestamps

setTimestamps

withTimestamps

withTimestamps

getValues

setValues

withValues

withValues

setUnit

getUnit

withUnit

toString

equals

hashCode

clone

marshall