Show / Hide Table of Contents

# Class BinaryTypeConfiguration

Binary type configuration.

##### Inheritance

System.Object
BinaryTypeConfiguration

##### Inherited Members

System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()

###### Namespace: Apache.Ignite.Core.Binary

###### Assembly: Apache.Ignite.Core.dll

##### Syntax

    public class BinaryTypeConfiguration

### Constructors

#### BinaryTypeConfiguration()

Constructor.

##### Declaration

    public BinaryTypeConfiguration()

#### BinaryTypeConfiguration(BinaryTypeConfiguration)

Copying constructor.

##### Declaration

    public BinaryTypeConfiguration(BinaryTypeConfiguration cfg)

##### Parameters

Type | Name | Description
--- | --- | ---
BinaryTypeConfiguration | cfg | Configuration to copy.

#### BinaryTypeConfiguration(String)

Constructor.

##### Declaration

    public BinaryTypeConfiguration(string typeName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | typeName | Type name.

#### BinaryTypeConfiguration(Type)

Constructor.

##### Declaration

    public BinaryTypeConfiguration(Type type)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Type | type | Type.

### Properties

#### AffinityKeyFieldName

Affinity key field name.

##### Declaration

    public string AffinityKeyFieldName { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

#### IdMapper

ID mapper for the given type. When it is necessary to resolve class (field) ID, then this property will be checked first. Otherwise, ID will be hash code of the class (field) simple name in lower case.

##### Declaration

    public IBinaryIdMapper IdMapper { get; set; }

##### Property Value

Type | Description
--- | ---
IBinaryIdMapper |

#### IsEnum

Gets or sets a value indicating whether this instance describes an enum type.

##### Declaration

    public bool IsEnum { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

#### KeepDeserialized

Keep deserialized flag. If set to non-null value, overrides default value set in BinaryTypeConfiguration.

##### Declaration

    public bool ? KeepDeserialized { get; set; }

##### Property Value

Type | Description
--- | ---
System.Nullable<System.Boolean> |

#### NameMapper

Name mapper for the given type.

##### Declaration

    public IBinaryNameMapper NameMapper { get; set; }

##### Property Value

Type | Description
--- | ---
IBinaryNameMapper |

#### Serializer

Serializer for the given type. If not provided and class implements IBinarizable then its custom logic will be used. If not provided and class doesn't implement IBinarizable then all fields of the class except of those with [NotSerialized] attribute will be serialized with help of reflection.

##### Declaration

    public IBinarySerializer Serializer { get; set; }

##### Property Value

Type | Description
--- | ---
IBinarySerializer |

#### TypeName

Fully qualified type name.

##### Declaration

    public string TypeName { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

### Methods

#### ToString()

Returns a string that represents the current object.

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
System.String | A string that represents the current object.

##### Overrides

System.Object.ToString()