Class CreateTransformerRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTransformerRequest.Builder,
CreateTransformerRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Reserved for future use.final EdiType
ediType()
Specifies the details for the EDI standard that is being used for the transformer.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FileFormat
Specifies that the currently supported file formats for EDI transformations areJSON
andXML
.final String
Specifies that the currently supported file formats for EDI transformations areJSON
andXML
.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Specifies the mapping template for the transformer.final String
name()
Specifies the name of the transformer, used to identify it.final String
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.static Class
<? extends CreateTransformerRequest.Builder> tags()
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
Specifies the name of the transformer, used to identify it.
- Returns:
- Specifies the name of the transformer, used to identify it.
-
fileFormat
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
.If the service returns an enum value that is not available in the current SDK version,
fileFormat
will returnFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- Returns:
- Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - See Also:
-
fileFormatAsString
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
.If the service returns an enum value that is not available in the current SDK version,
fileFormat
will returnFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- Returns:
- Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
. - See Also:
-
mappingTemplate
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
- Returns:
- Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
-
ediType
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
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.
-
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<CreateTransformerRequest.Builder,
CreateTransformerRequest> - Specified by:
toBuilder
in classB2BiRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-