Class protos.google.cloud.networkconnectivity.v1.ServiceConnectionMap (4.2.0)

Represents a ServiceConnectionMap.

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkconnectivity.v1.IServiceConnectionMap);

Constructs a new ServiceConnectionMap.

Parameter
Name Description
properties IServiceConnectionMap

Properties to set

Properties

_etag

public _etag?: "etag";

ServiceConnectionMap _etag.

consumerPscConfigs

public consumerPscConfigs: google.cloud.networkconnectivity.v1.ServiceConnectionMap.IConsumerPscConfig[];

ServiceConnectionMap consumerPscConfigs.

consumerPscConnections

public consumerPscConnections: google.cloud.networkconnectivity.v1.ServiceConnectionMap.IConsumerPscConnection[];

ServiceConnectionMap consumerPscConnections.

createTime

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

ServiceConnectionMap createTime.

description

public description: string;

ServiceConnectionMap description.

etag

public etag?: (string|null);

ServiceConnectionMap etag.

infrastructure

public infrastructure: (google.cloud.networkconnectivity.v1.Infrastructure|keyof typeof google.cloud.networkconnectivity.v1.Infrastructure);

ServiceConnectionMap infrastructure.

labels

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

ServiceConnectionMap labels.

name

public name: string;

ServiceConnectionMap name.

producerPscConfigs

public producerPscConfigs: google.cloud.networkconnectivity.v1.ServiceConnectionMap.IProducerPscConfig[];

ServiceConnectionMap producerPscConfigs.

serviceClass

public serviceClass: string;

ServiceConnectionMap serviceClass.

serviceClassUri

public serviceClassUri: string;

ServiceConnectionMap serviceClassUri.

token

public token: string;

ServiceConnectionMap token.

updateTime

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

ServiceConnectionMap updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1.IServiceConnectionMap): google.cloud.networkconnectivity.v1.ServiceConnectionMap;

Creates a new ServiceConnectionMap instance using the specified properties.

Parameter
Name Description
properties IServiceConnectionMap

Properties to set

Returns
Type Description
ServiceConnectionMap

ServiceConnectionMap instance

decode(reader, length)

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

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

ServiceConnectionMap

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ServiceConnectionMap

ServiceConnectionMap

encode(message, writer)

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

Encodes the specified ServiceConnectionMap message. Does not implicitly messages.

Parameters
Name Description
message IServiceConnectionMap

ServiceConnectionMap 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.v1.IServiceConnectionMap, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IServiceConnectionMap

ServiceConnectionMap 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.v1.ServiceConnectionMap;

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

ServiceConnectionMap

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ServiceConnectionMap

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ServiceConnectionMap

ServiceConnectionMap

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