software.amazon.awssdk.services.sfn.model

Class LoggingConfiguration

java.lang.Object

software.amazon.awssdk.services.sfn.model.LoggingConfiguration

All Implemented Interfaces:

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

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

The LoggingConfiguration data type is used to set CloudWatch Logs options.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LoggingConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static LoggingConfiguration.Builder	builder()
List<LogDestination>	destinations() An array of objects that describes where your execution history events will be logged.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations() Returns true if the Destinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Boolean	includeExecutionData() Determines whether execution data is included in your log.
LogLevel	level() Defines which category of execution history events are logged.
String	levelAsString() Defines which category of execution history events are logged.
List<SdkField<?>>	sdkFields()
static Class<? extends LoggingConfiguration.Builder>	serializableBuilderClass()
LoggingConfiguration.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

level

public LogLevel level()

Defines which category of execution history events are logged.

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

Returns:

Defines which category of execution history events are logged.

See Also:

LogLevel

levelAsString

public String levelAsString()

Defines which category of execution history events are logged.

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

Returns:

Defines which category of execution history events are logged.

See Also:

LogLevel

includeExecutionData

public Boolean includeExecutionData()

Determines whether execution data is included in your log. When set to FALSE, data is excluded.

Returns:

Determines whether execution data is included in your log. When set to FALSE, data is excluded.

hasDestinations

public boolean hasDestinations()

Returns true if the Destinations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

destinations

public List<LogDestination> destinations()

An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDestinations() to see if a value was sent in this field.

Returns:

An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.

toBuilder

public LoggingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>

builder

public static LoggingConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo