Class protos.google.cloud.compute.v1.ListPublicAdvertisedPrefixesRequest (4.5.0)

Represents a ListPublicAdvertisedPrefixesRequest.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IListPublicAdvertisedPrefixesRequest);

Constructs a new ListPublicAdvertisedPrefixesRequest.

Parameter
Name	Description
`properties`	`IListPublicAdvertisedPrefixesRequest` Properties to set

Properties

_filter

public _filter?: "filter";

ListPublicAdvertisedPrefixesRequest _filter.

_maxResults

public _maxResults?: "maxResults";

ListPublicAdvertisedPrefixesRequest _maxResults.

_orderBy

public _orderBy?: "orderBy";

ListPublicAdvertisedPrefixesRequest _orderBy.

_pageToken

public _pageToken?: "pageToken";

ListPublicAdvertisedPrefixesRequest _pageToken.

_returnPartialSuccess

public _returnPartialSuccess?: "returnPartialSuccess";

ListPublicAdvertisedPrefixesRequest _returnPartialSuccess.

filter

public filter?: (string|null);

ListPublicAdvertisedPrefixesRequest filter.

maxResults

public maxResults?: (number|null);

ListPublicAdvertisedPrefixesRequest maxResults.

orderBy

public orderBy?: (string|null);

ListPublicAdvertisedPrefixesRequest orderBy.

pageToken

public pageToken?: (string|null);

ListPublicAdvertisedPrefixesRequest pageToken.

project

public project: string;

ListPublicAdvertisedPrefixesRequest project.

returnPartialSuccess

public returnPartialSuccess?: (boolean|null);

ListPublicAdvertisedPrefixesRequest returnPartialSuccess.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IListPublicAdvertisedPrefixesRequest): google.cloud.compute.v1.ListPublicAdvertisedPrefixesRequest;

Creates a new ListPublicAdvertisedPrefixesRequest instance using the specified properties.

Parameter
Name	Description
`properties`	`IListPublicAdvertisedPrefixesRequest` Properties to set

Returns
Type	Description
`ListPublicAdvertisedPrefixesRequest`	ListPublicAdvertisedPrefixesRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.ListPublicAdvertisedPrefixesRequest;

Decodes a ListPublicAdvertisedPrefixesRequest message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`ListPublicAdvertisedPrefixesRequest`	ListPublicAdvertisedPrefixesRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ListPublicAdvertisedPrefixesRequest;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`ListPublicAdvertisedPrefixesRequest`	ListPublicAdvertisedPrefixesRequest

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IListPublicAdvertisedPrefixesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListPublicAdvertisedPrefixesRequest message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IListPublicAdvertisedPrefixesRequest` ListPublicAdvertisedPrefixesRequest message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.IListPublicAdvertisedPrefixesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IListPublicAdvertisedPrefixesRequest` ListPublicAdvertisedPrefixesRequest message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns
Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.ListPublicAdvertisedPrefixesRequest;

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

Parameter
Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns
Type	Description
`ListPublicAdvertisedPrefixesRequest`	ListPublicAdvertisedPrefixesRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ListPublicAdvertisedPrefixesRequest

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

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

Converts this ListPublicAdvertisedPrefixesRequest to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`ListPublicAdvertisedPrefixesRequest` ListPublicAdvertisedPrefixesRequest
`options`	`$protobuf.IConversionOptions` Conversion options

Returns
Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

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

Verifies a ListPublicAdvertisedPrefixesRequest message.

Parameter
Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns
Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not