Class DailyVolume

    • Method Detail

      • startDate

        public final Instant startDate()

        The date that the DailyVolume metrics apply to, in Unix time.

        Returns:
        The date that the DailyVolume metrics apply to, in Unix time.
      • volumeStatistics

        public final VolumeStatistics volumeStatistics()

        An object that contains inbox placement metrics for a specific day in the analysis period.

        Returns:
        An object that contains inbox placement metrics for a specific day in the analysis period.
      • hasDomainIspPlacements

        public final boolean hasDomainIspPlacements()
        For responses, this returns true if the service returned a value for the DomainIspPlacements 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.
      • domainIspPlacements

        public final List<DomainIspPlacement> domainIspPlacements()

        An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

        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 hasDomainIspPlacements() method.

        Returns:
        An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)