Class: ListDeploymentsRequest
workflowservice.v1.ListDeploymentsRequest
Represents a ListDeploymentsRequest.
Implements
Constructors
constructor
• new ListDeploymentsRequest(properties?): ListDeploymentsRequest
Constructs a new ListDeploymentsRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListDeploymentsRequest | Properties to set |
Returns
Properties
namespace
• namespace: string
ListDeploymentsRequest namespace.
Implementation of
IListDeploymentsRequest.namespace
nextPageToken
• nextPageToken: Uint8Array
ListDeploymentsRequest nextPageToken.
Implementation of
IListDeploymentsRequest.nextPageToken
pageSize
• pageSize: number
ListDeploymentsRequest pageSize.
Implementation of
IListDeploymentsRequest.pageSize
seriesName
• seriesName: string
Optional. Use to filter based on exact series name match.
Implementation of
IListDeploymentsRequest.seriesName
Methods
toJSON
▸ toJSON(): Object
Converts this ListDeploymentsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListDeploymentsRequest
Creates a new ListDeploymentsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListDeploymentsRequest | Properties to set |
Returns
ListDeploymentsRequest instance
decode
▸ decode(reader, length?): ListDeploymentsRequest
Decodes a ListDeploymentsRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
ListDeploymentsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListDeploymentsRequest
Decodes a ListDeploymentsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListDeploymentsRequest
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 ListDeploymentsRequest message. Does not implicitly temporal.api.workflowservice.v1.ListDeploymentsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListDeploymentsRequest | ListDeploymentsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListDeploymentsRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListDeploymentsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListDeploymentsRequest | ListDeploymentsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListDeploymentsRequest
Creates a ListDeploymentsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListDeploymentsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListDeploymentsRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListDeploymentsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListDeploymentsRequest | ListDeploymentsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object