Class AnalyticsFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnalyticsAndOperator
and()
A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter.static AnalyticsFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static AnalyticsFilter
Create an instance of this class withand()
initialized to the given value.static AnalyticsFilter
Create an instance of this class withand()
initialized to the given value.static AnalyticsFilter
fromPrefix
(String prefix) Create an instance of this class withprefix()
initialized to the given value.static AnalyticsFilter
fromTag
(Consumer<Tag.Builder> tag) Create an instance of this class withtag()
initialized to the given value.static AnalyticsFilter
Create an instance of this class withtag()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
prefix()
The prefix to use when evaluating an analytics filter.static Class
<? extends AnalyticsFilter.Builder> final Tag
tag()
The tag to use when evaluating an analytics filter.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
prefix
The prefix to use when evaluating an analytics filter.
- Returns:
- The prefix to use when evaluating an analytics filter.
-
tag
The tag to use when evaluating an analytics filter.
- Returns:
- The tag to use when evaluating an analytics filter.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AnalyticsFilter.Builder,
AnalyticsFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromPrefix
Create an instance of this class withprefix()
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
Create an instance of this class withtag()
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
Create an instance of this class withtag()
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
Create an instance of this class withand()
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
Create an instance of this class withand()
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
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beAnalyticsFilter.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 beAnalyticsFilter.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-