Class RefreshSchedule

    • Method Detail

      • frequency

        public final RefreshScheduleFrequency frequency()

        The frequency at which you want the dashboard refreshed.

        Returns:
        The frequency at which you want the dashboard refreshed.
      • status

        public final RefreshScheduleStatus status()

        Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

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

        Returns:
        Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
        See Also:
        RefreshScheduleStatus
      • statusAsString

        public final String statusAsString()

        Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

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

        Returns:
        Specifies whether the refresh schedule is enabled. Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.
        See Also:
        RefreshScheduleStatus
      • timeOfDay

        public final String timeOfDay()

        The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.

        Returns:
        The time of day in UTC to run the schedule; for hourly only refer to minutes; default is 00:00.
      • 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)