Skip to main content

Class: ListDeploymentsRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

Properties​

namespace​

namespace: string

ListDeploymentsRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

ListDeploymentsRequest nextPageToken.

pageSize​

pageSize: number

ListDeploymentsRequest pageSize.

seriesName​

seriesName: string

Optional. Use to filter based on exact series name match.

Methods​

toJSON()​

toJSON(): object

Converts this ListDeploymentsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListDeploymentsRequest & $Properties

Creates a new ListDeploymentsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListDeploymentsRequest & $Properties

ListDeploymentsRequest instance

Call Signature​

static create(properties?): ListDeploymentsRequest

Creates a new ListDeploymentsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListDeploymentsRequest

ListDeploymentsRequest instance

decode()​

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

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

ListDeploymentsRequest & $Properties

ListDeploymentsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ListDeploymentsRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListDeploymentsRequest & $Properties

ListDeploymentsRequest

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

Parameters​

message​

$Properties

ListDeploymentsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListDeploymentsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListDeploymentsRequest

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

Parameters​

object​

Plain object

Returns​

ListDeploymentsRequest

ListDeploymentsRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListDeploymentsRequest

ListDeploymentsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object