Show / Hide Table of Contents

# Interface IBinaryObject

Wrapper for serialized objects.

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

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

##### Syntax

    public interface IBinaryObject

### Properties

#### EnumName

Gets the name of the underlying enum value.

##### Declaration

    string EnumName { get; }

##### Property Value

Type | Description
--- | ---
System.String | The name of the enum value.

#### EnumValue

Gets the value of underlying enum in int form.

##### Declaration

    int EnumValue { get; }

##### Property Value

Type | Description
--- | ---
System.Int32 | The value of underlying enum in int form.

### Methods

#### Deserialize<T>()

Gets fully deserialized instance of binary object.

##### Declaration

    T Deserialize<T>()

##### Returns

Type | Description
--- | ---
T | Fully deserialized instance of binary object.

##### Type Parameters

Name | Description
--- | ---
T |

#### GetBinaryType()

Gets object metadata.

##### Declaration

    IBinaryType GetBinaryType()

##### Returns

Type | Description
--- | ---
IBinaryType | Metadata.

#### GetField<TF>(String)

Gets field value.

##### Declaration

    TF GetField<TF>(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Field name.

##### Returns

Type | Description
--- | ---
TF | Field value.

##### Type Parameters

Name | Description
--- | ---
TF |

#### HasField(String)

Determines whether the field with specified name exists in this instance.

##### Declaration

    bool HasField(string fieldName)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | fieldName | Name of the field.

##### Returns

Type | Description
--- | ---
System.Boolean | True if there is a field with specified name; false otherwise.

#### ToBuilder()

Creates a new IBinaryObjectBuilder based on this object.

This is equivalent to GetBuilder(IBinaryObject).

##### Declaration

    IBinaryObjectBuilder ToBuilder()

##### Returns

Type | Description
--- | ---
IBinaryObjectBuilder | New IBinaryObjectBuilder based on this object.