Package software.amazon.awssdk.services.lightsail.model

Class GetCertificatesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.GetCertificatesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCertificatesRequest.Builder,GetCertificatesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetCertificatesRequest
extends LightsailRequest
implements ToCopyableBuilder<GetCertificatesRequest.Builder,GetCertificatesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCertificatesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetCertificatesRequest.Builder	builder()
String	certificateName()	The name for the certificate for which to return information.
List<CertificateStatus>	certificateStatuses()	The status of the certificates for which to return information.
List<String>	certificateStatusesAsStrings()	The status of the certificates for which to return information.
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()
Boolean	includeCertificateDetails()	Indicates whether to include detailed information about the certificates in the response.
String	pageToken()	The token to advance to the next page of results from your request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCertificatesRequest.Builder>	serializableBuilderClass()
GetCertificatesRequest.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()

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

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:

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

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()

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

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:

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made, regardless of their current status.

includeCertificateDetails

public final Boolean includeCertificateDetails()

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Returns:

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

certificateName

public final String certificateName()

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

Returns:

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the Amazon Web Services Region where the request is made.

pageToken

public final String pageToken()

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

toBuilder

public GetCertificatesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCertificatesRequest.Builder,GetCertificatesRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static GetCertificatesRequest.Builder builder()

serializableBuilderClass

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