Class protos.google.cloud.compute.v1.NetworkPeering (4.8.0)

Represents a NetworkPeering.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new NetworkPeering.

Parameter
Name Description
properties INetworkPeering

Properties to set

Properties

_autoCreateRoutes

public _autoCreateRoutes?: "autoCreateRoutes";

NetworkPeering _autoCreateRoutes.

_exchangeSubnetRoutes

public _exchangeSubnetRoutes?: "exchangeSubnetRoutes";

NetworkPeering _exchangeSubnetRoutes.

_exportCustomRoutes

public _exportCustomRoutes?: "exportCustomRoutes";

NetworkPeering _exportCustomRoutes.

_exportSubnetRoutesWithPublicIp

public _exportSubnetRoutesWithPublicIp?: "exportSubnetRoutesWithPublicIp";

NetworkPeering _exportSubnetRoutesWithPublicIp.

_importCustomRoutes

public _importCustomRoutes?: "importCustomRoutes";

NetworkPeering _importCustomRoutes.

_importSubnetRoutesWithPublicIp

public _importSubnetRoutesWithPublicIp?: "importSubnetRoutesWithPublicIp";

NetworkPeering _importSubnetRoutesWithPublicIp.

_name

public _name?: "name";

NetworkPeering _name.

_network

public _network?: "network";

NetworkPeering _network.

_peerMtu

public _peerMtu?: "peerMtu";

NetworkPeering _peerMtu.

_stackType

public _stackType?: "stackType";

NetworkPeering _stackType.

_state

public _state?: "state";

NetworkPeering _state.

_stateDetails

public _stateDetails?: "stateDetails";

NetworkPeering _stateDetails.

autoCreateRoutes

public autoCreateRoutes?: (boolean|null);

NetworkPeering autoCreateRoutes.

exchangeSubnetRoutes

public exchangeSubnetRoutes?: (boolean|null);

NetworkPeering exchangeSubnetRoutes.

exportCustomRoutes

public exportCustomRoutes?: (boolean|null);

NetworkPeering exportCustomRoutes.

exportSubnetRoutesWithPublicIp

public exportSubnetRoutesWithPublicIp?: (boolean|null);

NetworkPeering exportSubnetRoutesWithPublicIp.

importCustomRoutes

public importCustomRoutes?: (boolean|null);

NetworkPeering importCustomRoutes.

importSubnetRoutesWithPublicIp

public importSubnetRoutesWithPublicIp?: (boolean|null);

NetworkPeering importSubnetRoutesWithPublicIp.

name

public name?: (string|null);

NetworkPeering name.

network

public network?: (string|null);

NetworkPeering network.

peerMtu

public peerMtu?: (number|null);

NetworkPeering peerMtu.

stackType

public stackType?: (string|null);

NetworkPeering stackType.

state

public state?: (string|null);

NetworkPeering state.

stateDetails

public stateDetails?: (string|null);

NetworkPeering stateDetails.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.INetworkPeering): google.cloud.compute.v1.NetworkPeering;

Creates a new NetworkPeering instance using the specified properties.

Parameter
Name Description
properties INetworkPeering

Properties to set
Returns
Type Description
NetworkPeering

NetworkPeering instance

decode(reader, length)

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

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

NetworkPeering

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
NetworkPeering

NetworkPeering

encode(message, writer)

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

Encodes the specified NetworkPeering message. Does not implicitly messages.

Parameters
Name Description
message INetworkPeering

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

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

Parameters
Name Description
message INetworkPeering

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

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

NetworkPeering

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for NetworkPeering

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message NetworkPeering

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