Package software.amazon.awssdk.services.acm.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCertificatesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCertificatesRequest.Builder	builder()
List<CertificateStatus>	certificateStatuses()	Filter the certificate list by status value.
List<String>	certificateStatusesAsStrings()	Filter the certificate list by status value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCertificateStatuses()	For responses, this returns true if the service returned a value for the CertificateStatuses property.
int	hashCode()
Filters	includes()	Filter the certificate list.
Integer	maxItems()	Use this parameter when paginating results to specify the maximum number of items to return in the response.
String	nextToken()	Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCertificatesRequest.Builder>	serializableBuilderClass()
SortBy	sortBy()	Specifies the field to sort results by.
String	sortByAsString()	Specifies the field to sort results by.
SortOrder	sortOrder()	Specifies the order of sorted results.
String	sortOrderAsString()	Specifies the order of sorted results.
ListCertificatesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SortBy

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:

SortBy

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:

SortOrder

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:

SortOrder

toBuilder

public ListCertificatesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCertificatesRequest.Builder,ListCertificatesRequest>

Specified by:

toBuilder in class AcmRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo