Interface TransformerSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TransformerSummary.Builder,TransformerSummary>, SdkBuilder<TransformerSummary.Builder,TransformerSummary>, SdkPojo
Enclosing class:
TransformerSummary
@Mutable @NotThreadSafe 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.

    • 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:

    • 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.

    • fileFormat

      @Deprecated TransformerSummary.Builder fileFormat(String fileFormat)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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

      @Deprecated TransformerSummary.Builder fileFormat(FileFormat fileFormat)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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

      @Deprecated TransformerSummary.Builder mappingTemplate(String mappingTemplate)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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.

    • ediType

      @Deprecated TransformerSummary.Builder ediType(EdiType ediType)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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

      @Deprecated default TransformerSummary.Builder ediType(Consumer<EdiType.Builder> ediType)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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

      @Deprecated TransformerSummary.Builder sampleDocument(String sampleDocument)
      Deprecated.
      This is a legacy trait. Please use input-conversion or output-conversion.

      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.

    • inputConversion

      TransformerSummary.Builder inputConversion(InputConversion inputConversion)

      Returns a structure that contains the format options for the transformation.

      Parameters:
      inputConversion - Returns a structure that contains the format options for the transformation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputConversion

      default TransformerSummary.Builder inputConversion(Consumer<InputConversion.Builder> inputConversion)

      Returns a structure that contains the format options for the transformation.

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

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

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

    • mapping

      TransformerSummary.Builder mapping(Mapping mapping)

      Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

      Parameters:
      mapping - Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mapping

      default TransformerSummary.Builder mapping(Consumer<Mapping.Builder> mapping)

      Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

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

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

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

    • outputConversion

      TransformerSummary.Builder outputConversion(OutputConversion outputConversion)

      Returns the OutputConversion object, which contains the format options for the outbound transformation.

      Parameters:
      outputConversion - Returns the OutputConversion object, which contains the format options for the outbound transformation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConversion

      default TransformerSummary.Builder outputConversion(Consumer<OutputConversion.Builder> outputConversion)

      Returns the OutputConversion object, which contains the format options for the outbound transformation.

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

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

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

    • sampleDocuments

      TransformerSummary.Builder sampleDocuments(SampleDocuments sampleDocuments)

      Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

      Parameters:
      sampleDocuments - Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleDocuments

      default TransformerSummary.Builder sampleDocuments(Consumer<SampleDocuments.Builder> sampleDocuments)

      Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

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

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

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