software.amazon.awssdk.services.acm.model

Class Filters

java.lang.Object

software.amazon.awssdk.services.acm.model.Filters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Filters.Builder,Filters>

@Generated(value="software.amazon.awssdk:codegen")
public final class Filters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Filters.Builder,Filters>

This structure can be used in the ListCertificates action to filter the output of the certificate list.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Filters.Builder

Method Summary

Modifier and Type	Method and Description
static Filters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<ExtendedKeyUsageName>	extendedKeyUsage() Specify one or more ExtendedKeyUsage extension values.
List<String>	extendedKeyUsageAsStrings() Specify one or more ExtendedKeyUsage extension values.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExtendedKeyUsage() For responses, this returns true if the service returned a value for the ExtendedKeyUsage property.
int	hashCode()
boolean	hasKeyTypes() For responses, this returns true if the service returned a value for the KeyTypes property.
boolean	hasKeyUsage() For responses, this returns true if the service returned a value for the KeyUsage property.
List<KeyAlgorithm>	keyTypes() Specify one or more algorithms that can be used to generate key pairs.
List<String>	keyTypesAsStrings() Specify one or more algorithms that can be used to generate key pairs.
List<KeyUsageName>	keyUsage() Specify one or more KeyUsage extension values.
List<String>	keyUsageAsStrings() Specify one or more KeyUsage extension values.
List<SdkField<?>>	sdkFields()
static Class<? extends Filters.Builder>	serializableBuilderClass()
Filters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

extendedKeyUsage

public final List<ExtendedKeyUsageName> extendedKeyUsage()

Specify one or more ExtendedKeyUsage extension values.

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

Returns:

Specify one or more ExtendedKeyUsage extension values.

hasExtendedKeyUsage

public final boolean hasExtendedKeyUsage()

For responses, this returns true if the service returned a value for the ExtendedKeyUsage 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.

extendedKeyUsageAsStrings

public final List<String> extendedKeyUsageAsStrings()

Specify one or more ExtendedKeyUsage extension values.

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

Returns:

Specify one or more ExtendedKeyUsage extension values.

keyUsage

public final List<KeyUsageName> keyUsage()

Specify one or more KeyUsage extension values.

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

Returns:

Specify one or more KeyUsage extension values.

hasKeyUsage

public final boolean hasKeyUsage()

For responses, this returns true if the service returned a value for the KeyUsage 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.

keyUsageAsStrings

public final List<String> keyUsageAsStrings()

Specify one or more KeyUsage extension values.

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

Returns:

Specify one or more KeyUsage extension values.

keyTypes

public final List<KeyAlgorithm> keyTypes()

Specify one or more algorithms that can be used to generate key pairs.

Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

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

Returns:

Specify one or more algorithms that can be used to generate key pairs.

Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

hasKeyTypes

public final boolean hasKeyTypes()

For responses, this returns true if the service returned a value for the KeyTypes 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.

keyTypesAsStrings

public final List<String> keyTypesAsStrings()

Specify one or more algorithms that can be used to generate key pairs.

Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

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

Returns:

Specify one or more algorithms that can be used to generate key pairs.

Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.

toBuilder

public Filters.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<Filters.Builder,Filters>

Returns:

a builder for type T

builder

public static Filters.Builder builder()

serializableBuilderClass

public static Class<? extends Filters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.