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

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 describes how to process the incoming EDI documents and extract the necessary information to the output file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransformerSummary.Builder

Method Summary

Modifier and Type	Method	Description
static TransformerSummary.Builder	builder()
Instant	createdAt()	Returns a timestamp indicating when the transformer was created.
EdiType	ediType()	Returns the details for the EDI standard that is being used for the transformer.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FileFormat	fileFormat()	Returns that the currently supported file formats for EDI transformations are JSON and XML.
String	fileFormatAsString()	Returns that the currently supported file formats for EDI transformations are JSON and XML.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mappingTemplate()	Returns the name of the mapping template for the transformer.
Instant	modifiedAt()	Returns a timestamp representing the date and time for the most recent change for the transformer object.
String	name()	Returns the descriptive name for the transformer.
String	sampleDocument()	Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
List<SdkField<?>>	sdkFields()
static Class<? extends TransformerSummary.Builder>	serializableBuilderClass()
TransformerStatus	status()	Returns the state of the newly created transformer.
String	statusAsString()	Returns the state of the newly created transformer.
TransformerSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transformerId()	Returns the system-assigned unique identifier for the transformer.

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

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.

fileFormat

public final FileFormat fileFormat()

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:

FileFormat

fileFormatAsString

public final String fileFormatAsString()

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:

FileFormat

mappingTemplate

public final String mappingTemplate()

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

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

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:

TransformerStatus

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:

TransformerStatus

ediType

public final EdiType ediType()

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

public final String sampleDocument()

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.

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.

toBuilder

public TransformerSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TransformerSummary.Builder,TransformerSummary>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo