Package software.amazon.awscdk.services.b2bi

Interface CfnPartnership.X12OutboundEdiHeadersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPartnership.X12OutboundEdiHeadersProperty.Jsii$Proxy

Enclosing class:

CfnPartnership

@Stability(Stable)
public static interface CfnPartnership.X12OutboundEdiHeadersProperty
extends software.amazon.jsii.JsiiSerializable

A structure containing the details for an outbound EDI object.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.b2bi.*;
 X12OutboundEdiHeadersProperty x12OutboundEdiHeadersProperty = X12OutboundEdiHeadersProperty.builder()
         .controlNumbers(X12ControlNumbersProperty.builder()
                 .startingFunctionalGroupControlNumber(123)
                 .startingInterchangeControlNumber(123)
                 .startingTransactionSetControlNumber(123)
                 .build())
         .delimiters(X12DelimitersProperty.builder()
                 .componentSeparator("componentSeparator")
                 .dataElementSeparator("dataElementSeparator")
                 .segmentTerminator("segmentTerminator")
                 .build())
         .functionalGroupHeaders(X12FunctionalGroupHeadersProperty.builder()
                 .applicationReceiverCode("applicationReceiverCode")
                 .applicationSenderCode("applicationSenderCode")
                 .responsibleAgencyCode("responsibleAgencyCode")
                 .build())
         .gs05TimeFormat("gs05TimeFormat")
         .interchangeControlHeaders(X12InterchangeControlHeadersProperty.builder()
                 .acknowledgmentRequestedCode("acknowledgmentRequestedCode")
                 .receiverId("receiverId")
                 .receiverIdQualifier("receiverIdQualifier")
                 .repetitionSeparator("repetitionSeparator")
                 .senderId("senderId")
                 .senderIdQualifier("senderIdQualifier")
                 .usageIndicatorCode("usageIndicatorCode")
                 .build())
         .validateEdi(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPartnership.X12OutboundEdiHeadersProperty.Builder	A builder for CfnPartnership.X12OutboundEdiHeadersProperty
static final class	CfnPartnership.X12OutboundEdiHeadersProperty.Jsii$Proxy	An implementation for CfnPartnership.X12OutboundEdiHeadersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPartnership.X12OutboundEdiHeadersProperty.Builder	builder()
default Object	getControlNumbers()	Specifies control number configuration for outbound X12 EDI headers.
default Object	getDelimiters()	The delimiters, for example semicolon ( ; ), that separates sections of the headers for the X12 object.
default Object	getFunctionalGroupHeaders()	The functional group headers for the X12 object.
default String	getGs05TimeFormat()	Specifies the time format in the GS05 element (time) of the functional group header.
default Object	getInterchangeControlHeaders()	In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
default Object	getValidateEdi()	Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getControlNumbers

@Stability(Stable)
@Nullable
default Object getControlNumbers()

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 union: either IResolvable or CfnPartnership.X12ControlNumbersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers

getDelimiters

@Stability(Stable)
@Nullable
default Object getDelimiters()

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

Returns union: either IResolvable or CfnPartnership.X12DelimitersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-delimiters

getFunctionalGroupHeaders

@Stability(Stable)
@Nullable
default Object getFunctionalGroupHeaders()

The functional group headers for the X12 object.

Returns union: either IResolvable or CfnPartnership.X12FunctionalGroupHeadersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders

getGs05TimeFormat

@Stability(Stable)
@Nullable
default String getGs05TimeFormat()

Specifies the time format in the GS05 element (time) of the functional group header.

The following formats use 24-hour clock time:

• HHMM - Hours and minutes
• HHMMSS - Hours, minutes, and seconds
• HHMMSSDD - Hours, minutes, seconds, and decimal seconds

Where:

• HH - Hours (00-23)
• MM - Minutes (00-59)
• SS - Seconds (00-59)
• DD - Hundredths of seconds (00-99)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat

getInterchangeControlHeaders

@Stability(Stable)
@Nullable
default Object getInterchangeControlHeaders()

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

Returns union: either IResolvable or CfnPartnership.X12InterchangeControlHeadersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders

getValidateEdi

@Stability(Stable)
@Nullable
default Object getValidateEdi()

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 union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-b2bi-partnership-x12outboundediheaders.html#cfn-b2bi-partnership-x12outboundediheaders-validateedi

builder

@Stability(Stable)
static CfnPartnership.X12OutboundEdiHeadersProperty.Builder builder()

Returns:

a CfnPartnership.X12OutboundEdiHeadersProperty.Builder of CfnPartnership.X12OutboundEdiHeadersProperty