Interface TransformerSummary.Builder

    • Method Detail

      • 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, FileFormat
      • 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:
        FileFormat, FileFormat
      • mappingTemplate

        TransformerSummary.Builder mappingTemplate​(String mappingTemplate)

        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.

        Parameters:
        mappingTemplate - 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.
        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:
        TransformerStatus, TransformerStatus
      • 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:
        TransformerStatus, TransformerStatus
      • 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.
      • 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.