Package software.amazon.awssdk.services.cloudwatchlogs.model

Class SubscriptionFilter

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.SubscriptionFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SubscriptionFilter.Builder,SubscriptionFilter>

@Generated("software.amazon.awssdk:codegen")
public final class SubscriptionFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SubscriptionFilter.Builder,SubscriptionFilter>

Represents a subscription filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SubscriptionFilter.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	applyOnTransformedLogs()	This parameter is valid only for log groups that have an active log transformer.
static SubscriptionFilter.Builder	builder()
Long	creationTime()	The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
String	destinationArn()	The Amazon Resource Name (ARN) of the destination.
Distribution	distribution()	Returns the value of the Distribution property for this object.
String	distributionAsString()	Returns the value of the Distribution property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterName()	The name of the subscription filter.
String	filterPattern()	Returns the value of the FilterPattern property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logGroupName()	The name of the log group.
String	roleArn()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SubscriptionFilter.Builder>	serializableBuilderClass()
SubscriptionFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

filterName

public final String filterName()

The name of the subscription filter.

Returns:

The name of the subscription filter.

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

filterPattern

public final String filterPattern()

Returns the value of the FilterPattern property for this object.

Returns:

The value of the FilterPattern property for this object.

destinationArn

public final String destinationArn()

The Amazon Resource Name (ARN) of the destination.

Returns:

The Amazon Resource Name (ARN) of the destination.

roleArn

public final String roleArn()

Returns:

distribution

public final Distribution distribution()

Returns the value of the Distribution property for this object.

If the service returns an enum value that is not available in the current SDK version, distribution will return Distribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionAsString().

Returns:

The value of the Distribution property for this object.

See Also:

Distribution

distributionAsString

public final String distributionAsString()

Returns the value of the Distribution property for this object.

If the service returns an enum value that is not available in the current SDK version, distribution will return Distribution.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distributionAsString().

Returns:

The value of the Distribution property for this object.

See Also:

Distribution

applyOnTransformedLogs

public final Boolean applyOnTransformedLogs()

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

If this value is true, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

Returns:

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

If this value is true, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

creationTime

public final Long creationTime()

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

toBuilder

public SubscriptionFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SubscriptionFilter.Builder,SubscriptionFilter>

builder

public static SubscriptionFilter.Builder builder()

serializableBuilderClass

public static Class<? extends SubscriptionFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo