software.amazon.awssdk.services.shield.model

Class InclusionProtectionGroupFilters

java.lang.Object

software.amazon.awssdk.services.shield.model.InclusionProtectionGroupFilters

All Implemented Interfaces:

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

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

Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InclusionProtectionGroupFilters.Builder

Method Summary

Modifier and Type	Method and Description
List<ProtectionGroupAggregation>	aggregations() The aggregation setting of the protection groups that you want to retrieve.
List<String>	aggregationsAsStrings() The aggregation setting of the protection groups that you want to retrieve.
static InclusionProtectionGroupFilters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAggregations() For responses, this returns true if the service returned a value for the Aggregations property.
int	hashCode()
boolean	hasPatterns() For responses, this returns true if the service returned a value for the Patterns property.
boolean	hasProtectionGroupIds() For responses, this returns true if the service returned a value for the ProtectionGroupIds property.
boolean	hasResourceTypes() For responses, this returns true if the service returned a value for the ResourceTypes property.
List<ProtectionGroupPattern>	patterns() The pattern specification of the protection groups that you want to retrieve.
List<String>	patternsAsStrings() The pattern specification of the protection groups that you want to retrieve.
List<String>	protectionGroupIds() The ID of the protection group that you want to retrieve.
List<ProtectedResourceType>	resourceTypes() The resource type configuration of the protection groups that you want to retrieve.
List<String>	resourceTypesAsStrings() The resource type configuration of the protection groups that you want to retrieve.
List<SdkField<?>>	sdkFields()
static Class<? extends InclusionProtectionGroupFilters.Builder>	serializableBuilderClass()
InclusionProtectionGroupFilters.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

hasProtectionGroupIds

public final boolean hasProtectionGroupIds()

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

protectionGroupIds

public final List<String> protectionGroupIds()

The ID of the protection group 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 hasProtectionGroupIds() method.

Returns:

The ID of the protection group that you want to retrieve.

patterns

public final List<ProtectionGroupPattern> patterns()

The pattern specification of the protection groups 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 hasPatterns() method.

Returns:

The pattern specification of the protection groups that you want to retrieve.

hasPatterns

public final boolean hasPatterns()

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

patternsAsStrings

public final List<String> patternsAsStrings()

The pattern specification of the protection groups 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 hasPatterns() method.

Returns:

The pattern specification of the protection groups that you want to retrieve.

resourceTypes

public final List<ProtectedResourceType> resourceTypes()

The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.

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 resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.

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 resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.

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 resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE.

aggregations

public final List<ProtectionGroupAggregation> aggregations()

The aggregation setting of the protection groups 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 hasAggregations() method.

Returns:

The aggregation setting of the protection groups that you want to retrieve.

hasAggregations

public final boolean hasAggregations()

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

aggregationsAsStrings

public final List<String> aggregationsAsStrings()

The aggregation setting of the protection groups 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 hasAggregations() method.

Returns:

The aggregation setting of the protection groups that you want to retrieve.

toBuilder

public InclusionProtectionGroupFilters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InclusionProtectionGroupFilters.Builder,InclusionProtectionGroupFilters>

builder

public static InclusionProtectionGroupFilters.Builder builder()

serializableBuilderClass

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