Class PeriodToDateComputation

    • Method Detail

      • computationId

        public final String computationId()

        The ID for a computation.

        Returns:
        The ID for a computation.
      • name

        public final String name()

        The name of a computation.

        Returns:
        The name of a computation.
      • time

        public final DimensionField time()

        The time field that is used in a computation.

        Returns:
        The time field that is used in a computation.
      • value

        public final MeasureField value()

        The value field that is used in a computation.

        Returns:
        The value field that is used in a computation.
      • periodTimeGranularity

        public final TimeGranularity periodTimeGranularity()

        The time granularity setup of period to date computation. Choose from the following options:

        • YEAR: Year to date.

        • MONTH: Month to date.

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

        Returns:
        The time granularity setup of period to date computation. Choose from the following options:

        • YEAR: Year to date.

        • MONTH: Month to date.

        See Also:
        TimeGranularity
      • periodTimeGranularityAsString

        public final String periodTimeGranularityAsString()

        The time granularity setup of period to date computation. Choose from the following options:

        • YEAR: Year to date.

        • MONTH: Month to date.

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

        Returns:
        The time granularity setup of period to date computation. Choose from the following options:

        • YEAR: Year to date.

        • MONTH: Month to date.

        See Also:
        TimeGranularity
      • 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)