Skip to main content

Class: ExportSink

Represents an ExportSink.

Properties​

errorMessage​

errorMessage: string

An error message describing any issues with the export sink, if applicable.

health​

health: Health

The health status of the export sink.

lastHealthCheckTime?​

optional lastHealthCheckTime?: $Properties | null

The timestamp of the last health check performed on the export sink.

latestDataExportTime?​

optional latestDataExportTime?: $Properties | null

The timestamp of the latest successful data export.

name​

name: string

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

resourceVersion​

resourceVersion: string

The version of the export sink resource.

spec?​

optional spec?: $Properties | null

The specification details of the export sink.

state​

state: ResourceState

The current state of the export sink.

Methods​

toJSON()​

toJSON(): object

Converts this ExportSink to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ExportSink & $Properties

Creates a new ExportSink instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExportSink & $Properties

ExportSink instance

Call Signature​

static create(properties?): ExportSink

Creates a new ExportSink instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ExportSink

ExportSink instance

decode()​

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

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

ExportSink & $Properties

ExportSink

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ExportSink & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ExportSink & $Properties

ExportSink

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

Parameters​

message​

$Properties

ExportSink message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ExportSink message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ExportSink

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ExportSink

ExportSink

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ExportSink

ExportSink

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object