Class protos.google.cloud.compute.v1.AliasIpRange (3.6.0)

Represents an AliasIpRange.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AliasIpRange.

Parameter
NameDescription
properties IAliasIpRange

Properties to set

Properties

_ipCidrRange

public _ipCidrRange?: "ipCidrRange";

AliasIpRange _ipCidrRange.

_subnetworkRangeName

public _subnetworkRangeName?: "subnetworkRangeName";

AliasIpRange _subnetworkRangeName.

ipCidrRange

public ipCidrRange?: (string|null);

AliasIpRange ipCidrRange.

subnetworkRangeName

public subnetworkRangeName?: (string|null);

AliasIpRange subnetworkRangeName.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAliasIpRange): google.cloud.compute.v1.AliasIpRange;

Creates a new AliasIpRange instance using the specified properties.

Parameter
NameDescription
properties IAliasIpRange

Properties to set

Returns
TypeDescription
google.cloud.compute.v1.AliasIpRange

AliasIpRange instance

decode(reader, length)

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

Decodes an AliasIpRange 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.compute.v1.AliasIpRange

AliasIpRange

decodeDelimited(reader)

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

Decodes an AliasIpRange 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.compute.v1.AliasIpRange

AliasIpRange

encode(message, writer)

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

Encodes the specified AliasIpRange message. Does not implicitly messages.

Parameters
NameDescription
message IAliasIpRange

AliasIpRange 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.compute.v1.IAliasIpRange, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAliasIpRange

AliasIpRange 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.compute.v1.AliasIpRange;

Creates an AliasIpRange 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.compute.v1.AliasIpRange

AliasIpRange

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AliasIpRange

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this AliasIpRange to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.compute.v1.AliasIpRange

AliasIpRange

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AliasIpRange 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