Class protos.google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

Represents a ListSpokesRequest.

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest);

Constructs a new ListSpokesRequest.

Parameter
NameDescription
properties IListSpokesRequest

Properties to set

Properties

filter

public filter: string;

ListSpokesRequest filter.

orderBy

public orderBy: string;

ListSpokesRequest orderBy.

pageSize

public pageSize: number;

ListSpokesRequest pageSize.

pageToken

public pageToken: string;

ListSpokesRequest pageToken.

parent

public parent: string;

ListSpokesRequest parent.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest): google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest;

Creates a new ListSpokesRequest instance using the specified properties.

Parameter
NameDescription
properties IListSpokesRequest

Properties to set

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

ListSpokesRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest;

Decodes a ListSpokesRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

ListSpokesRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

ListSpokesRequest

encode(message, writer)

public static encode(message: google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListSpokesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IListSpokesRequest

ListSpokesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.networkconnectivity.v1alpha1.IListSpokesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListSpokesRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IListSpokesRequest

ListSpokesRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest;

Creates a ListSpokesRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

ListSpokesRequest

toJSON()

public toJSON(): { [k: string]: any };

Converts this ListSpokesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.networkconnectivity.v1alpha1.ListSpokesRequest

ListSpokesRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ListSpokesRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not