Class: AWSCDK::B2BI::CfnPartnership::X12OutboundEdiHeadersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
b2_bi/cfn_partnership.rb

Overview

A structure containing the details for an outbound EDI object.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(control_numbers: nil, delimiters: nil, functional_group_headers: nil, gs05_time_format: nil, interchange_control_headers: nil, validate_edi: nil) ⇒ X12OutboundEdiHeadersProperty

Returns a new instance of X12OutboundEdiHeadersProperty.

Parameters:



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'b2_bi/cfn_partnership.rb', line 1239

def initialize(control_numbers: nil, delimiters: nil, functional_group_headers: nil, gs05_time_format: nil, interchange_control_headers: nil, validate_edi: nil)
  @control_numbers = control_numbers.is_a?(Hash) ? ::AWSCDK::B2BI::CfnPartnership::X12ControlNumbersProperty.new(**control_numbers.transform_keys(&:to_sym)) : control_numbers
  Jsii::Type.check_type(@control_numbers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblBhcnRuZXJzaGlwLlgxMkNvbnRyb2xOdW1iZXJzUHJvcGVydHkifV19fQ==")), "controlNumbers") unless @control_numbers.nil?
  @delimiters = delimiters.is_a?(Hash) ? ::AWSCDK::B2BI::CfnPartnership::X12DelimitersProperty.new(**delimiters.transform_keys(&:to_sym)) : delimiters
  Jsii::Type.check_type(@delimiters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblBhcnRuZXJzaGlwLlgxMkRlbGltaXRlcnNQcm9wZXJ0eSJ9XX19")), "delimiters") unless @delimiters.nil?
  @functional_group_headers = functional_group_headers.is_a?(Hash) ? ::AWSCDK::B2BI::CfnPartnership::X12FunctionalGroupHeadersProperty.new(**functional_group_headers.transform_keys(&:to_sym)) : functional_group_headers
  Jsii::Type.check_type(@functional_group_headers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblBhcnRuZXJzaGlwLlgxMkZ1bmN0aW9uYWxHcm91cEhlYWRlcnNQcm9wZXJ0eSJ9XX19")), "functionalGroupHeaders") unless @functional_group_headers.nil?
  @gs05_time_format = gs05_time_format
  Jsii::Type.check_type(@gs05_time_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gs05TimeFormat") unless @gs05_time_format.nil?
  @interchange_control_headers = interchange_control_headers.is_a?(Hash) ? ::AWSCDK::B2BI::CfnPartnership::X12InterchangeControlHeadersProperty.new(**interchange_control_headers.transform_keys(&:to_sym)) : interchange_control_headers
  Jsii::Type.check_type(@interchange_control_headers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iMmJpLkNmblBhcnRuZXJzaGlwLlgxMkludGVyY2hhbmdlQ29udHJvbEhlYWRlcnNQcm9wZXJ0eSJ9XX19")), "interchangeControlHeaders") unless @interchange_control_headers.nil?
  @validate_edi = validate_edi
  Jsii::Type.check_type(@validate_edi, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "validateEdi") unless @validate_edi.nil?
end

Instance Attribute Details

#control_numbers ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



1260
1261
1262
 
# File 'b2_bi/cfn_partnership.rb', line 1260

def control_numbers
  @control_numbers
end

#delimiters ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



1265
1266
1267
 
# File 'b2_bi/cfn_partnership.rb', line 1265

def delimiters
  @delimiters
end

#functional_group_headers ⇒ AWSCDK::IResolvable, ... (readonly)

The functional group headers for the X12 object.

Returns:

See Also:



1270
1271
1272
 
# File 'b2_bi/cfn_partnership.rb', line 1270

def functional_group_headers
  @functional_group_headers
end

#gs05_time_format ⇒ String? (readonly)

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)

Returns:

  • (String, nil)

See Also:



1288
1289
1290
 
# File 'b2_bi/cfn_partnership.rb', line 1288

def gs05_time_format
  @gs05_time_format
end

#interchange_control_headers ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



1293
1294
1295
 
# File 'b2_bi/cfn_partnership.rb', line 1293

def interchange_control_headers
  @interchange_control_headers
end

#validate_edi ⇒ Boolean, ... (readonly)

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:

See Also:



1300
1301
1302
 
# File 'b2_bi/cfn_partnership.rb', line 1300

def validate_edi
  @validate_edi
end

Class Method Details

.jsii_properties ⇒ Object 



1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'b2_bi/cfn_partnership.rb', line 1302

def self.jsii_properties
  {
    :control_numbers => "controlNumbers",
    :delimiters => "delimiters",
    :functional_group_headers => "functionalGroupHeaders",
    :gs05_time_format => "gs05TimeFormat",
    :interchange_control_headers => "interchangeControlHeaders",
    :validate_edi => "validateEdi",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'b2_bi/cfn_partnership.rb', line 1313

def to_jsii
  result = {}
  result.merge!({
    "controlNumbers" => @control_numbers,
    "delimiters" => @delimiters,
    "functionalGroupHeaders" => @functional_group_headers,
    "gs05TimeFormat" => @gs05_time_format,
    "interchangeControlHeaders" => @interchange_control_headers,
    "validateEdi" => @validate_edi,
  })
  result.compact
end