Package software.amazon.awssdk.services.eventbridge.model

Interface PutEventsRequestEntry.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PutEventsRequestEntry.Builder,PutEventsRequestEntry>, SdkBuilder<PutEventsRequestEntry.Builder,PutEventsRequestEntry>, SdkPojo
Enclosing class:
PutEventsRequestEntry
public static interface PutEventsRequestEntry.Builder extends SdkPojo, CopyableBuilder<PutEventsRequestEntry.Builder,PutEventsRequestEntry>

  • Method Details

    • time

      PutEventsRequestEntry.Builder time(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.

      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.

    • source

      PutEventsRequestEntry.Builder source(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.

    • resources

      PutEventsRequestEntry.Builder resources(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.

    • resources

      PutEventsRequestEntry.Builder resources(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.

    • detailType

      PutEventsRequestEntry.Builder detailType(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.

    • detail

      PutEventsRequestEntry.Builder detail(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.

    • eventBusName

      PutEventsRequestEntry.Builder eventBusName(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.

    • traceHeader

      PutEventsRequestEntry.Builder traceHeader(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.