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

Class SnapshotFilter

java.lang.Object

software.amazon.awssdk.services.fsx.model.SnapshotFilter

All Implemented Interfaces:

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

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

A filter used to restrict the results of DescribeSnapshots calls. 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	SnapshotFilter.Builder

Method Summary

Modifier and Type	Method	Description
static SnapshotFilter.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.
SnapshotFilterName	name()	The name of the filter to use.
String	nameAsString()	The name of the filter to use.
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotFilter.Builder>	serializableBuilderClass()
SnapshotFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The file-system-id or volume-id that you are filtering for.

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 SnapshotFilterName name()

The name of the filter to use. You can filter by the file-system-id or by volume-id.

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

Returns:

The name of the filter to use. You can filter by the file-system-id or by volume-id.

See Also:

SnapshotFilterName

nameAsString

public final String nameAsString()

The name of the filter to use. You can filter by the file-system-id or by volume-id.

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

Returns:

The name of the filter to use. You can filter by the file-system-id or by volume-id.

See Also:

SnapshotFilterName

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 file-system-id or volume-id that you are filtering for.

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 file-system-id or volume-id that you are filtering for.

toBuilder

public SnapshotFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotFilter.Builder,SnapshotFilter>

builder

public static SnapshotFilter.Builder builder()

serializableBuilderClass

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