Class ListCertificatesRequest

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

  • Method Details

    • certificateStatuses

      public final List<CertificateStatus> certificateStatuses()

      Filter the certificate list by status value.

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

      Returns:
      Filter the certificate list by status value.

    • hasCertificateStatuses

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

    • certificateStatusesAsStrings

      public final List<String> certificateStatusesAsStrings()

      Filter the certificate list by status value.

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

      Returns:
      Filter the certificate list by status value.

    • includes

      public final Filters includes()

      Filter the certificate list. For more information, see the Filters structure.

      Returns:
      Filter the certificate list. For more information, see the Filters structure.

    • nextToken

      public final String nextToken()

      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

      Returns:
      Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

    • maxItems

      public final Integer maxItems()

      Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

      Returns:
      Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

    • sortBy

      public final SortBy sortBy()

      Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

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

      Returns:
      Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.

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

      Returns:
      Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

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

      Returns:
      Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

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

      Returns:
      Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.
      See Also:

    • toBuilder

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

    • builder

      public static ListCertificatesRequest.Builder builder()

    • serializableBuilderClass

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