Class LoggingOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LoggingOptions.Builder,
LoggingOptions>
The values of the AWS IoT Events logging options.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LoggingOptions.Builder
builder()
final List
<DetectorDebugOption> Information that identifies those detector models and their detectors (instances) for which the logging level is given.final Boolean
enabled()
If TRUE, logging is enabled for AWS IoT Events.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DetectorDebugOptions property.final int
hashCode()
final LoggingLevel
level()
The logging level.final String
The logging level.final String
roleArn()
The ARN of the role that grants permission to AWS IoT Events to perform logging.static Class
<? extends LoggingOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The logging level.
If the service returns an enum value that is not available in the current SDK version,
level
will returnLoggingLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- The logging level.
- See Also:
-
levelAsString
The logging level.
If the service returns an enum value that is not available in the current SDK version,
level
will returnLoggingLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- The logging level.
- See Also:
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LoggingOptions.Builder,
LoggingOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-