Skip to main content

Class: DescribeNamespaceRequest

workflowservice.v1.DescribeNamespaceRequest

Represents a DescribeNamespaceRequest.

Implements

Constructors

constructor

new DescribeNamespaceRequest(properties?)

Constructs a new DescribeNamespaceRequest.

Parameters

NameTypeDescription
properties?IDescribeNamespaceRequestProperties to set

Properties

id

id: string

DescribeNamespaceRequest id.

Implementation of

IDescribeNamespaceRequest.id


namespace

namespace: string

DescribeNamespaceRequest namespace.

Implementation of

IDescribeNamespaceRequest.namespace

Methods

toJSON

toJSON(): Object

Converts this DescribeNamespaceRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): DescribeNamespaceRequest

Creates a new DescribeNamespaceRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeNamespaceRequestProperties to set

Returns

DescribeNamespaceRequest

DescribeNamespaceRequest instance


decode

Static decode(reader, length?): DescribeNamespaceRequest

Decodes a DescribeNamespaceRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

DescribeNamespaceRequest

DescribeNamespaceRequest


decodeDelimited

Static decodeDelimited(reader): DescribeNamespaceRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DescribeNamespaceRequest

DescribeNamespaceRequest


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIDescribeNamespaceRequestDescribeNamespaceRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIDescribeNamespaceRequestDescribeNamespaceRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

DescribeNamespaceRequest

DescribeNamespaceRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeNamespaceRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageDescribeNamespaceRequestDescribeNamespaceRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object