Class protos.google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig (4.6.0)

Represents a MulticloudDataTransferConfig.

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

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

Constructs a new MulticloudDataTransferConfig.

Parameter
Name Description
properties IMulticloudDataTransferConfig

Properties to set

Properties

createTime

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

MulticloudDataTransferConfig createTime.

description

public description: string;

MulticloudDataTransferConfig description.

destinationsActiveCount

public destinationsActiveCount: number;

MulticloudDataTransferConfig destinationsActiveCount.

destinationsCount

public destinationsCount: number;

MulticloudDataTransferConfig destinationsCount.

etag

public etag: string;

MulticloudDataTransferConfig etag.

labels

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

MulticloudDataTransferConfig labels.

name

public name: string;

MulticloudDataTransferConfig name.

services

public services: { [k: string]: google.cloud.networkconnectivity.v1.IStateTimeline };

MulticloudDataTransferConfig services.

uid

public uid: string;

MulticloudDataTransferConfig uid.

updateTime

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

MulticloudDataTransferConfig updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1.IMulticloudDataTransferConfig): google.cloud.networkconnectivity.v1.MulticloudDataTransferConfig;

Creates a new MulticloudDataTransferConfig instance using the specified properties.

Parameter
Name Description
properties IMulticloudDataTransferConfig

Properties to set

Returns
Type Description
MulticloudDataTransferConfig

MulticloudDataTransferConfig instance

decode(reader, length)

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

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

MulticloudDataTransferConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
MulticloudDataTransferConfig

MulticloudDataTransferConfig

encode(message, writer)

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

Encodes the specified MulticloudDataTransferConfig message. Does not implicitly messages.

Parameters
Name Description
message IMulticloudDataTransferConfig

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

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

Parameters
Name Description
message IMulticloudDataTransferConfig

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

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

MulticloudDataTransferConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MulticloudDataTransferConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message MulticloudDataTransferConfig

MulticloudDataTransferConfig

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