Skip to main content

Class: PubSubSpec

Represents a PubSubSpec.

Properties​

gcpProjectId​

gcpProjectId: string

The gcp project id of pubsub topic and service account

serviceAccountId​

serviceAccountId: string

The customer service account id that Temporal Cloud impersonates for writing records to customer's pubsub topic

topicName​

topicName: string

Destination pubsub topic name for us

Methods​

toJSON()​

toJSON(): object

Converts this PubSubSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PubSubSpec & $Properties

Creates a new PubSubSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PubSubSpec & $Properties

PubSubSpec instance

Call Signature​

static create(properties?): PubSubSpec

Creates a new PubSubSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PubSubSpec

PubSubSpec instance

decode()​

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

Decodes a PubSubSpec 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​

PubSubSpec & $Properties

PubSubSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PubSubSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PubSubSpec & $Properties

PubSubSpec

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 PubSubSpec message. Does not implicitly temporal.api.cloud.sink.v1.PubSubSpec.verify|verify messages.

Parameters​

message​

$Properties

PubSubSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PubSubSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PubSubSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

PubSubSpec

PubSubSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PubSubSpec

PubSubSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object