com.amazonaws.services.simpleemailv2.model

Class MetricsDataSource

java.lang.Object

com.amazonaws.services.simpleemailv2.model.MetricsDataSource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An object that contains details about the data source for the metrics export.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricsDataSource()

Method Summary

Modifier and Type	Method and Description
MetricsDataSource	addDimensionsEntry(String key, List<String> value) Add a single Dimensions entry
MetricsDataSource	clearDimensionsEntries() Removes all the entries added into Dimensions.
MetricsDataSource	clone()
boolean	equals(Object obj)
Map<String,List<String>>	getDimensions() An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by.
Date	getEndDate() Represents the end date for the export interval as a timestamp.
List<ExportMetric>	getMetrics() A list of ExportMetric objects to export.
String	getNamespace() The metrics namespace - e.g., VDM.
Date	getStartDate() Represents the start date for the export interval as a timestamp.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setDimensions(Map<String,List<String>> dimensions) An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by.
void	setEndDate(Date endDate) Represents the end date for the export interval as a timestamp.
void	setMetrics(Collection<ExportMetric> metrics) A list of ExportMetric objects to export.
void	setNamespace(String namespace) The metrics namespace - e.g., VDM.
void	setStartDate(Date startDate) Represents the start date for the export interval as a timestamp.
String	toString() Returns a string representation of this object.
MetricsDataSource	withDimensions(Map<String,List<String>> dimensions) An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by.
MetricsDataSource	withEndDate(Date endDate) Represents the end date for the export interval as a timestamp.
MetricsDataSource	withMetrics(Collection<ExportMetric> metrics) A list of ExportMetric objects to export.
MetricsDataSource	withMetrics(ExportMetric... metrics) A list of ExportMetric objects to export.
MetricsDataSource	withNamespace(MetricNamespace namespace) The metrics namespace - e.g., VDM.
MetricsDataSource	withNamespace(String namespace) The metrics namespace - e.g., VDM.
MetricsDataSource	withStartDate(Date startDate) Represents the start date for the export interval as a timestamp.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsDataSource

public MetricsDataSource()

Method Detail

getDimensions

public Map<String,List<String>> getDimensions()

An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

Returns:

An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

setDimensions

public void setDimensions(Map<String,List<String>> dimensions)

An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

Parameters:

dimensions - An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

withDimensions

public MetricsDataSource withDimensions(Map<String,List<String>> dimensions)

An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

Parameters:

dimensions - An object that contains a mapping between a MetricDimensionName and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

Returns:

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

addDimensionsEntry

public MetricsDataSource addDimensionsEntry(String key,
                                            List<String> value)

Add a single Dimensions entry

See Also:

withDimensions(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearDimensionsEntries

public MetricsDataSource clearDimensionsEntries()

Removes all the entries added into Dimensions.

Returns:

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

setNamespace

public void setNamespace(String namespace)

The metrics namespace - e.g., VDM.

Parameters:

namespace - The metrics namespace - e.g., VDM.

See Also:

MetricNamespace

getNamespace

public String getNamespace()

The metrics namespace - e.g., VDM.

Returns:

The metrics namespace - e.g., VDM.

See Also:

MetricNamespace

withNamespace

public MetricsDataSource withNamespace(String namespace)

The metrics namespace - e.g., VDM.

Parameters:

namespace - The metrics namespace - e.g., VDM.

Returns:

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

See Also:

MetricNamespace

withNamespace

public MetricsDataSource withNamespace(MetricNamespace namespace)

The metrics namespace - e.g., VDM.

Parameters:

namespace - The metrics namespace - e.g., VDM.

Returns:

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

See Also:

MetricNamespace

getMetrics

public List<ExportMetric> getMetrics()

A list of ExportMetric objects to export.

Returns:

A list of ExportMetric objects to export.

setMetrics

public void setMetrics(Collection<ExportMetric> metrics)

A list of ExportMetric objects to export.

Parameters:

metrics - A list of ExportMetric objects to export.

withMetrics

public MetricsDataSource withMetrics(ExportMetric... metrics)

A list of ExportMetric objects to export.

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 - A list of ExportMetric objects to export.

Returns:

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

withMetrics

public MetricsDataSource withMetrics(Collection<ExportMetric> metrics)

A list of ExportMetric objects to export.

Parameters:

metrics - A list of ExportMetric objects to export.

Returns:

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

setStartDate

public void setStartDate(Date startDate)

Represents the start date for the export interval as a timestamp.

Parameters:

startDate - Represents the start date for the export interval as a timestamp.

getStartDate

public Date getStartDate()

Represents the start date for the export interval as a timestamp.

Returns:

Represents the start date for the export interval as a timestamp.

withStartDate

public MetricsDataSource withStartDate(Date startDate)

Represents the start date for the export interval as a timestamp.

Parameters:

startDate - Represents the start date for the export interval as a timestamp.

Returns:

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

setEndDate

public void setEndDate(Date endDate)

Represents the end date for the export interval as a timestamp.

Parameters:

endDate - Represents the end date for the export interval as a timestamp.

getEndDate

public Date getEndDate()

Represents the end date for the export interval as a timestamp.

Returns:

Represents the end date for the export interval as a timestamp.

withEndDate

public MetricsDataSource withEndDate(Date endDate)

Represents the end date for the export interval as a timestamp.

Parameters:

endDate - Represents the end date for the export interval as a timestamp.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo