java.lang.Object
- software.amazon.awssdk.services.eventbridge.model.PutEventsRequestEntry

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PutEventsRequestEntry.Builder,PutEventsRequestEntry>

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

Represents an event to be submitted.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutEventsRequestEntry.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PutEventsRequestEntry.Builder`	`builder()`
`String`	`detail()`	A valid JSON object.
`String`	`detailType()`	Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventBusName()`	The name or ARN of the event bus to receive the event.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasResources()`	For responses, this returns true if the service returned a value for the Resources property.
`List<String>`	`resources()`	Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutEventsRequestEntry.Builder>`	`serializableBuilderClass()`
`String`	`source()`	The source of the event.
`Instant`	`time()`	The time stamp of the event, per RFC3339.
`PutEventsRequestEntry.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`traceHeader()`	An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the 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
  - time
```
public final Instant time()
```
    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
    
    Returns:
    
    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
  - source
```
public final String source()
```
    The source of the event.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    
    Returns:
    
    The source of the event.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
  - 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 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.
  - resources
```
public final List<String> 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
```
public final String detailType()
```
    Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    
    Returns:
    
    Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
  - detail
```
public final String detail()
```
    A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
    
    Returns:
    
    A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested sub-objects.
    
    Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that do not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.
  - eventBusName
```
public final String 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.
    
    If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.
    
    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.
    
    If you're using a global endpoint with a custom bus, you can enter either the name or Amazon Resource Name (ARN) of the event bus in either the primary or secondary Region here. EventBridge then determines the corresponding event bus in the other Region based on the endpoint referenced by the EndpointId. Specifying the event bus ARN is preferred.
  - traceHeader
```
public final String traceHeader()
```
    An X-Ray trace 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 trace 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
```
public PutEventsRequestEntry.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutEventsRequestEntry.Builder,PutEventsRequestEntry>
  - builder
```
public static PutEventsRequestEntry.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutEventsRequestEntry.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

Class PutEventsRequestEntry

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

time

source

hasResources

resources

detailType

detail

eventBusName

traceHeader

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields