Class GetCertificatesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCertificatesRequest.Builder,
GetCertificatesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name for the certificate for which to return information.final List
<CertificateStatus> The status of the certificates for which to return information.The status of the certificates for which to return information.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the CertificateStatuses property.final int
hashCode()
final Boolean
Indicates whether to include detailed information about the certificates in the response.final String
The token to advance to the next page of results from your request.static Class
<? extends GetCertificatesRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
certificateStatuses
The status of the certificates for which to return information.
For example, specify
ISSUED
to return only certificates with anISSUED
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 anISSUED
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 theisEmpty()
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
The status of the certificates for which to return information.
For example, specify
ISSUED
to return only certificates with anISSUED
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 anISSUED
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
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
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
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
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 interfaceToCopyableBuilder<GetCertificatesRequest.Builder,
GetCertificatesRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-