Package software.amazon.awssdk.services.datasync.model

Class FilterRule

java.lang.Object

software.amazon.awssdk.services.datasync.model.FilterRule

All Implemented Interfaces:

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

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

Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterRule.Builder

Method Summary

Modifier and Type	Method	Description
static FilterRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilterType	filterType()	The type of filter rule to apply.
String	filterTypeAsString()	The type of filter rule to apply.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends FilterRule.Builder>	serializableBuilderClass()
FilterRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	A single filter string that consists of the patterns to include or exclude.

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

filterType

public final FilterType filterType()

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

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

Returns:

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

See Also:

FilterType

filterTypeAsString

public final String filterTypeAsString()

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

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

Returns:

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

See Also:

FilterType

value

public final String value()

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Returns:

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

toBuilder

public FilterRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilterRule.Builder,FilterRule>

builder

public static FilterRule.Builder builder()

serializableBuilderClass

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