blob: edaf10e2007b85a237653a5c6e1b50934bbe3f68 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.8.1/dotnetdoc/api/Apache.Ignite.Core.Binary.BinaryTypeConfiguration.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BinaryTypeConfiguration
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BinaryTypeConfiguration
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration">
<h1 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration" class="text-break">Class BinaryTypeConfiguration
</h1>
<div class="markdown level0 summary"><p>Binary type configuration.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">BinaryTypeConfiguration</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Binary.html">Apache.Ignite.Core.Binary</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class BinaryTypeConfiguration</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor">BinaryTypeConfiguration()</h4>
<div class="markdown level1 summary"><p>Constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BinaryTypeConfiguration()</code></pre>
</div>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_Apache_Ignite_Core_Binary_BinaryTypeConfiguration_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor(Apache.Ignite.Core.Binary.BinaryTypeConfiguration)">BinaryTypeConfiguration(BinaryTypeConfiguration)</h4>
<div class="markdown level1 summary"><p>Copying constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BinaryTypeConfiguration(BinaryTypeConfiguration cfg)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.html">BinaryTypeConfiguration</a></td>
<td><span class="parametername">cfg</span></td>
<td><p>Configuration to copy.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_System_String_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor(System.String)">BinaryTypeConfiguration(String)</h4>
<div class="markdown level1 summary"><p>Constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BinaryTypeConfiguration(string typeName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">typeName</span></td>
<td><p>Type name.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration__ctor_System_Type_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.#ctor(System.Type)">BinaryTypeConfiguration(Type)</h4>
<div class="markdown level1 summary"><p>Constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BinaryTypeConfiguration(Type type)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">type</span></td>
<td><p>Type.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_AffinityKeyFieldName_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.AffinityKeyFieldName*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_AffinityKeyFieldName" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.AffinityKeyFieldName">AffinityKeyFieldName</h4>
<div class="markdown level1 summary"><p>Affinity key field name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string AffinityKeyFieldName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_IdMapper_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.IdMapper*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_IdMapper" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.IdMapper">IdMapper</h4>
<div class="markdown level1 summary"><p>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. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IBinaryIdMapper IdMapper { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Binary.IBinaryIdMapper.html">IBinaryIdMapper</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_IsEnum_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.IsEnum*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_IsEnum" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.IsEnum">IsEnum</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this instance describes an enum type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsEnum { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_KeepDeserialized_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.KeepDeserialized*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_KeepDeserialized" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.KeepDeserialized">KeepDeserialized</h4>
<div class="markdown level1 summary"><p>Keep deserialized flag. If set to non-null value, overrides default value set in
<a class="xref" href="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.html">BinaryTypeConfiguration</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool ? KeepDeserialized { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_NameMapper_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.NameMapper*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_NameMapper" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.NameMapper">NameMapper</h4>
<div class="markdown level1 summary"><p>Name mapper for the given type. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IBinaryNameMapper NameMapper { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Binary.IBinaryNameMapper.html">IBinaryNameMapper</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_Serializer_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.Serializer*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_Serializer" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.Serializer">Serializer</h4>
<div class="markdown level1 summary"><p>Serializer for the given type. If not provided and class implements <a class="xref" href="Apache.Ignite.Core.Binary.IBinarizable.html">IBinarizable</a>
then its custom logic will be used. If not provided and class doesn&apos;t implement <a class="xref" href="Apache.Ignite.Core.Binary.IBinarizable.html">IBinarizable</a>
then all fields of the class except of those with [NotSerialized] attribute will be serialized
with help of reflection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IBinarySerializer Serializer { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Apache.Ignite.Core.Binary.IBinarySerializer.html">IBinarySerializer</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_TypeName_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.TypeName*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_TypeName" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.TypeName">TypeName</h4>
<div class="markdown level1 summary"><p>Fully qualified type name. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TypeName { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_ToString_" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.ToString*"></a>
<h4 id="Apache_Ignite_Core_Binary_BinaryTypeConfiguration_ToString" data-uid="Apache.Ignite.Core.Binary.BinaryTypeConfiguration.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A string that represents the current object.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.ToString()</span></div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>