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

Interface CreateTransformerRequest.Builder

    • Method Detail

      • name

        CreateTransformerRequest.Builder name​(String name)

        Specifies the name of the transformer, used to identify it.

        Parameters:
        name - Specifies the name of the transformer, used to identify it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        CreateTransformerRequest.Builder clientToken​(String clientToken)

        Reserved for future use.

        Parameters:
        clientToken - Reserved for future use.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTransformerRequest.Builder tags​(Collection<Tag> tags)

        Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

        Parameters:
        tags - Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTransformerRequest.Builder tags​(Tag... tags)

        Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

        Parameters:
        tags - Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTransformerRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • fileFormat

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

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

        Parameters:
        fileFormat - Specifies 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

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

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

        Parameters:
        fileFormat - Specifies 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

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

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

        This parameter is available for backwards compatibility. Use the Mapping data type instead.

        Parameters:
        mappingTemplate - Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

        This parameter is available for backwards compatibility. Use the Mapping data type instead.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ediType

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

        Specifies 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 - Specifies 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 CreateTransformerRequest.Builder ediType​(Consumer<EdiType.Builder> ediType)
        Deprecated.
        This is a legacy trait. Please use input-conversion or output-conversion.

        Specifies 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:
        ediType(EdiType)

      • sampleDocument

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

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

        Parameters:
        sampleDocument - Specifies 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

        CreateTransformerRequest.Builder inputConversion​(InputConversion inputConversion)

        Specify the InputConversion object, which contains the format options for the inbound transformation.

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

      • mapping

        CreateTransformerRequest.Builder mapping​(Mapping mapping)

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

        Parameters:
        mapping - Specify 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.

      • outputConversion

        CreateTransformerRequest.Builder outputConversion​(OutputConversion outputConversion)

        A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.

        Parameters:
        outputConversion - A structure that contains 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.

      • sampleDocuments

        CreateTransformerRequest.Builder sampleDocuments​(SampleDocuments sampleDocuments)

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