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
▸ create(properties?): KinesisSpec & $Properties
Creates a new KinesisSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
KinesisSpec instance
▸ create(properties?): KinesisSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): KinesisSpec & $Properties
Decodes a KinesisSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
KinesisSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): KinesisSpec & $Properties
Decodes a KinesisSpec message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
KinesisSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified KinesisSpec message. Does not implicitly temporal.api.cloud.sink.v1.KinesisSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | KinesisSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified KinesisSpec message, length delimited. Does not implicitly temporal.api.cloud.sink.v1.KinesisSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | KinesisSpec message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): KinesisSpec
Creates a KinesisSpec message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
KinesisSpec
toObject
▸ toObject(message, options?): Object
Creates a plain object from a KinesisSpec message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | KinesisSpec | KinesisSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object