Package software.amazon.awssdk.services.notifications.model

Class SourceEventMetadata

java.lang.Object

software.amazon.awssdk.services.notifications.model.SourceEventMetadata

All Implemented Interfaces:

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

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

Describes the metadata for a source event.

For more information, see Event structure reference in the Amazon EventBridge User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceEventMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static SourceEventMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	eventOccurrenceTime()	The date and time the source event occurred.
String	eventOriginRegion()	The Region the event originated from.
String	eventType()	The type of event.
String	eventTypeVersion()	The version of the type of event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRelatedResources()	For responses, this returns true if the service returned a value for the RelatedResources property.
String	relatedAccount()	The primary Amazon Web Services account of SourceEvent.
List<Resource>	relatedResources()	A list of resources related to this NotificationEvent.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SourceEventMetadata.Builder>	serializableBuilderClass()
String	source()	The Amazon Web Services service the event originates from.
String	sourceEventId()	The source event id.
SourceEventMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

eventTypeVersion

public final String eventTypeVersion()

The version of the type of event.

Returns:

The version of the type of event.

sourceEventId

public final String sourceEventId()

The source event id.

Returns:

The source event id.

eventOriginRegion

public final String eventOriginRegion()

The Region the event originated from.

Returns:

The Region the event originated from.

relatedAccount

public final String relatedAccount()

The primary Amazon Web Services account of SourceEvent.

Returns:

The primary Amazon Web Services account of SourceEvent.

source

public final String source()

The Amazon Web Services service the event originates from. For example aws.cloudwatch.

Returns:

The Amazon Web Services service the event originates from. For example aws.cloudwatch.

eventOccurrenceTime

public final Instant eventOccurrenceTime()

The date and time the source event occurred. This is based on the Source Event.

Returns:

The date and time the source event occurred. This is based on the Source Event.

eventType

public final String eventType()

The type of event. For example, an Amazon CloudWatch state change.

Returns:

The type of event. For example, an Amazon CloudWatch state change.

hasRelatedResources

public final boolean hasRelatedResources()

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

relatedResources

public final List<Resource> relatedResources()

A list of resources related to this NotificationEvent.

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

Returns:

A list of resources related to this NotificationEvent.

toBuilder

public SourceEventMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SourceEventMetadata.Builder,SourceEventMetadata>

builder

public static SourceEventMetadata.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo