Class UpdateAggregateInstruction

Represents an UpdateAggregateInstruction.

Hierarchy

UpdateAggregateInstruction

Implements

IUpdateAggregateInstruction

Index

Constructors

constructor

Methods

Constructors

constructor

new UpdateAggregateInstruction(properties?: IUpdateAggregateInstruction): UpdateAggregateInstruction

- Defined in compiled.d.ts:3543
Constructs a new UpdateAggregateInstruction.

Parameters
- Optional properties: IUpdateAggregateInstruction
Returns UpdateAggregateInstruction

Methods

toJSON

toJSON(): {}

- Defined in compiled.d.ts:3619
Converts this UpdateAggregateInstruction to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: IUpdateAggregateInstruction): UpdateAggregateInstruction

- Defined in compiled.d.ts:3556
Creates a new UpdateAggregateInstruction instance using the specified properties.

Parameters
- Optional properties: IUpdateAggregateInstruction
Returns UpdateAggregateInstruction

UpdateAggregateInstruction instance

Static decode

decode(reader: Uint8Array | Reader, length?: number): UpdateAggregateInstruction

- Defined in compiled.d.ts:3582
Decodes an UpdateAggregateInstruction message from the specified reader or buffer.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
- Optional length: number
Returns UpdateAggregateInstruction

UpdateAggregateInstruction

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): UpdateAggregateInstruction

- Defined in compiled.d.ts:3591
Decodes an UpdateAggregateInstruction message from the specified reader or buffer, length delimited.

throws

{Error} If the payload is not a reader or valid buffer

throws

{$protobuf.util.ProtocolError} If required fields are missing

Parameters
- reader: Uint8Array | Reader
  
  Reader or buffer to decode from
Returns UpdateAggregateInstruction

UpdateAggregateInstruction

Static encode

encode(message: IUpdateAggregateInstruction, writer?: Writer): Writer

- Defined in compiled.d.ts:3564
Encodes the specified UpdateAggregateInstruction message. Does not implicitly verify messages.

Parameters
- message: IUpdateAggregateInstruction
  
  UpdateAggregateInstruction message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

encodeDelimited(message: IUpdateAggregateInstruction, writer?: Writer): Writer

- Defined in compiled.d.ts:3572
Encodes the specified UpdateAggregateInstruction message, length delimited. Does not implicitly verify messages.

Parameters
- message: IUpdateAggregateInstruction
  
  UpdateAggregateInstruction message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): UpdateAggregateInstruction

- Defined in compiled.d.ts:3605
Creates an UpdateAggregateInstruction message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns UpdateAggregateInstruction

UpdateAggregateInstruction

Static toObject

toObject(message: UpdateAggregateInstruction, options?: IConversionOptions): {}

- Defined in compiled.d.ts:3613
Creates a plain object from an UpdateAggregateInstruction message. Also converts values to other types if specified.

Parameters
- message: UpdateAggregateInstruction
  
  UpdateAggregateInstruction
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): null | string

- Defined in compiled.d.ts:3598
Verifies an UpdateAggregateInstruction message.

Parameters
- message: {}
  
  Plain object to verify
  - [k: string]: any
Returns null | string

null if valid, otherwise the reason why it is not

Generated using TypeDoc