Package software.amazon.awssdk.services.connectcases.model

Class AuditEvent

java.lang.Object

software.amazon.awssdk.services.connectcases.model.AuditEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuditEvent.Builder,AuditEvent>

@Generated("software.amazon.awssdk:codegen")
public final class AuditEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuditEvent.Builder,AuditEvent>

Represents the content of a particular audit event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuditEvent.Builder

Method Summary

Modifier and Type	Method	Description
static AuditEvent.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventId()	Unique identifier of a case audit history event.
List<AuditEventField>	fields()	A list of Case Audit History event fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
AuditEventPerformedBy	performedBy()	Information of the user which performed the audit.
Instant	performedTime()	Time at which an Audit History event took place.
RelatedItemType	relatedItemType()	The Type of the related item.
String	relatedItemTypeAsString()	The Type of the related item.
List<SdkField<?>>	sdkFields()
static Class<? extends AuditEvent.Builder>	serializableBuilderClass()
AuditEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
AuditEventType	type()	The Type of an audit history event.
String	typeAsString()	The Type of an audit history event.

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

eventId

public final String eventId()

Unique identifier of a case audit history event.

Returns:

Unique identifier of a case audit history event.

hasFields

public final boolean hasFields()

For responses, this returns true if the service returned a value for the Fields 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.

fields

public final List<AuditEventField> fields()

A list of Case Audit History event fields.

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

Returns:

A list of Case Audit History event fields.

performedBy

public final AuditEventPerformedBy performedBy()

Information of the user which performed the audit.

Returns:

Information of the user which performed the audit.

performedTime

public final Instant performedTime()

Time at which an Audit History event took place.

Returns:

Time at which an Audit History event took place.

relatedItemType

public final RelatedItemType relatedItemType()

The Type of the related item.

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

Returns:

The Type of the related item.

See Also:

RelatedItemType

relatedItemTypeAsString

public final String relatedItemTypeAsString()

The Type of the related item.

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

Returns:

The Type of the related item.

See Also:

RelatedItemType

type

public final AuditEventType type()

The Type of an audit history event.

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

Returns:

The Type of an audit history event.

See Also:

AuditEventType

typeAsString

public final String typeAsString()

The Type of an audit history event.

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

Returns:

The Type of an audit history event.

See Also:

AuditEventType

toBuilder

public AuditEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuditEvent.Builder,AuditEvent>

builder

public static AuditEvent.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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