Skip to main content

Class: KinesisSpec

Represents a KinesisSpec.

Properties​

destinationUri​

destinationUri: string

Destination Kinesis endpoint arn for temporal to send data to.

region​

region: string

The sink's region.

roleName​

roleName: string

The role Temporal Cloud assumes when writing records to Kinesis

Methods​

toJSON()​

toJSON(): object

Converts this KinesisSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): KinesisSpec & $Properties

Creates a new KinesisSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

KinesisSpec & $Properties

KinesisSpec instance

Call Signature​

static create(properties?): KinesisSpec

Creates a new KinesisSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

KinesisSpec

KinesisSpec instance

decode()​

static decode(reader, length?): KinesisSpec & $Properties

Decodes a KinesisSpec message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

KinesisSpec & $Properties

KinesisSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): KinesisSpec & $Properties

Decodes a KinesisSpec message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

KinesisSpec & $Properties

KinesisSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified KinesisSpec message. Does not implicitly temporal.api.cloud.sink.v1.KinesisSpec.verify|verify messages.

Parameters​

message​

$Properties

KinesisSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified KinesisSpec message, length delimited. Does not implicitly temporal.api.cloud.sink.v1.KinesisSpec.verify|verify messages.

Parameters​

message​

$Properties

KinesisSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): KinesisSpec

Creates a KinesisSpec message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

KinesisSpec

KinesisSpec

toObject()​

static toObject(message, options?): object

Creates a plain object from a KinesisSpec message. Also converts values to other types if specified.

Parameters​

message​

KinesisSpec

KinesisSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object