Class RefreshSchedule

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

The refresh schedule of a dataset.

See Also:

  • Method Details

    • scheduleId

      public final String scheduleId()

      An identifier for the refresh schedule.

      Returns:
      An identifier for the refresh schedule.

    • scheduleFrequency

      public final RefreshFrequency scheduleFrequency()

      The frequency for the refresh schedule.

      Returns:
      The frequency for the refresh schedule.

    • startAfterDateTime

      public final Instant startAfterDateTime()

      Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

      Returns:
      Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

    • refreshType

      public final IngestionType refreshType()

      The type of refresh that a datset undergoes. Valid values are as follows:

      • FULL_REFRESH: A complete refresh of a dataset.

      • INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

      For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

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

      Returns:
      The type of refresh that a datset undergoes. Valid values are as follows:

      • FULL_REFRESH: A complete refresh of a dataset.

      • INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

      For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

      See Also:

    • refreshTypeAsString

      public final String refreshTypeAsString()

      The type of refresh that a datset undergoes. Valid values are as follows:

      • FULL_REFRESH: A complete refresh of a dataset.

      • INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

      For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

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

      Returns:
      The type of refresh that a datset undergoes. Valid values are as follows:

      • FULL_REFRESH: A complete refresh of a dataset.

      • INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.

      For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

      See Also:

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the refresh schedule.

      Returns:
      The Amazon Resource Name (ARN) for the refresh schedule.

    • toBuilder

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

    • builder

      public static RefreshSchedule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RefreshSchedule.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.