Class SessionCloudWatchLoggingConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SessionCloudWatchLoggingConfiguration.Builder,SessionCloudWatchLoggingConfiguration>
The CloudWatch Logs configuration for a session.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final Booleanenabled()Whether CloudWatch Logs is enabled for the session.final StringThe Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs.final booleanfinal booleanequalsBySdkFields(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 inthashCode()final booleanFor responses, this returns true if the service returned a value for the LogTypes property.final StringlogGroup()The name of the log group where session logs are published.final StringThe prefix applied to the log stream name where session logs are published.logTypes()A map of log component names (for example,SPARK_DRIVER,SPARK_EXECUTOR) to the list of log types to publish for that component (for example,stdout,stderr).static Class<? extends SessionCloudWatchLoggingConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
enabled
Whether CloudWatch Logs is enabled for the session.
- Returns:
- Whether CloudWatch Logs is enabled for the session.
-
logGroup
The name of the log group where session logs are published.
- Returns:
- The name of the log group where session logs are published.
-
logStreamNamePrefix
The prefix applied to the log stream name where session logs are published.
- Returns:
- The prefix applied to the log stream name where session logs are published.
-
encryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs.
- Returns:
- The Amazon Resource Name (ARN) of the KMS key used to encrypt the logs published to CloudWatch Logs.
-
hasLogTypes
public final boolean hasLogTypes()For responses, this returns true if the service returned a value for the LogTypes 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. -
logTypes
A map of log component names (for example,
SPARK_DRIVER,SPARK_EXECUTOR) to the list of log types to publish for that component (for example,stdout,stderr).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
hasLogTypes()method.- Returns:
- A map of log component names (for example,
SPARK_DRIVER,SPARK_EXECUTOR) to the list of log types to publish for that component (for example,stdout,stderr).
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<SessionCloudWatchLoggingConfiguration.Builder,SessionCloudWatchLoggingConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SessionCloudWatchLoggingConfiguration.Builder> serializableBuilderClass() -
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-