Class LogEventConfiguration

java.lang.Object
software.amazon.awssdk.services.iot.model.LogEventConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LogEventConfiguration.Builder,LogEventConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class LogEventConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LogEventConfiguration.Builder,LogEventConfiguration>

Configuration for event-based logging that specifies which event types to log and their logging settings. Used for account-level logging overrides.

See Also:

  • Method Details

    • eventType

      public final String eventType()

      The type of event to log. These include event types like Connect, Publish, and Disconnect.

      Returns:
      The type of event to log. These include event types like Connect, Publish, and Disconnect.

    • logLevel

      public final LogLevel logLevel()

      The logging level for the specified event type. Determines the verbosity of log messages generated for this event type.

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

      Returns:
      The logging level for the specified event type. Determines the verbosity of log messages generated for this event type.
      See Also:

    • logLevelAsString

      public final String logLevelAsString()

      The logging level for the specified event type. Determines the verbosity of log messages generated for this event type.

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

      Returns:
      The logging level for the specified event type. Determines the verbosity of log messages generated for this event type.
      See Also:

    • logDestination

      public final String logDestination()

      CloudWatch Log Group for event-based logging. Specifies where log events should be sent. The log destination for event-based logging overrides default Log Group for the specified event type and applies to all resources associated with that event.

      Returns:
      CloudWatch Log Group for event-based logging. Specifies where log events should be sent. The log destination for event-based logging overrides default Log Group for the specified event type and applies to all resources associated with that event.

    • toBuilder

      public LogEventConfiguration.Builder 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 interface ToCopyableBuilder<LogEventConfiguration.Builder,LogEventConfiguration>
      Returns:
      a builder for type T

    • builder

      public static LogEventConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LogEventConfiguration.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.