Class MetricsFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The access point ARN used when evaluating a metrics filter.final MetricsAndOperator
and()
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.static MetricsFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static MetricsFilter
fromAccessPointArn
(String accessPointArn) Create an instance of this class withaccessPointArn()
initialized to the given value.static MetricsFilter
Create an instance of this class withand()
initialized to the given value.static MetricsFilter
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
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 used when evaluating a metrics filter.static Class
<? extends MetricsFilter.Builder> final Tag
tag()
The tag used when evaluating a metrics 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 used when evaluating a metrics filter.
- Returns:
- The prefix used when evaluating a metrics filter.
-
tag
The tag used when evaluating a metrics filter.
- Returns:
- The tag used when evaluating a metrics filter.
-
accessPointArn
The access point ARN used when evaluating a metrics filter.
- Returns:
- The access point ARN used when evaluating a metrics filter.
-
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
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<MetricsFilter.Builder,
MetricsFilter> - 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 used when evaluating a metrics filter.
- Parameters:
prefix
- The prefix used when evaluating a metrics filter.
-
fromTag
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
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
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
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
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
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. -
sdkFields
-