@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
AnalyticsFilter.Builder |
static class |
AnalyticsFilter.Type |
Modifier and Type | Method and 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(AnalyticsAndOperator and)
Create an instance of this class with
and() initialized to the given value. |
static AnalyticsFilter |
fromAnd(Consumer<AnalyticsAndOperator.Builder> 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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String prefix()
The prefix to use when evaluating an analytics filter.
public final Tag tag()
The tag to use when evaluating an analytics filter.
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.
public AnalyticsFilter.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AnalyticsFilter.Builder,AnalyticsFilter>
public static AnalyticsFilter.Builder builder()
public static Class<? extends AnalyticsFilter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public static AnalyticsFilter fromPrefix(String prefix)
prefix()
initialized to the given value.
The prefix to use when evaluating an analytics filter.
prefix
- The prefix to use when evaluating an analytics filter.public static AnalyticsFilter fromTag(Tag tag)
tag()
initialized to the given value.
The tag to use when evaluating an analytics filter.
tag
- The tag to use when evaluating an analytics filter.public static AnalyticsFilter fromTag(Consumer<Tag.Builder> tag)
tag()
initialized to the given value.
The tag to use when evaluating an analytics filter.
tag
- The tag to use when evaluating an analytics filter.public static AnalyticsFilter fromAnd(AnalyticsAndOperator and)
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.
and
- A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator
must have at least two predicates.public static AnalyticsFilter fromAnd(Consumer<AnalyticsAndOperator.Builder> and)
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.
and
- A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator
must have at least two predicates.public AnalyticsFilter.Type type()
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 Type.UNKNOWN_TO_SDK_VERSION
if zero
members are set, and null
if more than one member is set.Copyright © 2023. All rights reserved.