Class LoggingConfiguration

java.lang.Object
software.amazon.awssdk.services.sfn.model.LoggingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LoggingConfiguration.Builder,LoggingConfiguration>
@Generated("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:

  • Method Details

    • level

      public final 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:

    • levelAsString

      public final 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:

    • includeExecutionData

      public final 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 final boolean hasDestinations()
      For responses, this returns true if the service returned a value for the Destinations 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.

    • destinations

      public final 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.

      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 hasDestinations() method.

      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()
      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<LoggingConfiguration.Builder,LoggingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static LoggingConfiguration.Builder builder()

    • serializableBuilderClass

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