Class X12OutboundEdiHeaders

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

A structure containing the details for an outbound EDI object.

See Also:

  • Method Details

    • interchangeControlHeaders

      public final X12InterchangeControlHeaders interchangeControlHeaders()

      In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

      Returns:
      In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

    • functionalGroupHeaders

      public final X12FunctionalGroupHeaders functionalGroupHeaders()

      The functional group headers for the X12 object.

      Returns:
      The functional group headers for the X12 object.

    • delimiters

      public final X12Delimiters delimiters()

      The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.

      Returns:
      The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.

    • validateEdi

      public final Boolean validateEdi()

      Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.

      Returns:
      Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE . When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.

    • controlNumbers

      public final X12ControlNumbers controlNumbers()

      Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

      Returns:
      Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

    • gs05TimeFormat

      public final X12GS05TimeFormat gs05TimeFormat()
      Returns the value of the Gs05TimeFormat property for this object.

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

      Returns:
      The value of the Gs05TimeFormat property for this object.
      See Also:

    • gs05TimeFormatAsString

      public final String gs05TimeFormatAsString()
      Returns the value of the Gs05TimeFormat property for this object.

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

      Returns:
      The value of the Gs05TimeFormat property for this object.
      See Also:

    • toBuilder

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

    • builder

      public static X12OutboundEdiHeaders.Builder builder()

    • serializableBuilderClass

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