Class SendDataIntegrationEventRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.supplychain.model.SupplyChainRequest
software.amazon.awssdk.services.supplychain.model.SendDataIntegrationEventRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendDataIntegrationEventRequest extends SupplyChainRequest implements ToCopyableBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>

The request parameters for SendDataIntegrationEvent.

  • Method Details

    • instanceId

      public final String instanceId()

      The AWS Supply Chain instance identifier.

      Returns:
      The AWS Supply Chain instance identifier.

    • eventType

      public final DataIntegrationEventType eventType()

      The data event type.

      If the service returns an enum value that is not available in the current SDK version, eventType will return DataIntegrationEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The data event type.

      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      The data event type.

      If the service returns an enum value that is not available in the current SDK version, eventType will return DataIntegrationEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The data event type.

      See Also:

    • data

      public final 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.

      Returns:
      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.

    • eventGroupId

      public final 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.

      Returns:
      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.

    • eventTimestamp

      public final Instant eventTimestamp()

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

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

    • clientToken

      public final 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.

      Returns:
      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.

    • datasetTarget

      public final DataIntegrationEventDatasetTargetConfiguration datasetTarget()

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

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

    • toBuilder

      public SendDataIntegrationEventRequest.Builder 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 interface ToCopyableBuilder<SendDataIntegrationEventRequest.Builder,SendDataIntegrationEventRequest>
      Specified by:
      toBuilder in class SupplyChainRequest
      Returns:
      a builder for type T

    • builder

      public static SendDataIntegrationEventRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SendDataIntegrationEventRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.