Class: ListNexusEndpointsRequest
operatorservice.v1.ListNexusEndpointsRequest
Represents a ListNexusEndpointsRequest.
Implements
Constructors
constructor
• new ListNexusEndpointsRequest(properties?): ListNexusEndpointsRequest
Constructs a new ListNexusEndpointsRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListNexusEndpointsRequest | Properties to set |
Returns
Properties
name
• name: string
Name of the incoming endpoint to filter on - optional. Specifying this will result in zero or one results. (-- api-linter: core::203::field-behavior-required=disabled aip.dev/not-precedent: Not following linter rules. --)
Implementation of
IListNexusEndpointsRequest.name
nextPageToken
• nextPageToken: Uint8Array
To get the next page, pass in ListNexusEndpointsResponse.next_page_token from the previous page's
response, the token will be empty if there's no other page.
Note: the last page may be empty if the total number of endpoints registered is a multiple of the page size.
Implementation of
IListNexusEndpointsRequest.nextPageToken
pageSize
• pageSize: number
ListNexusEndpointsRequest pageSize.
Implementation of
IListNexusEndpointsRequest.pageSize
Methods
toJSON
▸ toJSON(): Object
Converts this ListNexusEndpointsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListNexusEndpointsRequest
Creates a new ListNexusEndpointsRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListNexusEndpointsRequest | Properties to set |
Returns
ListNexusEndpointsRequest instance
decode
▸ decode(reader, length?): ListNexusEndpointsRequest
Decodes a ListNexusEndpointsRequest 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
ListNexusEndpointsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListNexusEndpointsRequest
Decodes a ListNexusEndpointsRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListNexusEndpointsRequest
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 ListNexusEndpointsRequest message. Does not implicitly temporal.api.operatorservice.v1.ListNexusEndpointsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListNexusEndpointsRequest | ListNexusEndpointsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListNexusEndpointsRequest message, length delimited. Does not implicitly temporal.api.operatorservice.v1.ListNexusEndpointsRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListNexusEndpointsRequest | ListNexusEndpointsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListNexusEndpointsRequest
Creates a ListNexusEndpointsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListNexusEndpointsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListNexusEndpointsRequest
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 ListNexusEndpointsRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListNexusEndpointsRequest | ListNexusEndpointsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object