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