s3/aws.sdk.kotlin.services.s3.model/MetricsFilter

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.

Inheritors

Types

AccessPointArn

data class AccessPointArn(val value: String) : MetricsFilter

The access point ARN used when evaluating a metrics filter.

And

data class And(val value: MetricsAndOperator) : MetricsFilter

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.

Prefix

data class Prefix(val value: String) : MetricsFilter

The prefix used when evaluating a metrics filter.

SdkUnknown

object SdkUnknown : MetricsFilter

Tag

data class Tag(val value: Tag) : MetricsFilter

The tag used when evaluating a metrics filter.

Functions

asAccessPointArn

fun asAccessPointArn(): String

Casts this MetricsFilter as a AccessPointArn and retrieves its kotlin.String value. Throws an exception if the MetricsFilter is not a AccessPointArn.

asAccessPointArnOrNull

fun asAccessPointArnOrNull(): String?

Casts this MetricsFilter as a AccessPointArn and retrieves its kotlin.String value. Returns null if the MetricsFilter is not a AccessPointArn.

asAnd

fun asAnd(): MetricsAndOperator

Casts this MetricsFilter as a And and retrieves its aws.sdk.kotlin.services.s3.model.MetricsAndOperator value. Throws an exception if the MetricsFilter is not a And.

asAndOrNull

fun asAndOrNull(): MetricsAndOperator?

Casts this MetricsFilter as a And and retrieves its aws.sdk.kotlin.services.s3.model.MetricsAndOperator value. Returns null if the MetricsFilter is not a And.

asPrefix

fun asPrefix(): String

Casts this MetricsFilter as a Prefix and retrieves its kotlin.String value. Throws an exception if the MetricsFilter is not a Prefix.

asPrefixOrNull

fun asPrefixOrNull(): String?

Casts this MetricsFilter as a Prefix and retrieves its kotlin.String value. Returns null if the MetricsFilter is not a Prefix.

asTag

fun asTag(): Tag

Casts this MetricsFilter as a Tag and retrieves its aws.sdk.kotlin.services.s3.model.Tag value. Throws an exception if the MetricsFilter is not a Tag.

asTagOrNull

fun asTagOrNull(): Tag?

Casts this MetricsFilter as a Tag and retrieves its aws.sdk.kotlin.services.s3.model.Tag value. Returns null if the MetricsFilter is not a Tag.