Class: Aws::B2bi::Types::TransformerSummary

Inherits:

Struct

• Object
• Struct
• Aws::B2bi::Types::TransformerSummary

Defined in:

gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb

Overview

Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Returns a timestamp indicating when the transformer was created.

• #edi_type ⇒ Types::EdiType

  Returns the details for the EDI standard that is being used for the transformer.

• #file_format ⇒ String

  Returns that the currently supported file formats for EDI transformations are JSON and XML.

• #mapping_template ⇒ String

  Returns the mapping template for the transformer.

• #modified_at ⇒ Time

  Returns a timestamp representing the date and time for the most recent change for the transformer object.

• #name ⇒ String

  Returns the descriptive name for the transformer.

• #sample_document ⇒ String

  Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

• #status ⇒ String

  Returns the state of the newly created transformer.

• #transformer_id ⇒ String

  Returns the system-assigned unique identifier for the transformer.

Instance Attribute Details

#created_at ⇒ Time

Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

Returns:

• (Time)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#edi_type ⇒ Types::EdiType

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Returns:

• (Types::EdiType)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#file_format ⇒ String

Returns that the currently supported file formats for EDI transformations are JSON and XML.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#mapping_template ⇒ String

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ Time

Returns a timestamp representing the date and time for the most recent change for the transformer object.

Returns:

• (Time)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Returns the descriptive name for the transformer.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#sample_document ⇒ String

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end

#transformer_id ⇒ String

Returns the system-assigned unique identifier for the transformer.

Returns:

• (String)

# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 1594

class TransformerSummary < Struct.new(
  :transformer_id,
  :name,
  :file_format,
  :mapping_template,
  :status,
  :edi_type,
  :sample_document,
  :created_at,
  :modified_at)
  SENSITIVE = []
  include Aws::Structure
end