Interface SendDataIntegrationEventRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>, SdkBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>, SdkPojo, SdkRequest.Builder, SupplyChainRequest.Builder

Enclosing class:

SendDataIntegrationEventRequest

@Mutable
@NotThreadSafe
public static interface SendDataIntegrationEventRequest.Builder
extends SupplyChainRequest.Builder, SdkPojo, CopyableBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>

Method Summary

Modifier and Type	Method	Description
SendDataIntegrationEventRequest.Builder	clientToken(String clientToken)	The idempotent client token.
SendDataIntegrationEventRequest.Builder	data(String data)	The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain.
default SendDataIntegrationEventRequest.Builder	datasetTarget(Consumer<DataIntegrationEventDatasetTargetConfiguration.Builder> datasetTarget)	The target dataset configuration for scn.data.dataset event type.
SendDataIntegrationEventRequest.Builder	datasetTarget(DataIntegrationEventDatasetTargetConfiguration datasetTarget)	The target dataset configuration for scn.data.dataset event type.
SendDataIntegrationEventRequest.Builder	eventGroupId(String eventGroupId)	Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
SendDataIntegrationEventRequest.Builder	eventTimestamp(Instant eventTimestamp)	The timestamp (in epoch seconds) associated with the event.
SendDataIntegrationEventRequest.Builder	eventType(String eventType)	The data event type.
SendDataIntegrationEventRequest.Builder	eventType(DataIntegrationEventType eventType)	The data event type.
SendDataIntegrationEventRequest.Builder	instanceId(String instanceId)	The AWS Supply Chain instance identifier.
SendDataIntegrationEventRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendDataIntegrationEventRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.supplychain.model.SupplyChainRequest.Builder

build

Method Details

instanceId

SendDataIntegrationEventRequest.Builder instanceId(String instanceId)

The AWS Supply Chain instance identifier.

Parameters:

instanceId - The AWS Supply Chain instance identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventType

SendDataIntegrationEventRequest.Builder eventType(String eventType)

The data event type.

• scn.data.dataset - Send data directly to any specified dataset.

• scn.data.supplyplan - Send data to supply_plan dataset.

• scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.

• scn.data.shipmentstop - Send data to shipment_stop dataset.

• scn.data.shipment - Send data to shipment dataset.

• scn.data.reservation - Send data to reservation dataset.

• scn.data.processproduct - Send data to process_product dataset.

• scn.data.processoperation - Send data to process_operation dataset.

• scn.data.processheader - Send data to process_header dataset.

• scn.data.forecast - Send data to forecast dataset.

• scn.data.inventorylevel - Send data to inv_level dataset.

• scn.data.inboundorder - Send data to inbound_order dataset.

• scn.data.inboundorderline - Send data to inbound_order_line dataset.

• scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.

• scn.data.outboundorderline - Send data to outbound_order_line dataset.

• scn.data.outboundshipment - Send data to outbound_shipment dataset.

Parameters:

eventType - The data event type.

• scn.data.dataset - Send data directly to any specified dataset.

• scn.data.supplyplan - Send data to supply_plan dataset.

• scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.

• scn.data.shipmentstop - Send data to shipment_stop dataset.

• scn.data.shipment - Send data to shipment dataset.

• scn.data.reservation - Send data to reservation dataset.

• scn.data.processproduct - Send data to process_product dataset.

• scn.data.processoperation - Send data to process_operation dataset.

• scn.data.processheader - Send data to process_header dataset.

• scn.data.forecast - Send data to forecast dataset.

• scn.data.inventorylevel - Send data to inv_level dataset.

• scn.data.inboundorder - Send data to inbound_order dataset.

• scn.data.inboundorderline - Send data to inbound_order_line dataset.

• scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.

• scn.data.outboundorderline - Send data to outbound_order_line dataset.

• scn.data.outboundshipment - Send data to outbound_shipment dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataIntegrationEventType
• DataIntegrationEventType

eventType

SendDataIntegrationEventRequest.Builder eventType(DataIntegrationEventType eventType)

The data event type.

• scn.data.dataset - Send data directly to any specified dataset.

• scn.data.supplyplan - Send data to supply_plan dataset.

• scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.

• scn.data.shipmentstop - Send data to shipment_stop dataset.

• scn.data.shipment - Send data to shipment dataset.

• scn.data.reservation - Send data to reservation dataset.

• scn.data.processproduct - Send data to process_product dataset.

• scn.data.processoperation - Send data to process_operation dataset.

• scn.data.processheader - Send data to process_header dataset.

• scn.data.forecast - Send data to forecast dataset.

• scn.data.inventorylevel - Send data to inv_level dataset.

• scn.data.inboundorder - Send data to inbound_order dataset.

• scn.data.inboundorderline - Send data to inbound_order_line dataset.

• scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.

• scn.data.outboundorderline - Send data to outbound_order_line dataset.

• scn.data.outboundshipment - Send data to outbound_shipment dataset.

Parameters:

eventType - The data event type.

• scn.data.dataset - Send data directly to any specified dataset.

• scn.data.supplyplan - Send data to supply_plan dataset.

• scn.data.shipmentstoporder - Send data to shipment_stop_order dataset.

• scn.data.shipmentstop - Send data to shipment_stop dataset.

• scn.data.shipment - Send data to shipment dataset.

• scn.data.reservation - Send data to reservation dataset.

• scn.data.processproduct - Send data to process_product dataset.

• scn.data.processoperation - Send data to process_operation dataset.

• scn.data.processheader - Send data to process_header dataset.

• scn.data.forecast - Send data to forecast dataset.

• scn.data.inventorylevel - Send data to inv_level dataset.

• scn.data.inboundorder - Send data to inbound_order dataset.

• scn.data.inboundorderline - Send data to inbound_order_line dataset.

• scn.data.inboundorderlineschedule - Send data to inbound_order_line_schedule dataset.

• scn.data.outboundorderline - Send data to outbound_order_line dataset.

• scn.data.outboundshipment - Send data to outbound_shipment dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• DataIntegrationEventType
• DataIntegrationEventType

data

SendDataIntegrationEventRequest.Builder data(String data)

The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.

Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.

Parameters:

data - The data payload of the event, should follow the data schema of the target dataset, or see Data entities supported in AWS Supply Chain. To send single data record, use JsonObject format; to send multiple data records, use JsonArray format.

Note that for AWS Supply Chain dataset under asc namespace, it has a connection_id internal field that is not allowed to be provided by client directly, they will be auto populated.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventGroupId

SendDataIntegrationEventRequest.Builder eventGroupId(String eventGroupId)

Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.

Parameters:

eventGroupId - Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning. Noted under one eventGroupId of same eventType and instanceId, events are processed sequentially in the order they are received by the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventTimestamp

SendDataIntegrationEventRequest.Builder eventTimestamp(Instant eventTimestamp)

The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.

Parameters:

eventTimestamp - The timestamp (in epoch seconds) associated with the event. If not provided, it will be assigned with current timestamp.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

SendDataIntegrationEventRequest.Builder clientToken(String clientToken)

The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.

Parameters:

clientToken - The idempotent client token. The token is active for 8 hours, and within its lifetime, it ensures the request completes only once upon retry with same client token. If omitted, the AWS SDK generates a unique value so that AWS SDK can safely retry the request upon network errors.

Returns:

Returns a reference to this object so that method calls can be chained together.

datasetTarget

SendDataIntegrationEventRequest.Builder datasetTarget(DataIntegrationEventDatasetTargetConfiguration datasetTarget)

The target dataset configuration for scn.data.dataset event type.

Parameters:

datasetTarget - The target dataset configuration for scn.data.dataset event type.

Returns:

Returns a reference to this object so that method calls can be chained together.

datasetTarget

default SendDataIntegrationEventRequest.Builder datasetTarget(Consumer<DataIntegrationEventDatasetTargetConfiguration.Builder> datasetTarget)

The target dataset configuration for scn.data.dataset event type.

This is a convenience method that creates an instance of the DataIntegrationEventDatasetTargetConfiguration.Builder avoiding the need to create one manually via DataIntegrationEventDatasetTargetConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetTarget(DataIntegrationEventDatasetTargetConfiguration).

Parameters:

datasetTarget - a consumer that will call methods on DataIntegrationEventDatasetTargetConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• datasetTarget(DataIntegrationEventDatasetTargetConfiguration)

overrideConfiguration

SendDataIntegrationEventRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SendDataIntegrationEventRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.