Class DescribeEventTypesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeEventTypesRequest.Builder,DescribeEventTypesRequest>

@Generated("software.amazon.awssdk:codegen") public final class DescribeEventTypesRequest extends HealthRequest implements ToCopyableBuilder<DescribeEventTypesRequest.Builder,DescribeEventTypesRequest>
  • Method Details

    • filter

      public final EventTypeFilter filter()

      Values to narrow the results returned.

      Returns:
      Values to narrow the results returned.
    • locale

      public final String locale()

      The locale (language) to return information in. English (en) is the default and the only supported value at this time.

      Returns:
      The locale (language) to return information in. English (en) is the default and the only supported value at this time.
    • nextToken

      public final String nextToken()

      If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

      Returns:
      If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
    • maxResults

      public final Integer maxResults()

      The maximum number of items to return in one batch, between 10 and 100, inclusive.

      If you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.

      Returns:
      The maximum number of items to return in one batch, between 10 and 100, inclusive.

      If you don't specify the maxResults parameter, this operation returns a maximum of 30 items by default.

    • 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<DescribeEventTypesRequest.Builder,DescribeEventTypesRequest>
      Specified by:
      toBuilder in class HealthRequest
      Returns:
      a builder for type T
    • builder

      public static DescribeEventTypesRequest.Builder builder()
    • serializableBuilderClass

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