Interface GenericRecord

A generic object interface that is returned to the user when the domain class can not be created from any of the distributed Hazelcast data structures like IMap, IQueue etc.

GenericRecord also allows reading from a cluster without having the classes on the client side. This way, the clients can read and write objects back to the cluster without the need to have the domain classes.

GenericRecords is only supported for Compact serializable objects.

Hierarchy

GenericRecord

Methods

clone

clone(fieldsToUpdate?: {
[fieldName: string]: any;
}): GenericRecord
Clones this generic record and returns a new one.

Throws
TypeError if the type of any value does not match with its field type.

Throws
RangeError if any provided fieldName does not exist in the record or a field value provided is out of range.
Parameters
- Optional fieldsToUpdate: {
  [fieldName: string]: any;
  }
  
  If provided, some fields of the returned generic record will be updated. Keys of this object are fieldNames and values are field values.
  - [fieldName: string]: any
Returns GenericRecord
- Defined in src/serialization/generic_record/GenericRecord.ts:39

getArrayOfBoolean

getArrayOfBoolean(fieldName: string): boolean[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns boolean[]
- Defined in src/serialization/generic_record/GenericRecord.ts:178

getArrayOfDate

getArrayOfDate(fieldName: string): LocalDate[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalDate[]
- Defined in src/serialization/generic_record/GenericRecord.ts:258

getArrayOfDecimal

getArrayOfDecimal(fieldName: string): BigDecimal[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns BigDecimal[]
- Defined in src/serialization/generic_record/GenericRecord.ts:242

getArrayOfFloat32

getArrayOfFloat32(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:218

getArrayOfFloat64

getArrayOfFloat64(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:226

getArrayOfGenericRecord

getArrayOfGenericRecord(fieldName: string): GenericRecord[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns GenericRecord[]
- Defined in src/serialization/generic_record/GenericRecord.ts:282

getArrayOfInt16

getArrayOfInt16(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:194

getArrayOfInt32

getArrayOfInt32(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:202

getArrayOfInt64

getArrayOfInt64(fieldName: string): Long[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns Long[]
- Defined in src/serialization/generic_record/GenericRecord.ts:210

getArrayOfInt8

getArrayOfInt8(fieldName: string): Buffer
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns Buffer
- Defined in src/serialization/generic_record/GenericRecord.ts:186

getArrayOfNullableBoolean

getArrayOfNullableBoolean(fieldName: string): boolean[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns boolean[]
- Defined in src/serialization/generic_record/GenericRecord.ts:346

getArrayOfNullableFloat32

getArrayOfNullableFloat32(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:386

getArrayOfNullableFloat64

getArrayOfNullableFloat64(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:394

getArrayOfNullableInt16

getArrayOfNullableInt16(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:362

getArrayOfNullableInt32

getArrayOfNullableInt32(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:370

getArrayOfNullableInt64

getArrayOfNullableInt64(fieldName: string): Long[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns Long[]
- Defined in src/serialization/generic_record/GenericRecord.ts:378

getArrayOfNullableInt8

getArrayOfNullableInt8(fieldName: string): number[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number[]
- Defined in src/serialization/generic_record/GenericRecord.ts:354

getArrayOfString

getArrayOfString(fieldName: string): string[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns string[]
- Defined in src/serialization/generic_record/GenericRecord.ts:234

getArrayOfTime

getArrayOfTime(fieldName: string): LocalTime[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalTime[]
- Defined in src/serialization/generic_record/GenericRecord.ts:250

getArrayOfTimestamp

getArrayOfTimestamp(fieldName: string): LocalDateTime[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalDateTime[]
- Defined in src/serialization/generic_record/GenericRecord.ts:266

getArrayOfTimestampWithTimezone

getArrayOfTimestampWithTimezone(fieldName: string): OffsetDateTime[]
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns OffsetDateTime[]
- Defined in src/serialization/generic_record/GenericRecord.ts:274

getBoolean

getBoolean(fieldName: string): boolean
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns boolean
- Defined in src/serialization/generic_record/GenericRecord.ts:66

getDate

getDate(fieldName: string): LocalDate
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalDate
- Defined in src/serialization/generic_record/GenericRecord.ts:146

getDecimal

getDecimal(fieldName: string): BigDecimal
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns BigDecimal
- Defined in src/serialization/generic_record/GenericRecord.ts:130

getFieldKind

getFieldKind(fieldName: string): FieldKind
Returns field type for the given field name

Throws
RangeError if the field name does not exist in the generic record
Parameters
- fieldName: string
  
  the name of the field
Returns FieldKind
- Defined in src/serialization/generic_record/GenericRecord.ts:52

getFieldNames

getFieldNames(): Set<string>
Returns set of field names of this GenericRecord

Returns Set<string>
- Defined in src/serialization/generic_record/GenericRecord.ts:44

getFloat32

getFloat32(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:106

getFloat64

getFloat64(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:114

getGenericRecord

getGenericRecord(fieldName: string): GenericRecord
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns GenericRecord
- Defined in src/serialization/generic_record/GenericRecord.ts:170

getInt16

getInt16(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:82

getInt32

getInt32(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:90

getInt64

getInt64(fieldName: string): Long
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns Long
- Defined in src/serialization/generic_record/GenericRecord.ts:98

getInt8

getInt8(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:74

getNullableBoolean

getNullableBoolean(fieldName: string): boolean
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns boolean
- Defined in src/serialization/generic_record/GenericRecord.ts:290

getNullableFloat32

getNullableFloat32(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:330

getNullableFloat64

getNullableFloat64(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:338

getNullableInt16

getNullableInt16(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:306

getNullableInt32

getNullableInt32(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:314

getNullableInt64

getNullableInt64(fieldName: string): Long
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns Long
- Defined in src/serialization/generic_record/GenericRecord.ts:322

getNullableInt8

getNullableInt8(fieldName: string): number
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns number
- Defined in src/serialization/generic_record/GenericRecord.ts:298

getString

getString(fieldName: string): string
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns string
- Defined in src/serialization/generic_record/GenericRecord.ts:122

getTime

getTime(fieldName: string): LocalTime
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalTime
- Defined in src/serialization/generic_record/GenericRecord.ts:138

getTimestamp

getTimestamp(fieldName: string): LocalDateTime
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns LocalDateTime
- Defined in src/serialization/generic_record/GenericRecord.ts:154

getTimestampWithTimezone

getTimestampWithTimezone(fieldName: string): OffsetDateTime
Returns value of the field.

Throws
HazelcastSerializationError if the field name does not exist in the generic record or the type of the field does not match the one in the generic record.
Parameters
- fieldName: string
  
  the name of the field
Returns OffsetDateTime
- Defined in src/serialization/generic_record/GenericRecord.ts:162

hasField

hasField(fieldName: string): boolean
Returns true if field exists in the definition of the class. Note that returns true even if the field is null.
Parameters
- fieldName: string
  
  the name of the field
Returns boolean
- Defined in src/serialization/generic_record/GenericRecord.ts:58

toString

toString(): string
Returns string representation of this generic record. The string representation is a valid JSON string.

Returns string
- Defined in src/serialization/generic_record/GenericRecord.ts:400

Interface GenericRecord

Hierarchy

Index

Methods

Methods

clone

Throws

Throws

Parameters

Optional fieldsToUpdate: { [fieldName: string]: any; }

[fieldName: string]: any

Returns GenericRecord

getArrayOfBoolean

Throws

Parameters

fieldName: string

Returns boolean[]

getArrayOfDate

Throws

Parameters

fieldName: string

Returns LocalDate[]

getArrayOfDecimal

Throws

Parameters

fieldName: string

Returns BigDecimal[]

getArrayOfFloat32

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfFloat64

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfGenericRecord

Throws

Parameters

fieldName: string

Returns GenericRecord[]

getArrayOfInt16

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfInt32

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfInt64

Throws

Parameters

fieldName: string

Returns Long[]

getArrayOfInt8

Throws

Parameters

fieldName: string

Returns Buffer

getArrayOfNullableBoolean

Throws

Parameters

fieldName: string

Returns boolean[]

getArrayOfNullableFloat32

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfNullableFloat64

Throws

Parameters

fieldName: string

Returns number[]

getArrayOfNullableInt16

Throws

Parameters

`Optional` fieldsToUpdate: {
[fieldName: string]: any;
}