Class CreateTransformerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.b2bi.model.B2BiRequest
software.amazon.awssdk.services.b2bi.model.CreateTransformerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTransformerRequest.Builder,CreateTransformerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTransformerRequest extends B2BiRequest implements ToCopyableBuilder<CreateTransformerRequest.Builder,CreateTransformerRequest>

  • Method Details

    • name

      public final String name()

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

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

    • clientToken

      public final String clientToken()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • fileFormat

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

      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:

    • fileFormatAsString

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

      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:

    • mappingTemplate

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

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

    • ediType

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

      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

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

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

    • inputConversion

      public final InputConversion inputConversion()

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

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

    • mapping

      public final Mapping mapping()

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

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

    • outputConversion

      public final OutputConversion outputConversion()

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

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

    • sampleDocuments

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

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

    • toBuilder

      public CreateTransformerRequest.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<CreateTransformerRequest.Builder,CreateTransformerRequest>
      Specified by:
      toBuilder in class B2BiRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTransformerRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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