Package software.amazon.awssdk.services.fsx.model

Class VolumeFilter

java.lang.Object

software.amazon.awssdk.services.fsx.model.VolumeFilter

All Implemented Interfaces:

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

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

A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VolumeFilter.Builder

Method Summary

Modifier and Type	Method	Description
static VolumeFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
VolumeFilterName	name()	The name for this filter.
String	nameAsString()	The name for this filter.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VolumeFilter.Builder>	serializableBuilderClass()
VolumeFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The values of the filter.

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

name

public final VolumeFilterName name()

The name for this filter.

If the service returns an enum value that is not available in the current SDK version, name will return VolumeFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name for this filter.

See Also:

VolumeFilterName

nameAsString

public final String nameAsString()

The name for this filter.

If the service returns an enum value that is not available in the current SDK version, name will return VolumeFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name for this filter.

See Also:

VolumeFilterName

hasValues

public final boolean hasValues()

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

values

public final List<String> values()

The values of the filter. These are all the values for any of the applied filters.

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

Returns:

The values of the filter. These are all the values for any of the applied filters.

toBuilder

public VolumeFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VolumeFilter.Builder,VolumeFilter>

builder

public static VolumeFilter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo