Class: PubSubSpec

sink.v1.PubSubSpec

Represents a PubSubSpec.

Implements

• IPubSubSpec

Constructors

constructor

• new PubSubSpec(properties?): PubSubSpec

Constructs a new PubSubSpec.

Parameters

Name	Type	Description
properties?	IPubSubSpec	Properties to set

Returns

PubSubSpec

Properties

gcpProjectId

• gcpProjectId: string

The gcp project id of pubsub topic and service account

Implementation of

IPubSubSpec.gcpProjectId

---

serviceAccountId

• serviceAccountId: string

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

Implementation of

IPubSubSpec.serviceAccountId

---

topicName

• topicName: string

Destination pubsub topic name for us

Implementation of

IPubSubSpec.topicName

Methods

toJSON

▸ toJSON(): Object

Converts this PubSubSpec to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PubSubSpec

Creates a new PubSubSpec instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPubSubSpec	Properties to set

Returns

PubSubSpec

PubSubSpec instance

---

decode

▸ decode(reader, length?): PubSubSpec

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

PubSubSpec

PubSubSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PubSubSpec

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PubSubSpec

PubSubSpec

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

Parameters

Name	Type	Description
message	IPubSubSpec	PubSubSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPubSubSpec	PubSubSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PubSubSpec

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PubSubSpec

PubSubSpec

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PubSubSpec

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	PubSubSpec	PubSubSpec
options?	IConversionOptions	Conversion options

Returns

Object

Plain object