b2bi/aws.sdk.kotlin.services.b2bi.model/TransformerSummary

TransformerSummary

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.

Types

Builder

class Builder

Companion

object Companion

Properties

createdAt

val createdAt: Instant

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

ediType

val ediType: 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.

fileFormat

val fileFormat: FileFormat

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

mappingTemplate

val mappingTemplate: String

Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.

modifiedAt

val modifiedAt: Instant?

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

name

val name: String

Returns the descriptive name for the transformer.

sampleDocument

val sampleDocument: String?

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

status

val status: TransformerStatus

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.

transformerId

val transformerId: String

Returns the system-assigned unique identifier for the transformer.

Functions

copy

inline fun copy(block: TransformerSummary.Builder.() -> Unit = {}): TransformerSummary

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String