Class ListSchedulesRequest

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

  • Method Details

    • groupName

      public final String groupName()

      If specified, only lists the schedules whose associated schedule group matches the given filter.

      Returns:
      If specified, only lists the schedules whose associated schedule group matches the given filter.

    • maxResults

      public final Integer maxResults()

      If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

      Returns:
      If specified, limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

    • namePrefix

      public final String namePrefix()

      Schedule name prefix to return the filtered list of resources.

      Returns:
      Schedule name prefix to return the filtered list of resources.

    • nextToken

      public final String nextToken()

      The token returned by a previous call to retrieve the next set of results.

      Returns:
      The token returned by a previous call to retrieve the next set of results.

    • state

      public final ScheduleState state()

      If specified, only lists the schedules whose current state matches the given filter.

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

      Returns:
      If specified, only lists the schedules whose current state matches the given filter.
      See Also:

    • stateAsString

      public final String stateAsString()

      If specified, only lists the schedules whose current state matches the given filter.

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

      Returns:
      If specified, only lists the schedules whose current state matches the given filter.
      See Also:

    • toBuilder

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

    • builder

      public static ListSchedulesRequest.Builder builder()

    • serializableBuilderClass

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