Class protos.google.cloud.compute.v1.RegionList (4.6.0)

Represents a RegionList.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new RegionList.

Parameter
Name Description
properties IRegionList

Properties to set

Properties

_id

public _id?: "id";

RegionList _id.

_kind

public _kind?: "kind";

RegionList _kind.

_nextPageToken

public _nextPageToken?: "nextPageToken";

RegionList _nextPageToken.

public _selfLink?: "selfLink";

RegionList _selfLink.

_warning

public _warning?: "warning";

RegionList _warning.

id

public id?: (string|null);

RegionList id.

items

public items: google.cloud.compute.v1.IRegion[];

RegionList items.

kind

public kind?: (string|null);

RegionList kind.

nextPageToken

public nextPageToken?: (string|null);

RegionList nextPageToken.

public selfLink?: (string|null);

RegionList selfLink.

warning

public warning?: (google.cloud.compute.v1.IWarning|null);

RegionList warning.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IRegionList): google.cloud.compute.v1.RegionList;

Creates a new RegionList instance using the specified properties.

Parameter
Name Description
properties IRegionList

Properties to set

Returns
Type Description
RegionList

RegionList instance

decode(reader, length)

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

Decodes a RegionList 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
RegionList

RegionList

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RegionList

RegionList

encode(message, writer)

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

Encodes the specified RegionList message. Does not implicitly messages.

Parameters
Name Description
message IRegionList

RegionList 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.IRegionList, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRegionList

RegionList 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.RegionList;

Creates a RegionList 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
RegionList

RegionList

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RegionList

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 RegionList to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RegionList

RegionList

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 RegionList 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