com.amazonaws.services.cloudwatch.model

Class MetricDataResult

java.lang.Object

com.amazonaws.services.cloudwatch.model.MetricDataResult

All Implemented Interfaces:

Serializable, Cloneable

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

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricDataResult()

Method Summary

Modifier and Type	Method and Description
MetricDataResult	clone()
boolean	equals(Object obj)
String	getId() The short name you specified to represent this metric.
String	getLabel() The human-readable label associated with the data.
List<MessageData>	getMessages() A list of messages with additional information about the data returned.
String	getStatusCode() The status of the returned data.
List<Date>	getTimestamps() The timestamps for the data points, formatted in Unix timestamp format.
List<Double>	getValues() The data points for the metric corresponding to Timestamps.
int	hashCode()
void	setId(String id) The short name you specified to represent this metric.
void	setLabel(String label) The human-readable label associated with the data.
void	setMessages(Collection<MessageData> messages) A list of messages with additional information about the data returned.
void	setStatusCode(String statusCode) The status of the returned data.
void	setTimestamps(Collection<Date> timestamps) The timestamps for the data points, formatted in Unix timestamp format.
void	setValues(Collection<Double> values) The data points for the metric corresponding to Timestamps.
String	toString() Returns a string representation of this object.
MetricDataResult	withId(String id) The short name you specified to represent this metric.
MetricDataResult	withLabel(String label) The human-readable label associated with the data.
MetricDataResult	withMessages(Collection<MessageData> messages) A list of messages with additional information about the data returned.
MetricDataResult	withMessages(MessageData... messages) A list of messages with additional information about the data returned.
MetricDataResult	withStatusCode(StatusCode statusCode) The status of the returned data.
MetricDataResult	withStatusCode(String statusCode) The status of the returned data.
MetricDataResult	withTimestamps(Collection<Date> timestamps) The timestamps for the data points, formatted in Unix timestamp format.
MetricDataResult	withTimestamps(Date... timestamps) The timestamps for the data points, formatted in Unix timestamp format.
MetricDataResult	withValues(Collection<Double> values) The data points for the metric corresponding to Timestamps.
MetricDataResult	withValues(Double... values) The data points for the metric corresponding to Timestamps.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricDataResult

public MetricDataResult()

Method Detail

setId

public void setId(String id)

The short name you specified to represent this metric.

Parameters:

id - The short name you specified to represent this metric.

getId

public String getId()

The short name you specified to represent this metric.

Returns:

The short name you specified to represent this metric.

withId

public MetricDataResult withId(String id)

The short name you specified to represent this metric.

Parameters:

id - The short name you specified to represent this metric.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLabel

public void setLabel(String label)

The human-readable label associated with the data.

Parameters:

label - The human-readable label associated with the data.

getLabel

public String getLabel()

The human-readable label associated with the data.

Returns:

The human-readable label associated with the data.

withLabel

public MetricDataResult withLabel(String label)

The human-readable label associated with the data.

Parameters:

label - The human-readable label associated with the data.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTimestamps

public List<Date> getTimestamps()

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Returns:

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

setTimestamps

public void setTimestamps(Collection<Date> timestamps)

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Parameters:

timestamps - The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

withTimestamps

public MetricDataResult withTimestamps(Date... timestamps)

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

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 timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Returns:

Returns a reference to this object so that method calls can be chained together.

withTimestamps

public MetricDataResult withTimestamps(Collection<Date> timestamps)

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Parameters:

timestamps - The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

Returns:

Returns a reference to this object so that method calls can be chained together.

getValues

public List<Double> getValues()

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Returns:

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

setValues

public void setValues(Collection<Double> values)

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Parameters:

values - The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

withValues

public MetricDataResult withValues(Double... values)

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

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 data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public MetricDataResult withValues(Collection<Double> values)

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Parameters:

values - The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatusCode

public void setStatusCode(String statusCode)

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Parameters:

statusCode - The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

See Also:

StatusCode

getStatusCode

public String getStatusCode()

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Returns:

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

See Also:

StatusCode

withStatusCode

public MetricDataResult withStatusCode(String statusCode)

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Parameters:

statusCode - The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatusCode

withStatusCode

public MetricDataResult withStatusCode(StatusCode statusCode)

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Parameters:

statusCode - The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StatusCode

getMessages

public List<MessageData> getMessages()

A list of messages with additional information about the data returned.

Returns:

A list of messages with additional information about the data returned.

setMessages

public void setMessages(Collection<MessageData> messages)

A list of messages with additional information about the data returned.

Parameters:

messages - A list of messages with additional information about the data returned.

withMessages

public MetricDataResult withMessages(MessageData... messages)

A list of messages with additional information about the data returned.

NOTE: This method appends the values to the existing list (if any). Use setMessages(java.util.Collection) or withMessages(java.util.Collection) if you want to override the existing values.

Parameters:

messages - A list of messages with additional information about the data returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

withMessages

public MetricDataResult withMessages(Collection<MessageData> messages)

A list of messages with additional information about the data returned.

Parameters:

messages - A list of messages with additional information about the data returned.

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 MetricDataResult clone()

Overrides:

clone in class Object