Skip to main content

Class: ListNexusEndpointsRequest

operatorservice.v1.ListNexusEndpointsRequest

Represents a ListNexusEndpointsRequest.

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. --)


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.


pageSize​

• pageSize: number

ListNexusEndpointsRequest pageSize.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ListNexusEndpointsRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ListNexusEndpointsRequest & $Properties

Creates a new ListNexusEndpointsRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

ListNexusEndpointsRequest & $Properties

ListNexusEndpointsRequest instance

▸ create(properties?): ListNexusEndpointsRequest

Parameters​

NameType
properties?$Properties

Returns​

ListNexusEndpointsRequest


decode​

▸ decode(reader, length?): ListNexusEndpointsRequest & $Properties

Decodes a ListNexusEndpointsRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

ListNexusEndpointsRequest & $Properties

ListNexusEndpointsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ListNexusEndpointsRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ListNexusEndpointsRequest & $Properties

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​

NameTypeDescription
message$PropertiesListNexusEndpointsRequest message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
message$PropertiesListNexusEndpointsRequest message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
objectObjectPlain object

Returns​

ListNexusEndpointsRequest

ListNexusEndpointsRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageListNexusEndpointsRequestListNexusEndpointsRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object