Skip to main content

Class: DescribeNamespaceRequest

Represents a DescribeNamespaceRequest.

Properties​

id​

id: string

DescribeNamespaceRequest id.

namespace​

namespace: string

DescribeNamespaceRequest namespace.

weakConsistency​

weakConsistency: boolean

If true, the server may serve the response from an eventually-consistent source instead of reading through to persistence. Defaults to false, which preserves read-after-write consistency. SDKs should set this when fetching namespace capabilities on worker/client startup.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeNamespaceRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeNamespaceRequest & $Properties

Creates a new DescribeNamespaceRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNamespaceRequest & $Properties

DescribeNamespaceRequest instance

Call Signature​

static create(properties?): DescribeNamespaceRequest

Creates a new DescribeNamespaceRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNamespaceRequest

DescribeNamespaceRequest instance

decode()​

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

Decodes a DescribeNamespaceRequest 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​

DescribeNamespaceRequest & $Properties

DescribeNamespaceRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeNamespaceRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeNamespaceRequest & $Properties

DescribeNamespaceRequest

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 DescribeNamespaceRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeNamespaceRequest.verify|verify messages.

Parameters​

message​

$Properties

DescribeNamespaceRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified DescribeNamespaceRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeNamespaceRequest.verify|verify messages.

Parameters​

message​

$Properties

DescribeNamespaceRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeNamespaceRequest

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

Parameters​

object​

Plain object

Returns​

DescribeNamespaceRequest

DescribeNamespaceRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeNamespaceRequest

DescribeNamespaceRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object