Class MetricsDataSource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricsDataSource.Builder,
MetricsDataSource>
An object that contains details about the data source for the metrics export.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetricsDataSource.Builder
builder()
final Map
<MetricDimensionName, List<String>> An object that contains a mapping between aMetricDimensionName
andMetricDimensionValue
to filter metrics by.An object that contains a mapping between aMetricDimensionName
andMetricDimensionValue
to filter metrics by.final Instant
endDate()
Represents the end date for the export interval as a timestamp.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Dimensions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Metrics property.final List
<ExportMetric> metrics()
A list ofExportMetric
objects to export.final MetricNamespace
The metrics namespace - e.g.,VDM
.final String
The metrics namespace - e.g.,VDM
.static Class
<? extends MetricsDataSource.Builder> final Instant
Represents the start date for the export interval as a timestamp.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
dimensions
An object that contains a mapping between a
MetricDimensionName
andMetricDimensionValue
to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDimensions()
method.- Returns:
- An object that contains a mapping between a
MetricDimensionName
andMetricDimensionValue
to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.
-
hasDimensions
public final boolean hasDimensions()For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
dimensionsAsStrings
An object that contains a mapping between a
MetricDimensionName
andMetricDimensionValue
to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDimensions()
method.- Returns:
- An object that contains a mapping between a
MetricDimensionName
andMetricDimensionValue
to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.
-
namespace
The metrics namespace - e.g.,
VDM
.If the service returns an enum value that is not available in the current SDK version,
namespace
will returnMetricNamespace.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnamespaceAsString()
.- Returns:
- The metrics namespace - e.g.,
VDM
. - See Also:
-
namespaceAsString
The metrics namespace - e.g.,
VDM
.If the service returns an enum value that is not available in the current SDK version,
namespace
will returnMetricNamespace.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnamespaceAsString()
.- Returns:
- The metrics namespace - e.g.,
VDM
. - See Also:
-
hasMetrics
public final boolean hasMetrics()For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
metrics
A list of
ExportMetric
objects to export.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetrics()
method.- Returns:
- A list of
ExportMetric
objects to export.
-
startDate
Represents the start date for the export interval as a timestamp.
- Returns:
- Represents the start date for the export interval as a timestamp.
-
endDate
Represents the end date for the export interval as a timestamp.
- Returns:
- Represents the end date for the export interval as a timestamp.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MetricsDataSource.Builder,
MetricsDataSource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-