PutEventsRequestEntry (AWS Java SDK for Amazon EventBridge 1.12.698 API)

java.lang.Object
- com.amazonaws.services.eventbridge.model.PutEventsRequestEntry

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutEventsRequestEntry
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents an event to be submitted.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutEventsRequestEntry()

Constructors
Constructor and Description
`PutEventsRequestEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutEventsRequestEntry`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDetail()` A valid JSON object.
`String`	`getDetailType()` Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
`String`	`getEventBusName()` The name or ARN of the event bus to receive the event.
`List<String>`	`getResources()` Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
`String`	`getSource()` The source of the event.
`Date`	`getTime()` The time stamp of the event, per RFC3339.
`String`	`getTraceHeader()` An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDetail(String detail)` A valid JSON object.
`void`	`setDetailType(String detailType)` Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
`void`	`setEventBusName(String eventBusName)` The name or ARN of the event bus to receive the event.
`void`	`setResources(Collection<String> resources)` Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
`void`	`setSource(String source)` The source of the event.
`void`	`setTime(Date time)` The time stamp of the event, per RFC3339.
`void`	`setTraceHeader(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.
`String`	`toString()` Returns a string representation of this object.
`PutEventsRequestEntry`	`withDetail(String detail)` A valid JSON object.
`PutEventsRequestEntry`	`withDetailType(String detailType)` Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
`PutEventsRequestEntry`	`withEventBusName(String eventBusName)` The name or ARN of the event bus to receive the event.
`PutEventsRequestEntry`	`withResources(Collection<String> resources)` Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
`PutEventsRequestEntry`	`withResources(String... resources)` Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns.
`PutEventsRequestEntry`	`withSource(String source)` The source of the event.
`PutEventsRequestEntry`	`withTime(Date time)` The time stamp of the event, per RFC3339.
`PutEventsRequestEntry`	`withTraceHeader(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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutEventsRequestEntry
```
public PutEventsRequestEntry()
```
- Method Detail
  - setTime
```
public void setTime(Date time)
```
    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
    
    Parameters:
    
    time - The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
  - getTime
```
public Date getTime()
```
    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.
  - withTime
```
public PutEventsRequestEntry withTime(Date time)
```
    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(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.
    
    Parameters:
    
    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.
  - getSource
```
public String getSource()
```
    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.
  - withSource
```
public PutEventsRequestEntry withSource(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResources
```
public List<String> getResources()
```
    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    Returns:
    
    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
  - setResources
```
public void setResources(Collection<String> resources)
```
    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    Parameters:
    
    resources - Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
  - withResources
```
public PutEventsRequestEntry withResources(String... resources)
```
    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    NOTE: This method appends the values to the existing list (if any). Use setResources(java.util.Collection) or withResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resources - Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResources
```
public PutEventsRequestEntry withResources(Collection<String> resources)
```
    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    Parameters:
    
    resources - Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDetailType
```
public void setDetailType(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.
    
    Parameters:
    
    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.
  - getDetailType
```
public String getDetailType()
```
    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.
  - withDetailType
```
public PutEventsRequestEntry withDetailType(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDetail
```
public void setDetail(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.
    
    Parameters:
    
    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.
  - getDetail
```
public String getDetail()
```
    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.
  - withDetail
```
public PutEventsRequestEntry withDetail(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventBusName
```
public void setEventBusName(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.
    
    Parameters:
    
    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.
  - getEventBusName
```
public String getEventBusName()
```
    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.
  - withEventBusName
```
public PutEventsRequestEntry withEventBusName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTraceHeader
```
public void setTraceHeader(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.
    
    Parameters:
    
    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.
  - getTraceHeader
```
public String getTraceHeader()
```
    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.
  - withTraceHeader
```
public PutEventsRequestEntry withTraceHeader(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutEventsRequestEntry clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class PutEventsRequestEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PutEventsRequestEntry

Method Detail

setTime

getTime

withTime

setSource

getSource

withSource

getResources

setResources

withResources

withResources

setDetailType

getDetailType

withDetailType

setDetail

getDetail

withDetail

setEventBusName

getEventBusName

withEventBusName

setTraceHeader

getTraceHeader

withTraceHeader

toString

equals

hashCode

clone

marshall