Class: GetNamespacesRequest
cloudservice.v1.GetNamespacesRequest
Represents a GetNamespacesRequest.
Implements
Constructors
constructor
• new GetNamespacesRequest(properties?): GetNamespacesRequest
Constructs a new GetNamespacesRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetNamespacesRequest | Properties to set |
Returns
Properties
name
• name: string
Filter namespaces by their name. Optional, defaults to empty.
Implementation of
pageSize
• pageSize: number
The requested size of the page to retrieve. Cannot exceed 1000. Optional, defaults to 100.
Implementation of
IGetNamespacesRequest.pageSize
pageToken
• pageToken: string
The page token if this is continuing from another response. Optional, defaults to empty.
Implementation of
IGetNamespacesRequest.pageToken
Methods
toJSON
▸ toJSON(): Object
Converts this GetNamespacesRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetNamespacesRequest
Creates a new GetNamespacesRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetNamespacesRequest | Properties to set |
Returns
GetNamespacesRequest instance
decode
▸ decode(reader, length?): GetNamespacesRequest
Decodes a GetNamespacesRequest 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
GetNamespacesRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetNamespacesRequest
Decodes a GetNamespacesRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetNamespacesRequest
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 GetNamespacesRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetNamespacesRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetNamespacesRequest | GetNamespacesRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetNamespacesRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetNamespacesRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetNamespacesRequest | GetNamespacesRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetNamespacesRequest
Creates a GetNamespacesRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetNamespacesRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetNamespacesRequest
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 GetNamespacesRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetNamespacesRequest | GetNamespacesRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object