Class X12Details

java.lang.Object
software.amazon.awssdk.services.b2bi.model.X12Details
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<X12Details.Builder,X12Details>
@Generated("software.amazon.awssdk:codegen") public final class X12Details extends Object implements SdkPojo, Serializable, ToCopyableBuilder<X12Details.Builder,X12Details>

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

See Also:

  • Method Details

    • transactionSet

      public final X12TransactionSet transactionSet()

      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

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

      Returns:
      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
      See Also:

    • transactionSetAsString

      public final String transactionSetAsString()

      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

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

      Returns:
      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
      See Also:

    • version

      public final X12Version version()

      Returns the version to use for the specified X12 transaction set.

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

      Returns:
      Returns the version to use for the specified X12 transaction set.
      See Also:

    • versionAsString

      public final String versionAsString()

      Returns the version to use for the specified X12 transaction set.

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

      Returns:
      Returns the version to use for the specified X12 transaction set.
      See Also:

    • toBuilder

      public X12Details.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<X12Details.Builder,X12Details>
      Returns:
      a builder for type T

    • builder

      public static X12Details.Builder builder()

    • serializableBuilderClass

      public static Class<? extends X12Details.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)
      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)

    • 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.