Class LoggingConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LoggingConfiguration.Builder,
LoggingConfiguration>
The LoggingConfiguration
data type is used to set CloudWatch Logs options.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LoggingConfiguration.Builder
builder()
final List
<LogDestination> An array of objects that describes where your execution history events will be logged.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 Destinations property.final int
hashCode()
final Boolean
Determines whether execution data is included in your log.final LogLevel
level()
Defines which category of execution history events are logged.final String
Defines which category of execution history events are logged.static Class
<? extends LoggingConfiguration.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
-
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 returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- Defines which category of execution history events are logged.
- See Also:
-
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 returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- Defines which category of execution history events are logged.
- See Also:
-
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 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. -
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
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<LoggingConfiguration.Builder,
LoggingConfiguration> - 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
-