Class Mapping
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Mapping.Builder,
Mapping>
Specifies the mapping of data property keys.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Mapping.Builder
builder()
children()
Only applicable to nested data structures.final Boolean
dropped()
If true, then the column is removed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.fromPath()
The table or column to be modified.final String
fromType()
The type of the data to be modified.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Children property.final boolean
For responses, this returns true if the service returned a value for the FromPath property.final int
hashCode()
static Class
<? extends Mapping.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toKey()
After the apply mapping, what the name of the column should be.final String
toString()
Returns a string representation of this object.final String
toType()
The data type that the data is to be modified to.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
toKey
After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.- Returns:
- After the apply mapping, what the name of the column should be. Can be the same as
FromPath
.
-
hasFromPath
public final boolean hasFromPath()For responses, this returns true if the service returned a value for the FromPath 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. -
fromPath
The table or column to be modified.
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
hasFromPath()
method.- Returns:
- The table or column to be modified.
-
fromType
The type of the data to be modified.
- Returns:
- The type of the data to be modified.
-
toType
The data type that the data is to be modified to.
- Returns:
- The data type that the data is to be modified to.
-
dropped
If true, then the column is removed.
- Returns:
- If true, then the column is removed.
-
hasChildren
public final boolean hasChildren()For responses, this returns true if the service returned a value for the Children 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. -
children
Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also
Mapping
, but itsFromPath
will be the parent'sFromPath
plus theFromPath
from this structure.For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a
Mapping
that looks like:{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
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
hasChildren()
method.- Returns:
- Only applicable to nested data structures. If you want to change the parent structure, but also one of
its children, you can fill out this data strucutre. It is also
Mapping
, but itsFromPath
will be the parent'sFromPath
plus theFromPath
from this structure.For the children part, suppose you have the structure:
{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
You can specify a
Mapping
that looks like:{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": [{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }] }
-
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<Mapping.Builder,
Mapping> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-