Interface IDynamoAttributeConverter
The IDynamo
Namespace: LambdaSharp.DynamoDB.Serialization.Converters
Assembly: LambdaSharp.DynamoDB.Serialization.dll
Syntax
public interface IDynamoAttributeConverter
Methods
CanConvert(Type)
The Can
Declaration
bool CanConvert(Type typeToConvert)
Parameters
Type | Name | Description |
---|---|---|
System. |
typeToConvert | The type to convert. |
Returns
Type | Description |
---|---|
System. |
|
FromBinary(MemoryStream, Type, DynamoSerializerOptions)
The From
Declaration
object FromBinary(MemoryStream value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromBinarySet(List<MemoryStream>, Type, DynamoSerializerOptions)
The FromBinarySet(List<MemoryStream>, Type, DynamoSerializerOptions) method converts a DynamoDB BS attribute value to the type of the converter.
Declaration
object FromBinarySet(List<MemoryStream> value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromBool(Boolean, Type, DynamoSerializerOptions)
The From
Declaration
object FromBool(bool value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromList(List<AttributeValue>, Type, DynamoSerializerOptions)
The FromList(List<AttributeValue>, Type, DynamoSerializerOptions) method converts a DynamoDB L attribute value to the type of the converter.
Declaration
object FromList(List<AttributeValue> value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromMap(Dictionary<String, AttributeValue>, Type, DynamoSerializerOptions)
The FromMap(Dictionary<String, AttributeValue>, Type, DynamoSerializerOptions) method converts a DynamoDB M attribute value to the type of the converter.
Declaration
object FromMap(Dictionary<string, AttributeValue> value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromNull(Type, DynamoSerializerOptions)
The From
Declaration
object FromNull(Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromNumber(String, Type, DynamoSerializerOptions)
The From
Declaration
object FromNumber(string value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromNumberSet(List<String>, Type, DynamoSerializerOptions)
The FromNumberSet(List<String>, Type, DynamoSerializerOptions) method converts a DynamoDB NS attribute value to the type of the converter.
Declaration
object FromNumberSet(List<string> value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromString(String, Type, DynamoSerializerOptions)
The From
Declaration
object FromString(string value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
FromStringSet(List<String>, Type, DynamoSerializerOptions)
The FromStringSet(List<String>, Type, DynamoSerializerOptions) method converts a DynamoDB SS attribute value to the type of the converter.
Declaration
object FromStringSet(List<string> value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The DynamoDB attribute value to convert. |
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
An instance of type |
GetDefaultValue(Type, DynamoSerializerOptions)
The Get
Declaration
object GetDefaultValue(Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
targetType | The expected return type. |
Dynamo |
options | The deserialization options. |
Returns
Type | Description |
---|---|
System. |
ToAttributeValue(Object, Type, DynamoSerializerOptions)
The To
Declaration
AttributeValue ToAttributeValue(object value, Type targetType, DynamoSerializerOptions options)
Parameters
Type | Name | Description |
---|---|---|
System. |
value | The value to convert. |
System. |
targetType | The source value type. |
Dynamo |
options | The serialization options. |
Returns
Type | Description |
---|---|
Amazon. |
A DynamoDB attribute value, or |