Skip to main content

Class: ExportSinkSpec

Represents an ExportSinkSpec.

Properties​

enabled​

enabled: boolean

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

gcs?​

optional gcs?: $Properties | null

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

name​

name: string

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

s3?​

optional s3?: $Properties | null

The S3 configuration details when destination_type is S3.

Methods​

toJSON()​

toJSON(): object

Converts this ExportSinkSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ExportSinkSpec & $Properties

Creates a new ExportSinkSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExportSinkSpec & $Properties

ExportSinkSpec instance

Call Signature​

static create(properties?): ExportSinkSpec

Creates a new ExportSinkSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExportSinkSpec

ExportSinkSpec instance

decode()​

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

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

ExportSinkSpec & $Properties

ExportSinkSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ExportSinkSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ExportSinkSpec & $Properties

ExportSinkSpec

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

Parameters​

message​

$Properties

ExportSinkSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ExportSinkSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ExportSinkSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ExportSinkSpec

ExportSinkSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ExportSinkSpec

ExportSinkSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object