Class protos.google.cloud.networkconnectivity.v1beta.Transport (5.1.1)

Represents a Transport.

Implements

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkconnectivity.v1beta.ITransport);

Constructs a new Transport.

Parameter
Name Description
properties ITransport

Properties to set

Properties

adminEnabled

public adminEnabled: boolean;

Transport adminEnabled.

advertisedRoutes

public advertisedRoutes: string[];

Transport advertisedRoutes.

autoAccept

public autoAccept: boolean;

Transport autoAccept.

bandwidth

public bandwidth: (google.cloud.networkconnectivity.v1beta.Transport.Bandwidth|keyof typeof google.cloud.networkconnectivity.v1beta.Transport.Bandwidth);

Transport bandwidth.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Transport createTime.

description

public description: string;

Transport description.

generatedActivationKey

public generatedActivationKey: string;

Transport generatedActivationKey.

hub

public hub: string;

Transport hub.

labels

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

Transport labels.

mtuLimit

public mtuLimit: number;

Transport mtuLimit.

name

public name: string;

Transport name.

network

public network: string;

Transport network.

peeringNetwork

public peeringNetwork: string;

Transport peeringNetwork.

providedActivationKey

public providedActivationKey: string;

Transport providedActivationKey.

pscRoutingEnabled

public pscRoutingEnabled: boolean;

Transport pscRoutingEnabled.

remoteAccountId

public remoteAccountId: string;

Transport remoteAccountId.

remoteProfile

public remoteProfile: string;

Transport remoteProfile.

stackType

public stackType: (google.cloud.networkconnectivity.v1beta.Transport.StackType|keyof typeof google.cloud.networkconnectivity.v1beta.Transport.StackType);

Transport stackType.

state

public state: (google.cloud.networkconnectivity.v1beta.Transport.State|keyof typeof google.cloud.networkconnectivity.v1beta.Transport.State);

Transport state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Transport updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1beta.ITransport): google.cloud.networkconnectivity.v1beta.Transport;

Creates a new Transport instance using the specified properties.

Parameter
Name Description
properties ITransport

Properties to set
Returns
Type Description
Transport

Transport instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1beta.Transport;

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

Transport

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1beta.Transport;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Transport

Transport

encode(message, writer)

public static encode(message: google.cloud.networkconnectivity.v1beta.ITransport, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Transport message. Does not implicitly messages.

Parameters
Name Description
message ITransport

Transport 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.networkconnectivity.v1beta.ITransport, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ITransport

Transport 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.networkconnectivity.v1beta.Transport;

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

Transport

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Transport

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Transport

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