Package software.amazon.awssdk.services.s3.model

Class AnalyticsFilter

java.lang.Object

software.amazon.awssdk.services.s3.model.AnalyticsFilter

All Implemented Interfaces:

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

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

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalyticsFilter.Builder
static class	AnalyticsFilter.Type

Method Summary

Modifier and Type	Method	Description
AnalyticsAndOperator	and()	A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter.
static AnalyticsFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static AnalyticsFilter	fromAnd(Consumer<AnalyticsAndOperator.Builder> and)	Create an instance of this class with and() initialized to the given value.
static AnalyticsFilter	fromAnd(AnalyticsAndOperator and)	Create an instance of this class with and() initialized to the given value.
static AnalyticsFilter	fromPrefix(String prefix)	Create an instance of this class with prefix() initialized to the given value.
static AnalyticsFilter	fromTag(Consumer<Tag.Builder> tag)	Create an instance of this class with tag() initialized to the given value.
static AnalyticsFilter	fromTag(Tag tag)	Create an instance of this class with tag() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	prefix()	The prefix to use when evaluating an analytics filter.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalyticsFilter.Builder>	serializableBuilderClass()
Tag	tag()	The tag to use when evaluating an analytics filter.
AnalyticsFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AnalyticsFilter.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

prefix

public final String prefix()

The prefix to use when evaluating an analytics filter.

Returns:

The prefix to use when evaluating an analytics filter.

tag

public final Tag tag()

The tag to use when evaluating an analytics filter.

Returns:

The tag to use when evaluating an analytics filter.

and

public final AnalyticsAndOperator and()

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

Returns:

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

toBuilder

public AnalyticsFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalyticsFilter.Builder,AnalyticsFilter>

builder

public static AnalyticsFilter.Builder builder()

serializableBuilderClass

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

fromPrefix

public static AnalyticsFilter fromPrefix(String prefix)

Create an instance of this class with prefix() initialized to the given value.

The prefix to use when evaluating an analytics filter.

Parameters:

prefix - The prefix to use when evaluating an analytics filter.

fromTag

public static AnalyticsFilter fromTag(Tag tag)

Create an instance of this class with tag() initialized to the given value.

The tag to use when evaluating an analytics filter.

Parameters:

tag - The tag to use when evaluating an analytics filter.

fromTag

public static AnalyticsFilter fromTag(Consumer<Tag.Builder> tag)

Create an instance of this class with tag() initialized to the given value.

The tag to use when evaluating an analytics filter.

Parameters:

tag - The tag to use when evaluating an analytics filter.

fromAnd

public static AnalyticsFilter fromAnd(AnalyticsAndOperator and)

Create an instance of this class with and() initialized to the given value.

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

Parameters:

and - A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

fromAnd

public static AnalyticsFilter fromAnd(Consumer<AnalyticsAndOperator.Builder> and)

Create an instance of this class with and() initialized to the given value.

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

Parameters:

and - A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

type

public AnalyticsFilter.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be AnalyticsFilter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be AnalyticsFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo