Class TemporalStatisticsConfigInput

    • Method Detail

      • groupBy

        public final GroupBy groupBy()

        The input for the temporal statistics grouping by time frequency option.

        If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().

        Returns:
        The input for the temporal statistics grouping by time frequency option.
        See Also:
        GroupBy
      • groupByAsString

        public final String groupByAsString()

        The input for the temporal statistics grouping by time frequency option.

        If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().

        Returns:
        The input for the temporal statistics grouping by time frequency option.
        See Also:
        GroupBy
      • statistics

        public final List<TemporalStatistics> statistics()

        The list of the statistics method options.

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

        Returns:
        The list of the statistics method options.
      • hasStatistics

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

        public final List<String> statisticsAsStrings()

        The list of the statistics method options.

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

        Returns:
        The list of the statistics method options.
      • hasTargetBands

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

        public final List<String> targetBands()

        The list of target band names for the temporal statistic to calculate.

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

        Returns:
        The list of target band names for the temporal statistic to calculate.
      • 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)