Class TaskScheduleDetails

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

Provides information about your DataSync task schedule.

See Also:

  • Method Details

    • statusUpdateTime

      public final Instant statusUpdateTime()

      Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.

      Returns:
      Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.

    • disabledReason

      public final String disabledReason()

      Provides a reason if the task schedule is disabled.

      If your schedule is disabled by USER, you see a Manually disabled by user. message.

      If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.

      Returns:
      Provides a reason if the task schedule is disabled.

      If your schedule is disabled by USER, you see a Manually disabled by user. message.

      If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.

    • disabledBy

      public final ScheduleDisabledBy disabledBy()

      Indicates how your task schedule was disabled.

      • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.

      • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

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

      Returns:
      Indicates how your task schedule was disabled.

      • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.

      • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

      See Also:

    • disabledByAsString

      public final String disabledByAsString()

      Indicates how your task schedule was disabled.

      • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.

      • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

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

      Returns:
      Indicates how your task schedule was disabled.

      • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.

      • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

      See Also:

    • toBuilder

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

    • builder

      public static TaskScheduleDetails.Builder builder()

    • serializableBuilderClass

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