Package software.amazon.awssdk.services.iotevents.model

Class LoggingOptions

java.lang.Object

software.amazon.awssdk.services.iotevents.model.LoggingOptions

All Implemented Interfaces:

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

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

The values of the AWS IoT Events logging options.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoggingOptions.Builder

Method Summary

Modifier and Type	Method	Description
static LoggingOptions.Builder	builder()
List<DetectorDebugOption>	detectorDebugOptions()	Information that identifies those detector models and their detectors (instances) for which the logging level is given.
Boolean	enabled()	If TRUE, logging is enabled for AWS IoT Events.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetectorDebugOptions()	For responses, this returns true if the service returned a value for the DetectorDebugOptions property.
int	hashCode()
LoggingLevel	level()	The logging level.
String	levelAsString()	The logging level.
String	roleArn()	The ARN of the role that grants permission to AWS IoT Events to perform logging.
List<SdkField<?>>	sdkFields()
static Class<? extends LoggingOptions.Builder>	serializableBuilderClass()
LoggingOptions.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

roleArn

public final String roleArn()

The ARN of the role that grants permission to AWS IoT Events to perform logging.

Returns:

The ARN of the role that grants permission to AWS IoT Events to perform logging.

level

public final LoggingLevel level()

The logging level.

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

Returns:

The logging level.

See Also:

LoggingLevel

levelAsString

public final String levelAsString()

The logging level.

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

Returns:

The logging level.

See Also:

LoggingLevel

enabled

public final Boolean enabled()

If TRUE, logging is enabled for AWS IoT Events.

Returns:

If TRUE, logging is enabled for AWS IoT Events.

hasDetectorDebugOptions

public final boolean hasDetectorDebugOptions()

For responses, this returns true if the service returned a value for the DetectorDebugOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

detectorDebugOptions

public final List<DetectorDebugOption> detectorDebugOptions()

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDetectorDebugOptions() method.

Returns:

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

toBuilder

public LoggingOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoggingOptions.Builder,LoggingOptions>

builder

public static LoggingOptions.Builder builder()

serializableBuilderClass

public static Class<? extends LoggingOptions.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