Package software.amazon.awssdk.services.b2bi.model

Interface TransformerSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TransformerSummary.Builder,TransformerSummary>, SdkBuilder<TransformerSummary.Builder,TransformerSummary>, SdkPojo
Enclosing class:
TransformerSummary
public static interface TransformerSummary.Builder extends SdkPojo, CopyableBuilder<TransformerSummary.Builder,TransformerSummary>

  • Method Details

    • transformerId

      TransformerSummary.Builder transformerId(String transformerId)

      Returns the system-assigned unique identifier for the transformer.

      Parameters:
      transformerId - Returns the system-assigned unique identifier for the transformer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      TransformerSummary.Builder name(String name)

      Returns the descriptive name for the transformer.

      Parameters:
      name - Returns the descriptive name for the transformer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileFormat

      TransformerSummary.Builder fileFormat(String fileFormat)

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

      Parameters:
      fileFormat - Returns that the currently supported file formats for EDI transformations are JSON and XML.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileFormat

      TransformerSummary.Builder fileFormat(FileFormat fileFormat)

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

      Parameters:
      fileFormat - Returns that the currently supported file formats for EDI transformations are JSON and XML.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mappingTemplate

      TransformerSummary.Builder mappingTemplate(String mappingTemplate)

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

      Parameters:
      mappingTemplate - Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      TransformerSummary.Builder status(String status)

      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.

      Parameters:
      status - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      TransformerSummary.Builder status(TransformerStatus status)

      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.

      Parameters:
      status - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ediType

      TransformerSummary.Builder ediType(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ediType

      default TransformerSummary.Builder ediType(Consumer<EdiType.Builder> 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.

      This is a convenience method that creates an instance of the EdiType.Builder avoiding the need to create one manually via EdiType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ediType(EdiType).

      Parameters:
      ediType - a consumer that will call methods on EdiType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sampleDocument

      TransformerSummary.Builder sampleDocument(String sampleDocument)

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

      Parameters:
      sampleDocument - Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      TransformerSummary.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      TransformerSummary.Builder modifiedAt(Instant modifiedAt)

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

      Parameters:
      modifiedAt - Returns a timestamp representing the date and time for the most recent change for the transformer object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.