Class Logger

java.lang.Object
software.amazon.awssdk.services.greengrass.model.Logger
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Logger.Builder,Logger>
@Generated("software.amazon.awssdk:codegen") public final class Logger extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Logger.Builder,Logger>
Information about a logger
See Also:

  • Method Details

    • component

      public final LoggerComponent component()
      The component that will be subject to logging.

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

      Returns:
      The component that will be subject to logging.
      See Also:

    • componentAsString

      public final String componentAsString()
      The component that will be subject to logging.

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

      Returns:
      The component that will be subject to logging.
      See Also:

    • id

      public final String id()
      A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
      Returns:
      A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.

    • level

      public final LoggerLevel level()
      The level of the logs.

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

      Returns:
      The level of the logs.
      See Also:

    • levelAsString

      public final String levelAsString()
      The level of the logs.

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

      Returns:
      The level of the logs.
      See Also:

    • space

      public final Integer space()
      The amount of file space, in KB, to use if the local file system is used for logging purposes.
      Returns:
      The amount of file space, in KB, to use if the local file system is used for logging purposes.

    • type

      public final LoggerType type()
      The type of log output which will be used.

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

      Returns:
      The type of log output which will be used.
      See Also:

    • typeAsString

      public final String typeAsString()
      The type of log output which will be used.

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

      Returns:
      The type of log output which will be used.
      See Also:

    • toBuilder

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

    • builder

      public static Logger.Builder builder()

    • serializableBuilderClass

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