Class ScheduleAction

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

Describes one schedule action on a feed, including the changes it makes and whether it has run yet. Elemental Inference returns this structure in the ListScheduleActions operation.

See Also:

  • Method Details

    • actionName

      public final String actionName()

      The name of the schedule action. The name is unique within the feed.

      Returns:
      The name of the schedule action. The name is unique within the feed.

    • startConfiguration

      public final ScheduleActionStartConfiguration startConfiguration()

      Specifies when the action runs.

      Returns:
      Specifies when the action runs.

    • hasOperations

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

    • operations

      public final List<ScheduleActionOperation> operations()

      The configuration changes that the action makes to the feed.

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

      Returns:
      The configuration changes that the action makes to the feed.

    • status

      public final ScheduleActionStatus status()

      The status of the action. Valid values are the following:

      PENDING

      The action is waiting for its scheduled time.

      COMPLETED

      Elemental Inference applied all the action's operations to the feed.

      FAILED

      Elemental Inference couldn't apply the action.

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

      Returns:
      The status of the action. Valid values are the following:

      PENDING

      The action is waiting for its scheduled time.

      COMPLETED

      Elemental Inference applied all the action's operations to the feed.

      FAILED

      Elemental Inference couldn't apply the action.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the action. Valid values are the following:

      PENDING

      The action is waiting for its scheduled time.

      COMPLETED

      Elemental Inference applied all the action's operations to the feed.

      FAILED

      Elemental Inference couldn't apply the action.

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

      Returns:
      The status of the action. Valid values are the following:

      PENDING

      The action is waiting for its scheduled time.

      COMPLETED

      Elemental Inference applied all the action's operations to the feed.

      FAILED

      Elemental Inference couldn't apply the action.

      See Also:

    • error

      public final ScheduleActionError error()

      A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

      Returns:
      A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

    • toBuilder

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

    • builder

      public static ScheduleAction.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.