@Generated(value="software.amazon.awssdk:codegen") public final class MetricsFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricsFilter.Builder,MetricsFilter>
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricsFilter.Builder |
static class |
MetricsFilter.Type |
Modifier and Type | Method and Description |
---|---|
String |
accessPointArn()
The access point ARN used when evaluating a metrics filter.
|
MetricsAndOperator |
and()
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.
|
static MetricsFilter.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
static MetricsFilter |
fromAccessPointArn(String accessPointArn)
Create an instance of this class with
accessPointArn() initialized to the given value. |
static MetricsFilter |
fromAnd(Consumer<MetricsAndOperator.Builder> and)
Create an instance of this class with
and() initialized to the given value. |
static MetricsFilter |
fromAnd(MetricsAndOperator and)
Create an instance of this class with
and() initialized to the given value. |
static MetricsFilter |
fromPrefix(String prefix)
Create an instance of this class with
prefix() initialized to the given value. |
static MetricsFilter |
fromTag(Consumer<Tag.Builder> tag)
Create an instance of this class with
tag() initialized to the given value. |
static MetricsFilter |
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 used when evaluating a metrics filter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MetricsFilter.Builder> |
serializableBuilderClass() |
Tag |
tag()
The tag used when evaluating a metrics filter.
|
MetricsFilter.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
MetricsFilter.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 used when evaluating a metrics filter.
public final Tag tag()
The tag used when evaluating a metrics filter.
public final String accessPointArn()
The access point ARN used when evaluating a metrics filter.
public final MetricsAndOperator and()
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
public MetricsFilter.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricsFilter.Builder,MetricsFilter>
public static MetricsFilter.Builder builder()
public static Class<? extends MetricsFilter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public static MetricsFilter fromPrefix(String prefix)
prefix()
initialized to the given value.
The prefix used when evaluating a metrics filter.
prefix
- The prefix used when evaluating a metrics filter.public static MetricsFilter fromTag(Tag tag)
tag()
initialized to the given value.
The tag used when evaluating a metrics filter.
tag
- The tag used when evaluating a metrics filter.public static MetricsFilter fromTag(Consumer<Tag.Builder> tag)
tag()
initialized to the given value.
The tag used when evaluating a metrics filter.
tag
- The tag used when evaluating a metrics filter.public static MetricsFilter fromAccessPointArn(String accessPointArn)
accessPointArn()
initialized to the given value.
The access point ARN used when evaluating a metrics filter.
accessPointArn
- The access point ARN used when evaluating a metrics filter.public static MetricsFilter fromAnd(MetricsAndOperator and)
and()
initialized to the given value.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
and
- A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must
have at least two predicates, and an object must match all of the predicates in order for the filter to
apply.public static MetricsFilter fromAnd(Consumer<MetricsAndOperator.Builder> and)
and()
initialized to the given value.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
and
- A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must
have at least two predicates, and an object must match all of the predicates in order for the filter to
apply.public MetricsFilter.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.