Class MetricsDataSource

java.lang.Object
software.amazon.awssdk.services.sesv2.model.MetricsDataSource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MetricsDataSource.Builder,MetricsDataSource>
@Generated("software.amazon.awssdk:codegen") public final class MetricsDataSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricsDataSource.Builder,MetricsDataSource>

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

See Also:

  • Method Details

    • dimensions

      public final Map<MetricDimensionName,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.

      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 and MetricDimensionValue 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 the isEmpty() 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

      public final Map<String,List<String>> dimensionsAsStrings()

      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.

      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 and MetricDimensionValue to filter metrics by. Must contain a least 1 dimension but no more than 3 unique ones.

    • namespace

      public final MetricNamespace 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 return MetricNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

      Returns:
      The metrics namespace - e.g., VDM.
      See Also:

    • namespaceAsString

      public final String 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 return MetricNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namespaceAsString().

      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 the isEmpty() 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

      public final List<ExportMetric> 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

      public final Instant 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

      public final Instant 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

      public MetricsDataSource.Builder 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 interface ToCopyableBuilder<MetricsDataSource.Builder,MetricsDataSource>
      Returns:
      a builder for type T

    • builder

      public static MetricsDataSource.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MetricsDataSource.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.