Class protos.google.cloud.networkmanagement.v1.InstanceInfo (3.0.0)

Represents an InstanceInfo.

Package

@google-cloud/network-management

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1.IInstanceInfo);

Constructs a new InstanceInfo.

Parameter
NameDescription
properties IInstanceInfo

Properties to set

Properties

displayName

public displayName: string;

InstanceInfo displayName.

externalIp

public externalIp: string;

InstanceInfo externalIp.

interface

public interface: string;

InstanceInfo interface.

internalIp

public internalIp: string;

InstanceInfo internalIp.

networkTags

public networkTags: string[];

InstanceInfo networkTags.

networkUri

public networkUri: string;

InstanceInfo networkUri.

serviceAccount

public serviceAccount: string;

InstanceInfo serviceAccount.

uri

public uri: string;

InstanceInfo uri.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1.IInstanceInfo): google.cloud.networkmanagement.v1.InstanceInfo;

Creates a new InstanceInfo instance using the specified properties.

Parameter
NameDescription
properties IInstanceInfo

Properties to set

Returns
TypeDescription
InstanceInfo

InstanceInfo instance

decode(reader, length)

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

Decodes an InstanceInfo message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
InstanceInfo

InstanceInfo

decodeDelimited(reader)

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

Decodes an InstanceInfo message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
InstanceInfo

InstanceInfo

encode(message, writer)

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

Encodes the specified InstanceInfo message. Does not implicitly messages.

Parameters
NameDescription
message IInstanceInfo

InstanceInfo 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.networkmanagement.v1.IInstanceInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IInstanceInfo

InstanceInfo 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.networkmanagement.v1.InstanceInfo;

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

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

Plain object

Returns
TypeDescription
InstanceInfo

InstanceInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceInfo

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message InstanceInfo

InstanceInfo

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