Package software.amazon.awssdk.services.shield.model

Class InclusionProtectionFilters

java.lang.Object

software.amazon.awssdk.services.shield.model.InclusionProtectionFilters

All Implemented Interfaces:

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

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

Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InclusionProtectionFilters.Builder

Method Summary

Modifier and Type	Method	Description
static InclusionProtectionFilters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProtectionNames()	For responses, this returns true if the service returned a value for the ProtectionNames property.
boolean	hasResourceArns()	For responses, this returns true if the service returned a value for the ResourceArns property.
boolean	hasResourceTypes()	For responses, this returns true if the service returned a value for the ResourceTypes property.
List<String>	protectionNames()	The name of the protection that you want to retrieve.
List<String>	resourceArns()	The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.
List<ProtectedResourceType>	resourceTypes()	The type of protected resource whose protections you want to retrieve.
List<String>	resourceTypesAsStrings()	The type of protected resource whose protections you want to retrieve.
List<SdkField<?>>	sdkFields()
static Class<? extends InclusionProtectionFilters.Builder>	serializableBuilderClass()
InclusionProtectionFilters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasResourceArns

public final boolean hasResourceArns()

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

resourceArns

public final List<String> resourceArns()

The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.

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

Returns:

The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.

hasProtectionNames

public final boolean hasProtectionNames()

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

protectionNames

public final List<String> protectionNames()

The name of the protection that you want to retrieve.

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

Returns:

The name of the protection that you want to retrieve.

resourceTypes

public final List<ProtectedResourceType> resourceTypes()

The type of protected resource whose protections you want to retrieve.

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

Returns:

The type of protected resource whose protections you want to retrieve.

hasResourceTypes

public final boolean hasResourceTypes()

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

resourceTypesAsStrings

public final List<String> resourceTypesAsStrings()

The type of protected resource whose protections you want to retrieve.

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

Returns:

The type of protected resource whose protections you want to retrieve.

toBuilder

public InclusionProtectionFilters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InclusionProtectionFilters.Builder,InclusionProtectionFilters>

builder

public static InclusionProtectionFilters.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo