Class UpdateTransformerRequest

    • Method Detail

      • transformerId

        public final String transformerId()

        Specifies the system-assigned unique identifier for the transformer.

        Returns:
        Specifies the system-assigned unique identifier for the transformer.
      • name

        public final String name()

        Specify a new name for the transformer, if you want to update it.

        Returns:
        Specify a new name for the transformer, if you want to update it.
      • fileFormat

        public final FileFormat fileFormat()

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

        If the service returns an enum value that is not available in the current SDK version, fileFormat will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().

        Returns:
        Specifies that the currently supported file formats for EDI transformations are JSON and XML.
        See Also:
        FileFormat
      • fileFormatAsString

        public final String fileFormatAsString()

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

        If the service returns an enum value that is not available in the current SDK version, fileFormat will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().

        Returns:
        Specifies that the currently supported file formats for EDI transformations are JSON and XML.
        See Also:
        FileFormat
      • mappingTemplate

        public final String mappingTemplate()

        Specifies 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:
        Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
      • status

        public final TransformerStatus status()

        Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.

        If the service returns an enum value that is not available in the current SDK version, status will return TransformerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
        See Also:
        TransformerStatus
      • statusAsString

        public final String statusAsString()

        Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.

        If the service returns an enum value that is not available in the current SDK version, status will return TransformerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
        See Also:
        TransformerStatus
      • ediType

        public final EdiType 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:
        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.
      • sampleDocument

        public final String sampleDocument()

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

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

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object