Class ListRulesRequest

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

  • Method Details

    • namePrefix

      public final String namePrefix()

      The prefix matching the rule name.

      Returns:
      The prefix matching the rule name.

    • eventBusName

      public final String eventBusName()

      The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

      Returns:
      The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

    • nextToken

      public final String nextToken()

      The token returned by a previous call, which you can use to retrieve the next set of results.

      The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

      Using an expired pagination token results in an HTTP 400 InvalidToken error.

      Returns:
      The token returned by a previous call, which you can use to retrieve the next set of results.

      The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

      Using an expired pagination token results in an HTTP 400 InvalidToken error.

    • limit

      public final Integer limit()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • toBuilder

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

    • builder

      public static ListRulesRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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