Kinetica   C#   API  Version 7.2.3.0
Avro.ArraySchema Class Reference

Class for array type schemas More...

+ Inheritance diagram for Avro.ArraySchema:
+ Collaboration diagram for Avro.ArraySchema:

Public Member Functions

override bool CanRead (Schema writerSchema)
 Checks if this schema can read data written by the given schema. More...
 
override bool Equals (object obj)
 Function to compare equality of two array schemas More...
 
override int GetHashCode ()
 Hashcode function More...
 
- Public Member Functions inherited from Avro.Schema
override string ToString ()
 Returns the canonical JSON representation of this schema. More...
 
string GetProperty (string key)
 Returns the schema's custom property value given the property name More...
 
override int GetHashCode ()
 Hash code function More...
 

Protected Member Functions

internal override void WriteJsonFields (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
 Writes the array schema in JSON format More...
 
- Protected Member Functions inherited from Avro.UnnamedSchema
 UnnamedSchema (Type type, PropertyMap props)
 
- Protected Member Functions inherited from Avro.Schema
 Schema (Type type, PropertyMap props)
 Constructor for schema class More...
 
virtual internal void WriteJsonFields (JsonTextWriter writer, SchemaNames names, string encspace)
 Default implementation for writing schema properties in JSON format More...
 
virtual internal void WriteJson (JsonTextWriter writer, SchemaNames names, string encspace)
 Writes schema object in JSON format More...
 

Properties

Schema ItemSchema [get, set]
 Schema for the array 'type' attribute More...
 
- Properties inherited from Avro.UnnamedSchema
override string Name [get]
 
- Properties inherited from Avro.Schema
Type Tag [get]
 Schema type property More...
 
abstract string Name [get]
 The name of this schema. More...
 

Additional Inherited Members

- Public Types inherited from Avro.Schema
enum  Type {
  Type.Null,
  Type.Boolean,
  Type.Int,
  Type.Long,
  Type.Float,
  Type.Double,
  Type.Bytes,
  Type.String,
  Type.Record,
  Type.Enumeration,
  Type.Array,
  Type.Map,
  Type.Union,
  Type.Fixed,
  Type.Error
}
 Enum for schema types More...
 
- Static Public Member Functions inherited from Avro.Schema
static Schema Parse (string json)
 Parses a given JSON string to create a new schema object More...
 
static string GetTypeString (Type type)
 Returns symbol name for the given schema type More...
 
- Static Protected Member Functions inherited from Avro.Schema
static bool areEqual (object o1, object o2)
 Compares two objects, null is equal to null More...
 
static int getHashCode (object obj)
 Hash code helper function More...
 

Detailed Description

Class for array type schemas

Definition at line 27 of file ArraySchema.cs.

Member Function Documentation

◆ CanRead()

override bool Avro.ArraySchema.CanRead ( Schema  writerSchema)
inlinevirtual

Checks if this schema can read data written by the given schema.

Used for decoding data.

Parameters
writerSchemawriter schema
Returns
true if this and writer schema are compatible based on the AVRO specification, false otherwise

Reimplemented from Avro.Schema.

Definition at line 76 of file ArraySchema.cs.

◆ Equals()

override bool Avro.ArraySchema.Equals ( object  obj)
inline

Function to compare equality of two array schemas

Parameters
objother array schema
Returns
true two schemas are equal, false otherwise

Definition at line 89 of file ArraySchema.cs.

◆ GetHashCode()

override int Avro.ArraySchema.GetHashCode ( )
inline

Hashcode function

Returns

Definition at line 106 of file ArraySchema.cs.

◆ WriteJsonFields()

internal override void Avro.ArraySchema.WriteJsonFields ( Newtonsoft.Json.JsonTextWriter  writer,
SchemaNames  names,
string  encspace 
)
inlineprotected

Writes the array schema in JSON format

Parameters
writerJSON writer
nameslist of named schemas already written
encspaceenclosing namespace

Definition at line 65 of file ArraySchema.cs.

Property Documentation

◆ ItemSchema

Schema Avro.ArraySchema.ItemSchema
getset

Schema for the array 'type' attribute

Definition at line 32 of file ArraySchema.cs.


The documentation for this class was generated from the following file: