Class PutEventsRequestEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PutEventsRequestEntry.Builder,
PutEventsRequestEntry>
Represents an event to be submitted.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
detail()
A valid JSON string.final String
Free-form string used to decide what fields to expect in the event detail.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name or ARN of the event bus to receive the event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Resources property.Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.static Class
<? extends PutEventsRequestEntry.Builder> final String
source()
The source of the event.final Instant
time()
The time stamp of the event, per RFC3339.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.final String
An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
time
-
source
The source of the event.
- Returns:
- The source of the event.
-
hasResources
public final boolean hasResources()For responses, this returns true if the service returned a value for the Resources 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. -
resources
Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
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
hasResources()
method.- Returns:
- Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
-
detailType
Free-form string used to decide what fields to expect in the event detail.
- Returns:
- Free-form string used to decide what fields to expect in the event detail.
-
detail
A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
- Returns:
- A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
-
eventBusName
The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.
- Returns:
- The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.
-
traceHeader
An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
- Returns:
- An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated
with the event.
To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.
-
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<PutEventsRequestEntry.Builder,
PutEventsRequestEntry> - 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
-