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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateTransformerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateTransformerRequest.Builder	builder()
String	clientToken()	Reserved for future use.
EdiType	ediType()	Deprecated. This is a legacy trait.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileFormat	fileFormat()	Deprecated. This is a legacy trait.
String	fileFormatAsString()	Deprecated. This is a legacy trait.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
InputConversion	inputConversion()	Specify the InputConversion object, which contains the format options for the inbound transformation.
Mapping	mapping()	Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
String	mappingTemplate()	Deprecated. This is a legacy trait.
String	name()	Specifies the name of the transformer, used to identify it.
OutputConversion	outputConversion()	A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.
String	sampleDocument()	Deprecated. This is a legacy trait.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTransformerRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.
CreateTransformerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

FileFormat

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:

FileFormat

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTransformerRequest.Builder,CreateTransformerRequest>

Specified by:

toBuilder in class B2BiRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo