Skip to main content

Class: UpdateNamespaceExportSinkRequest

cloudservice.v1.UpdateNamespaceExportSinkRequest

Represents an UpdateNamespaceExportSinkRequest.

Properties​

asyncOperationId​

• asyncOperationId: string

The ID to use for this async operation - optional.


namespace​

• namespace: string

The namespace to which the sink belongs.


resourceVersion​

• resourceVersion: string

The version of the sink to update. The latest version can be retrieved using the GetNamespaceExportSink call.


spec​

• Optional spec: null | $Properties

The updated export sink specification.

Methods​

toJSON​

▸ toJSON(): Object

Converts this UpdateNamespaceExportSinkRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): UpdateNamespaceExportSinkRequest & $Properties

Creates a new UpdateNamespaceExportSinkRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

UpdateNamespaceExportSinkRequest & $Properties

UpdateNamespaceExportSinkRequest instance

▸ create(properties?): UpdateNamespaceExportSinkRequest

Parameters​

NameType
properties?$Properties

Returns​

UpdateNamespaceExportSinkRequest


decode​

▸ decode(reader, length?): UpdateNamespaceExportSinkRequest & $Properties

Decodes an UpdateNamespaceExportSinkRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

UpdateNamespaceExportSinkRequest & $Properties

UpdateNamespaceExportSinkRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): UpdateNamespaceExportSinkRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

UpdateNamespaceExportSinkRequest & $Properties

UpdateNamespaceExportSinkRequest

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

Parameters​

NameTypeDescription
message$PropertiesUpdateNamespaceExportSinkRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesUpdateNamespaceExportSinkRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): UpdateNamespaceExportSinkRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

UpdateNamespaceExportSinkRequest

UpdateNamespaceExportSinkRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageUpdateNamespaceExportSinkRequestUpdateNamespaceExportSinkRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object