Show / Hide Table of Contents

# Interface IBinaryType

Binary type metadata.

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

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

##### Syntax

    public interface IBinaryType

### Properties

#### AffinityKeyFieldName

Gets optional affinity key field name.

##### Declaration

    string AffinityKeyFieldName { get; }

##### Property Value

Type | Description
--- | ---
System.String | Affinity key field name or null in case it is not provided.

#### Fields

Gets field names for that type.

##### Declaration

    ICollection<string> Fields { get; }

##### Property Value

Type | Description
--- | ---
System.Collections.Generic.ICollection<System.String> | Field names.

#### IsEnum

Gets a value indicating whether this type represents an enum.

##### Declaration

    bool IsEnum { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean | `true` if this instance represents an enum; otherwise, `false`.

#### TypeId

Gets the type identifier.

##### Declaration

    int TypeId { get; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

#### TypeName

Gets type name.

##### Declaration

    string TypeName { get; }

##### Property Value

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

### Methods

#### GetEnumValues()

Gets the enum values. Only valid when IsEnum is true.

##### Declaration

    IEnumerable<IBinaryObject> GetEnumValues()

##### Returns

Type | Description
--- | ---
System.Collections.Generic.IEnumerable<IBinaryObject> |

#### GetFieldTypeName(String)

Gets field type for the given field name.

##### Declaration

    string GetFieldTypeName(string fieldName)

##### Parameters

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

##### Returns

Type | Description
--- | ---
System.String | Field type.