Class: Deimos::SchemaClass::Record

Inherits:

Base

• Object
• Base
• Deimos::SchemaClass::Record

Defined in:

sig/defs.rbs

Overview

Base Class of Record Classes generated from Avro.

Instance Attribute Summary

• #tombstone_key ⇒ Object

  Returns the value of attribute tombstone_key.

Class Method Summary

• .initialize_from_value ⇒ SchemaClass::Record

Instance Method Summary

• #[] ⇒ Object

  Element access method as if this Object were a hash.

• #full_schema ⇒ String

  Returns the full schema name of the inheriting class.

• #merge ⇒ SchemaClass::Base

  Merge a hash or an identical schema object with this one and return a new object.

• #namespace ⇒ String

  Returns the namespace for the schema of the inheriting class.

• #schema ⇒ String

  Returns the schema name of the inheriting class.

• #schema_fields ⇒ ::Array[String]

  @return — an array of fields names in the schema.

• #to_h ⇒ ::Hash[untyped, untyped]

  Converts the object attributes to a hash which can be used for Kafka.

• #validator ⇒ Deimos::SchemaBackends::Base

  Returns the schema validator from the schema backend.

• #with_indifferent_access ⇒ SchemaClass::Record

Methods inherited from Base

#==, #[]=, #as_json, #hash, #initialize, #inspect

Constructor Details

This class inherits a constructor from Deimos::SchemaClass::Base

Instance Attribute Details

#tombstone_key ⇒ Object

Returns the value of attribute tombstone_key.

Returns:

• (Object)

# File 'sig/defs.rbs', line 802

def tombstone_key
  @tombstone_key
end

Class Method Details

.initialize_from_value ⇒ SchemaClass::Record

Parameters:

• value (Object)

Returns:

• (SchemaClass::Record)

# File 'sig/defs.rbs', line 799

def self.initialize_from_value: (Object value) -> SchemaClass::Record

Instance Method Details

#[] ⇒ Object

Element access method as if this Object were a hash

@param key

@return — The value of the attribute if exists, nil otherwise

Parameters:

• key (String, Symbol)

Returns:

• (Object)

# File 'sig/defs.rbs', line 780

def []: ((String | Symbol) key) -> Object

#full_schema ⇒ String

Returns the full schema name of the inheriting class.

Returns:

• (String)

# File 'sig/defs.rbs', line 791

def full_schema: () -> String

#merge ⇒ SchemaClass::Base

Merge a hash or an identical schema object with this one and return a new object.

@param other_hash

Parameters:

• other_hash (::Hash[untyped, untyped], SchemaClass::Base)

Returns:

• (SchemaClass::Base)

# File 'sig/defs.rbs', line 773

def merge: ((::Hash[untyped, untyped] | SchemaClass::Base) other_hash) -> SchemaClass::Base

#namespace ⇒ String

Returns the namespace for the schema of the inheriting class.

Returns:

• (String)

# File 'sig/defs.rbs', line 788

def namespace: () -> String

#schema ⇒ String

Returns the schema name of the inheriting class.

Returns:

• (String)

# File 'sig/defs.rbs', line 785

def schema: () -> String

#schema_fields ⇒ ::Array[String]

@return — an array of fields names in the schema.

Returns:

• (::Array[String])

# File 'sig/defs.rbs', line 797

def schema_fields: () -> ::Array[String]

#to_h ⇒ ::Hash[untyped, untyped]

Converts the object attributes to a hash which can be used for Kafka

@return — the payload as a hash.

Returns:

• (::Hash[untyped, untyped])

# File 'sig/defs.rbs', line 768

def to_h: () -> ::Hash[untyped, untyped]

#validator ⇒ Deimos::SchemaBackends::Base

Returns the schema validator from the schema backend

Returns:

• (Deimos::SchemaBackends::Base)

# File 'sig/defs.rbs', line 794

def validator: () -> Deimos::SchemaBackends::Base

#with_indifferent_access ⇒ SchemaClass::Record

Returns:

• (SchemaClass::Record)

# File 'sig/defs.rbs', line 782

def with_indifferent_access: () -> SchemaClass::Record