Class X12Envelope

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

A wrapper structure for an X12 definition object.

the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:

  • Interchange Envelope

  • Functional Group

  • Transaction Set

See Also:

  • Method Details

    • common

      public final X12OutboundEdiHeaders common()

      A container for the X12 outbound EDI headers.

      Returns:
      A container for the X12 outbound EDI headers.

    • wrapOptions

      public final WrapOptions wrapOptions()
      Returns the value of the WrapOptions property for this object.
      Returns:
      The value of the WrapOptions property for this object.

    • toBuilder

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

    • builder

      public static X12Envelope.Builder builder()

    • serializableBuilderClass

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