Class LoggingConfigurationSummary
- java.lang.Object
-
- software.amazon.awssdk.services.ivschat.model.LoggingConfigurationSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<LoggingConfigurationSummary.Builder,LoggingConfigurationSummary>
@Generated("software.amazon.awssdk:codegen") public final class LoggingConfigurationSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LoggingConfigurationSummary.Builder,LoggingConfigurationSummary>
Summary information about a logging configuration.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLoggingConfigurationSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()Logging-configuration ARN.static LoggingConfigurationSummary.Builderbuilder()InstantcreateTime()Time when the logging configuration was created.DestinationConfigurationdestinationConfiguration()A complex type that contains a destination configuration for where chat content will be logged.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()Logging-configuration ID, generated by the system.Stringname()Logging-configuration name.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends LoggingConfigurationSummary.Builder>serializableBuilderClass()LoggingConfigurationStatestate()The state of the logging configuration.StringstateAsString()The state of the logging configuration.Map<String,String>tags()Tags to attach to the resource.LoggingConfigurationSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdateTime()Time of the logging configuration’s last update.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final String arn()
Logging-configuration ARN.
- Returns:
- Logging-configuration ARN.
-
id
public final String id()
Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
- Returns:
- Logging-configuration ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
-
createTime
public final Instant createTime()
Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
- Returns:
- Time when the logging configuration was created. This is an ISO 8601 timestamp; note that this is returned as a string.
-
updateTime
public final Instant updateTime()
Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
- Returns:
- Time of the logging configuration’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
-
name
public final String name()
Logging-configuration name. The value does not need to be unique.
- Returns:
- Logging-configuration name. The value does not need to be unique.
-
destinationConfiguration
public final DestinationConfiguration destinationConfiguration()
A complex type that contains a destination configuration for where chat content will be logged.
- Returns:
- A complex type that contains a destination configuration for where chat content will be logged.
-
state
public final LoggingConfigurationState state()
The state of the logging configuration. When this is
ACTIVE, the configuration is ready for logging chat content.If the service returns an enum value that is not available in the current SDK version,
statewill returnLoggingConfigurationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the logging configuration. When this is
ACTIVE, the configuration is ready for logging chat content. - See Also:
LoggingConfigurationState
-
stateAsString
public final String stateAsString()
The state of the logging configuration. When this is
ACTIVE, the configuration is ready for logging chat content.If the service returns an enum value that is not available in the current SDK version,
statewill returnLoggingConfigurationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the logging configuration. When this is
ACTIVE, the configuration is ready for logging chat content. - See Also:
LoggingConfigurationState
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags 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.
-
tags
public final Map<String,String> tags()
Tags to attach to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.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
hasTags()method.- Returns:
- Tags to attach to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints on tags beyond what is documented there.
-
toBuilder
public LoggingConfigurationSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LoggingConfigurationSummary.Builder,LoggingConfigurationSummary>
-
builder
public static LoggingConfigurationSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends LoggingConfigurationSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-