Class protos.google.cloud.compute.v1.Interconnect (4.1.0)

Represents an Interconnect.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Interconnect.

Parameter
NameDescription
properties IInterconnect

Properties to set

Properties

_adminEnabled

public _adminEnabled?: "adminEnabled";

Interconnect _adminEnabled.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Interconnect _creationTimestamp.

_customerName

public _customerName?: "customerName";

Interconnect _customerName.

_description

public _description?: "description";

Interconnect _description.

_googleIpAddress

public _googleIpAddress?: "googleIpAddress";

Interconnect _googleIpAddress.

_googleReferenceId

public _googleReferenceId?: "googleReferenceId";

Interconnect _googleReferenceId.

_id

public _id?: "id";

Interconnect _id.

_interconnectType

public _interconnectType?: "interconnectType";

Interconnect _interconnectType.

_kind

public _kind?: "kind";

Interconnect _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

Interconnect _labelFingerprint.

_linkType

public _linkType?: "linkType";

Interconnect _linkType.

_location

public _location?: "location";

Interconnect _location.

_macsec

public _macsec?: "macsec";

Interconnect _macsec.

_macsecEnabled

public _macsecEnabled?: "macsecEnabled";

Interconnect _macsecEnabled.

_name

public _name?: "name";

Interconnect _name.

_nocContactEmail

public _nocContactEmail?: "nocContactEmail";

Interconnect _nocContactEmail.

_operationalStatus

public _operationalStatus?: "operationalStatus";

Interconnect _operationalStatus.

_peerIpAddress

public _peerIpAddress?: "peerIpAddress";

Interconnect _peerIpAddress.

_provisionedLinkCount

public _provisionedLinkCount?: "provisionedLinkCount";

Interconnect _provisionedLinkCount.

_remoteLocation

public _remoteLocation?: "remoteLocation";

Interconnect _remoteLocation.

_requestedLinkCount

public _requestedLinkCount?: "requestedLinkCount";

Interconnect _requestedLinkCount.

_satisfiesPzs

public _satisfiesPzs?: "satisfiesPzs";

Interconnect _satisfiesPzs.

public _selfLink?: "selfLink";

Interconnect _selfLink.

_state

public _state?: "state";

Interconnect _state.

adminEnabled

public adminEnabled?: (boolean|null);

Interconnect adminEnabled.

availableFeatures

public availableFeatures: string[];

Interconnect availableFeatures.

circuitInfos

public circuitInfos: google.cloud.compute.v1.IInterconnectCircuitInfo[];

Interconnect circuitInfos.

creationTimestamp

public creationTimestamp?: (string|null);

Interconnect creationTimestamp.

customerName

public customerName?: (string|null);

Interconnect customerName.

description

public description?: (string|null);

Interconnect description.

expectedOutages

public expectedOutages: google.cloud.compute.v1.IInterconnectOutageNotification[];

Interconnect expectedOutages.

googleIpAddress

public googleIpAddress?: (string|null);

Interconnect googleIpAddress.

googleReferenceId

public googleReferenceId?: (string|null);

Interconnect googleReferenceId.

id

public id?: (number|Long|string|null);

Interconnect id.

interconnectAttachments

public interconnectAttachments: string[];

Interconnect interconnectAttachments.

interconnectType

public interconnectType?: (string|null);

Interconnect interconnectType.

kind

public kind?: (string|null);

Interconnect kind.

labelFingerprint

public labelFingerprint?: (string|null);

Interconnect labelFingerprint.

labels

public labels: { [k: string]: string };

Interconnect labels.

linkType

public linkType?: (string|null);

Interconnect linkType.

location

public location?: (string|null);

Interconnect location.

macsec

public macsec?: (google.cloud.compute.v1.IInterconnectMacsec|null);

Interconnect macsec.

macsecEnabled

public macsecEnabled?: (boolean|null);

Interconnect macsecEnabled.

name

public name?: (string|null);

Interconnect name.

nocContactEmail

public nocContactEmail?: (string|null);

Interconnect nocContactEmail.

operationalStatus

public operationalStatus?: (string|null);

Interconnect operationalStatus.

peerIpAddress

public peerIpAddress?: (string|null);

Interconnect peerIpAddress.

provisionedLinkCount

public provisionedLinkCount?: (number|null);

Interconnect provisionedLinkCount.

remoteLocation

public remoteLocation?: (string|null);

Interconnect remoteLocation.

requestedFeatures

public requestedFeatures: string[];

Interconnect requestedFeatures.

requestedLinkCount

public requestedLinkCount?: (number|null);

Interconnect requestedLinkCount.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

Interconnect satisfiesPzs.

public selfLink?: (string|null);

Interconnect selfLink.

state

public state?: (string|null);

Interconnect state.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInterconnect): google.cloud.compute.v1.Interconnect;

Creates a new Interconnect instance using the specified properties.

Parameter
NameDescription
properties IInterconnect

Properties to set

Returns
TypeDescription
Interconnect

Interconnect instance

decode(reader, length)

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

Decodes an Interconnect 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
Interconnect

Interconnect

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Interconnect

Interconnect

encode(message, writer)

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

Encodes the specified Interconnect message. Does not implicitly messages.

Parameters
NameDescription
message IInterconnect

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

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

Parameters
NameDescription
message IInterconnect

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

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

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

Plain object

Returns
TypeDescription
Interconnect

Interconnect

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Interconnect

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Interconnect

Interconnect

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