Class DescribeScheduledActionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.redshift.model.RedshiftRequest
software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScheduledActionsRequest extends RedshiftRequest implements ToCopyableBuilder<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>

  • Method Details

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scheduled action to retrieve.

      Returns:
      The name of the scheduled action to retrieve.

    • targetActionType

      public final ScheduledActionTypeValues targetActionType()

      The type of the scheduled actions to retrieve.

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

      Returns:
      The type of the scheduled actions to retrieve.
      See Also:

    • targetActionTypeAsString

      public final String targetActionTypeAsString()

      The type of the scheduled actions to retrieve.

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

      Returns:
      The type of the scheduled actions to retrieve.
      See Also:

    • startTime

      public final Instant startTime()

      The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

      Returns:
      The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

    • endTime

      public final Instant endTime()

      The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

      Returns:
      The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

    • active

      public final Boolean active()

      If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

      Returns:
      If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

    • hasFilters

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

    • filters

      public final List<ScheduledActionFilter> filters()

      List of scheduled action filters.

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

      Returns:
      List of scheduled action filters.

    • marker

      public final String marker()

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Returns:
      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • maxRecords

      public final Integer maxRecords()

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

      Returns:
      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • toBuilder

      public DescribeScheduledActionsRequest.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<DescribeScheduledActionsRequest.Builder,DescribeScheduledActionsRequest>
      Specified by:
      toBuilder in class RedshiftRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeScheduledActionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeScheduledActionsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.