GenericRecord | hazelcast-client

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?: {}): GenericRecord

- Defined in src/serialization/generic_record/GenericRecord.ts:39
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: {}
  
  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

getArrayOfBoolean

getArrayOfBoolean(fieldName: string): boolean[]

- Defined in src/serialization/generic_record/GenericRecord.ts:178
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[]

getArrayOfDate

getArrayOfDate(fieldName: string): LocalDate[]

- Defined in src/serialization/generic_record/GenericRecord.ts:258
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[]

getArrayOfDecimal

getArrayOfDecimal(fieldName: string): BigDecimal[]

- Defined in src/serialization/generic_record/GenericRecord.ts:242
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[]

getArrayOfFloat32

getArrayOfFloat32(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:218
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[]

getArrayOfFloat64

getArrayOfFloat64(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:226
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[]

getArrayOfGenericRecord

getArrayOfGenericRecord(fieldName: string): GenericRecord[]

- Defined in src/serialization/generic_record/GenericRecord.ts:282
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[]

getArrayOfInt16

getArrayOfInt16(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:194
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[]

getArrayOfInt32

getArrayOfInt32(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:202
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[]

getArrayOfInt64

getArrayOfInt64(fieldName: string): Long[]

- Defined in src/serialization/generic_record/GenericRecord.ts:210
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[]

getArrayOfInt8

getArrayOfInt8(fieldName: string): Buffer

- Defined in src/serialization/generic_record/GenericRecord.ts:186
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

getArrayOfNullableBoolean

getArrayOfNullableBoolean(fieldName: string): boolean[]

- Defined in src/serialization/generic_record/GenericRecord.ts:346
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[]

getArrayOfNullableFloat32

getArrayOfNullableFloat32(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:386
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[]

getArrayOfNullableFloat64

getArrayOfNullableFloat64(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:394
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[]

getArrayOfNullableInt16

getArrayOfNullableInt16(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:362
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[]

getArrayOfNullableInt32

getArrayOfNullableInt32(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:370
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[]

getArrayOfNullableInt64

getArrayOfNullableInt64(fieldName: string): Long[]

- Defined in src/serialization/generic_record/GenericRecord.ts:378
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[]

getArrayOfNullableInt8

getArrayOfNullableInt8(fieldName: string): number[]

- Defined in src/serialization/generic_record/GenericRecord.ts:354
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[]

getArrayOfString

getArrayOfString(fieldName: string): string[]

- Defined in src/serialization/generic_record/GenericRecord.ts:234
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[]

getArrayOfTime

getArrayOfTime(fieldName: string): LocalTime[]

- Defined in src/serialization/generic_record/GenericRecord.ts:250
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[]

getArrayOfTimestamp

getArrayOfTimestamp(fieldName: string): LocalDateTime[]

- Defined in src/serialization/generic_record/GenericRecord.ts:266
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[]

getArrayOfTimestampWithTimezone

getArrayOfTimestampWithTimezone(fieldName: string): OffsetDateTime[]

- Defined in src/serialization/generic_record/GenericRecord.ts:274
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[]

getBoolean

getBoolean(fieldName: string): boolean

- Defined in src/serialization/generic_record/GenericRecord.ts:66
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

getDate

getDate(fieldName: string): LocalDate

- Defined in src/serialization/generic_record/GenericRecord.ts:146
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

getDecimal

getDecimal(fieldName: string): BigDecimal

- Defined in src/serialization/generic_record/GenericRecord.ts:130
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

getFieldKind

getFieldKind(fieldName: string): FieldKind

- Defined in src/serialization/generic_record/GenericRecord.ts:52
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

getFieldNames

getFieldNames(): Set<string>

- Defined in src/serialization/generic_record/GenericRecord.ts:44
Returns set of field names of this GenericRecord

Returns Set<string>

getFloat32

getFloat32(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:106
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

getFloat64

getFloat64(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:114
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

getGenericRecord

getGenericRecord(fieldName: string): GenericRecord

- Defined in src/serialization/generic_record/GenericRecord.ts:170
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

getInt16

getInt16(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:82
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

getInt32

getInt32(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:90
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

getInt64

getInt64(fieldName: string): Long

- Defined in src/serialization/generic_record/GenericRecord.ts:98
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

getInt8

getInt8(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:74
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

getNullableBoolean

getNullableBoolean(fieldName: string): boolean

- Defined in src/serialization/generic_record/GenericRecord.ts:290
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

getNullableFloat32

getNullableFloat32(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:330
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

getNullableFloat64

getNullableFloat64(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:338
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

getNullableInt16

getNullableInt16(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:306
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

getNullableInt32

getNullableInt32(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:314
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

getNullableInt64

getNullableInt64(fieldName: string): Long

- Defined in src/serialization/generic_record/GenericRecord.ts:322
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

getNullableInt8

getNullableInt8(fieldName: string): number

- Defined in src/serialization/generic_record/GenericRecord.ts:298
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

getString

getString(fieldName: string): string

- Defined in src/serialization/generic_record/GenericRecord.ts:122
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

getTime

getTime(fieldName: string): LocalTime

- Defined in src/serialization/generic_record/GenericRecord.ts:138
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

getTimestamp

getTimestamp(fieldName: string): LocalDateTime

- Defined in src/serialization/generic_record/GenericRecord.ts:154
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

getTimestampWithTimezone

getTimestampWithTimezone(fieldName: string): OffsetDateTime

- Defined in src/serialization/generic_record/GenericRecord.ts:162
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

hasField

hasField(fieldName: string): boolean

- Defined in src/serialization/generic_record/GenericRecord.ts:58
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

toString

toString(): string

- Defined in src/serialization/generic_record/GenericRecord.ts:400
Returns string representation of this generic record. The string representation is a valid JSON string.

Returns string

Hierarchy

Index

Methods

Methods

clone

Parameters

Optional fieldsToUpdate: {}

[fieldName: string]: any

Returns GenericRecord

getArrayOfBoolean

Parameters

fieldName: string

Returns boolean[]

getArrayOfDate

Parameters

fieldName: string

Returns LocalDate[]

getArrayOfDecimal

Parameters

fieldName: string

Returns BigDecimal[]

getArrayOfFloat32

Parameters

fieldName: string

Returns number[]

getArrayOfFloat64

Parameters

fieldName: string

Returns number[]

getArrayOfGenericRecord

Parameters

fieldName: string

Returns GenericRecord[]

getArrayOfInt16

Parameters

fieldName: string

Returns number[]

getArrayOfInt32

Parameters

fieldName: string

Returns number[]

getArrayOfInt64

Parameters

fieldName: string

Returns Long[]

getArrayOfInt8

Parameters

fieldName: string

Returns Buffer

getArrayOfNullableBoolean

Parameters

fieldName: string

Returns boolean[]

getArrayOfNullableFloat32

Parameters

fieldName: string

Returns number[]

getArrayOfNullableFloat64

Parameters

fieldName: string

Returns number[]

getArrayOfNullableInt16

Parameters

fieldName: string

Returns number[]

getArrayOfNullableInt32

Parameters

fieldName: string

Returns number[]

getArrayOfNullableInt64

Parameters

fieldName: string

Returns Long[]

getArrayOfNullableInt8

Parameters

fieldName: string

Returns number[]

getArrayOfString

Parameters

fieldName: string