Class MetricsFilter
- java.lang.Object
-
- software.amazon.awssdk.services.s3.model.MetricsFilter
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricsFilter.Builder,MetricsFilter>
@Generated("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.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MetricsFilter.Builder
static class
MetricsFilter.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 withaccessPointArn()
initialized to the given value.static MetricsFilter
fromAnd(Consumer<MetricsAndOperator.Builder> and)
Create an instance of this class withand()
initialized to the given value.static MetricsFilter
fromAnd(MetricsAndOperator and)
Create an instance of this class withand()
initialized to the given value.static MetricsFilter
fromPrefix(String prefix)
Create an instance of this class withprefix()
initialized to the given value.static MetricsFilter
fromTag(Consumer<Tag.Builder> tag)
Create an instance of this class withtag()
initialized to the given value.static MetricsFilter
fromTag(Tag tag)
Create an instance of this class withtag()
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.-
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 used when evaluating a metrics filter.
- Returns:
- The prefix used when evaluating a metrics filter.
-
tag
public final Tag tag()
The tag used when evaluating a metrics filter.
- Returns:
- The tag used when evaluating a metrics filter.
-
accessPointArn
public final String accessPointArn()
The access point ARN used when evaluating a metrics filter.
- Returns:
- The access point ARN used when evaluating a metrics filter.
-
and
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.
- Returns:
- 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.
-
toBuilder
public MetricsFilter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<MetricsFilter.Builder,MetricsFilter>
-
builder
public static MetricsFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends MetricsFilter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
fromPrefix
public static MetricsFilter fromPrefix(String prefix)
Create an instance of this class withprefix()
initialized to the given value.The prefix used when evaluating a metrics filter.
- Parameters:
prefix
- The prefix used when evaluating a metrics filter.
-
fromTag
public static MetricsFilter fromTag(Tag tag)
Create an instance of this class withtag()
initialized to the given value.The tag used when evaluating a metrics filter.
- Parameters:
tag
- The tag used when evaluating a metrics filter.
-
fromTag
public static MetricsFilter fromTag(Consumer<Tag.Builder> tag)
Create an instance of this class withtag()
initialized to the given value.The tag used when evaluating a metrics filter.
- Parameters:
tag
- The tag used when evaluating a metrics filter.
-
fromAccessPointArn
public static MetricsFilter fromAccessPointArn(String accessPointArn)
Create an instance of this class withaccessPointArn()
initialized to the given value.The access point ARN used when evaluating a metrics filter.
- Parameters:
accessPointArn
- The access point ARN used when evaluating a metrics filter.
-
fromAnd
public static MetricsFilter fromAnd(MetricsAndOperator and)
Create an instance of this class withand()
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.
- Parameters:
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.
-
fromAnd
public static MetricsFilter fromAnd(Consumer<MetricsAndOperator.Builder> and)
Create an instance of this class withand()
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.
- Parameters:
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.
-
type
public MetricsFilter.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 beMetricsFilter.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 beMetricsFilter.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set.
-
-