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

Class UpdateTransformerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTransformerRequest.Builder,UpdateTransformerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateTransformerRequest
extends B2BiRequest
implements ToCopyableBuilder<UpdateTransformerRequest.Builder,UpdateTransformerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateTransformerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateTransformerRequest.Builder	builder()
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()
InputConversion	inputConversion()	To update, 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()	Specify a new name for the transformer, if you want to update it.
OutputConversion	outputConversion()	To update, specify 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 UpdateTransformerRequest.Builder>	serializableBuilderClass()
TransformerStatus	status()	Specifies the transformer's status.
String	statusAsString()	Specifies the transformer's status.
UpdateTransformerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transformerId()	Specifies the system-assigned unique identifier for the transformer.

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

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.

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

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

To update, specify the InputConversion object, which contains the format options for the inbound transformation.

Returns:

To update, 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()

To update, specify the OutputConversion object, which contains the format options for the outbound transformation.

Returns:

To update, specify 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 UpdateTransformerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTransformerRequest.Builder,UpdateTransformerRequest>

Specified by:

toBuilder in class B2BiRequest

builder

public static UpdateTransformerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateTransformerRequest.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