Class: ExportSinkSpec

namespace.v1.ExportSinkSpec

Represents an ExportSinkSpec.

Implements

• IExportSinkSpec

Constructors

constructor

• new ExportSinkSpec(properties?): ExportSinkSpec

Constructs a new ExportSinkSpec.

Parameters

Name	Type	Description
properties?	IExportSinkSpec	Properties to set

Returns

ExportSinkSpec

Properties

enabled

• enabled: boolean

A flag indicating whether the export sink is enabled or not.

Implementation of

IExportSinkSpec.enabled

---

gcs

• Optional gcs: null | IGCSSpec

This is a feature under development. We will allow GCS sink support for GCP Namespaces. The GCS configuration details when destination_type is GCS.

Implementation of

IExportSinkSpec.gcs

---

name

• name: string

The unique name of the export sink, it can't be changed once set.

Implementation of

IExportSinkSpec.name

---

s3

• Optional s3: null | IS3Spec

The S3 configuration details when destination_type is S3.

Implementation of

IExportSinkSpec.s3

Methods

toJSON

▸ toJSON(): Object

Converts this ExportSinkSpec to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ExportSinkSpec

Creates a new ExportSinkSpec instance using the specified properties.

Parameters

Name	Type	Description
properties?	IExportSinkSpec	Properties to set

Returns

ExportSinkSpec

ExportSinkSpec instance

---

decode

▸ decode(reader, length?): ExportSinkSpec

Decodes an ExportSinkSpec 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

ExportSinkSpec

ExportSinkSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ExportSinkSpec

Decodes an ExportSinkSpec message from the specified reader or buffer, length delimited.

Parameters

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

Returns

ExportSinkSpec

ExportSinkSpec

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

Parameters

Name	Type	Description
message	IExportSinkSpec	ExportSinkSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IExportSinkSpec	ExportSinkSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ExportSinkSpec

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ExportSinkSpec

ExportSinkSpec

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ExportSinkSpec

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 an ExportSinkSpec message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ExportSinkSpec	ExportSinkSpec
options?	IConversionOptions	Conversion options

Returns

Object

Plain object