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

Represents a RemoteTransportProfile.

Implements

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

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

Constructs a new RemoteTransportProfile.

Parameter
Name Description
properties IRemoteTransportProfile

Properties to set

Properties

description

public description: string;

RemoteTransportProfile description.

displayName

public displayName: string;

RemoteTransportProfile displayName.

flow

public flow: (google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.KeyProvisioningFlow|keyof typeof google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.KeyProvisioningFlow);

RemoteTransportProfile flow.

labels

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

RemoteTransportProfile labels.

name

public name: string;

RemoteTransportProfile name.

orderState

public orderState: (google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.State|keyof typeof google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.State);

RemoteTransportProfile orderState.

provider

public provider: string;

RemoteTransportProfile provider.

providerSite

public providerSite: string;

RemoteTransportProfile providerSite.

providerType

public providerType: (google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.ProviderType|keyof typeof google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.ProviderType);

RemoteTransportProfile providerType.

sla

public sla: (google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.ServiceLevelAvailability|keyof typeof google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.ServiceLevelAvailability);

RemoteTransportProfile sla.

supportedBandwidths

public supportedBandwidths: google.cloud.networkconnectivity.v1beta.RemoteTransportProfile.Bandwidth[];

RemoteTransportProfile supportedBandwidths.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1beta.IRemoteTransportProfile): google.cloud.networkconnectivity.v1beta.RemoteTransportProfile;

Creates a new RemoteTransportProfile instance using the specified properties.

Parameter
Name Description
properties IRemoteTransportProfile

Properties to set

Returns
Type Description
RemoteTransportProfile

RemoteTransportProfile instance

decode(reader, length)

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

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

RemoteTransportProfile

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RemoteTransportProfile

RemoteTransportProfile

encode(message, writer)

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

Encodes the specified RemoteTransportProfile message. Does not implicitly messages.

Parameters
Name Description
message IRemoteTransportProfile

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

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

Parameters
Name Description
message IRemoteTransportProfile

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

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

RemoteTransportProfile

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for RemoteTransportProfile

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message RemoteTransportProfile

RemoteTransportProfile

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