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

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.

Inheritors

Types

And

data class And(val value: AnalyticsAndOperator) : AnalyticsFilter

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

Prefix

data class Prefix(val value: String) : AnalyticsFilter

The prefix to use when evaluating an analytics filter.

SdkUnknown

object SdkUnknown : AnalyticsFilter

Tag

data class Tag(val value: Tag) : AnalyticsFilter

The tag to use when evaluating an analytics filter.

Functions

asAnd

fun asAnd(): AnalyticsAndOperator

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

asAndOrNull

fun asAndOrNull(): AnalyticsAndOperator?

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

asPrefix

fun asPrefix(): String

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

asPrefixOrNull

fun asPrefixOrNull(): String?

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

asTag

fun asTag(): Tag

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

asTagOrNull

fun asTagOrNull(): Tag?

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