Class TransformerSummary

java.lang.Object
software.amazon.awssdk.services.b2bi.model.TransformerSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TransformerSummary.Builder,TransformerSummary>
@Generated("software.amazon.awssdk:codegen") public final class TransformerSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TransformerSummary.Builder,TransformerSummary>

Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

See Also:

  • Method Details

    • transformerId

      public final String transformerId()

      Returns the system-assigned unique identifier for the transformer.

      Returns:
      Returns the system-assigned unique identifier for the transformer.

    • name

      public final String name()

      Returns the descriptive name for the transformer.

      Returns:
      Returns the descriptive name for the transformer.

    • status

      public final 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.

      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:
      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      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:
      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.
      See Also:

    • createdAt

      public final Instant createdAt()

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

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

    • modifiedAt

      public final Instant modifiedAt()

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

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

    • fileFormat

      @Deprecated public final 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.

      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:
      Returns that the currently supported file formats for EDI transformations are JSON and XML.
      See Also:

    • fileFormatAsString

      @Deprecated public final String fileFormatAsString()
      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.

      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:
      Returns that the currently supported file formats for EDI transformations are JSON and XML.
      See Also:

    • mappingTemplate

      @Deprecated public final 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.

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

    • ediType

      @Deprecated public final 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.

      Returns:
      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.

    • sampleDocument

      @Deprecated public final 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.

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

    • inputConversion

      public final InputConversion inputConversion()

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

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

    • mapping

      public final Mapping mapping()

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

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

    • outputConversion

      public final OutputConversion outputConversion()

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

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

    • sampleDocuments

      public final 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.

      Returns:
      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.

    • toBuilder

      public TransformerSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TransformerSummary.Builder,TransformerSummary>
      Returns:
      a builder for type T

    • builder

      public static TransformerSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TransformerSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.