Class protos.google.cloud.clouddms.v1.ConnectionProfile (1.0.5)

Represents a ConnectionProfile.

Package

@google-cloud/dms!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.clouddms.v1.IConnectionProfile);

Constructs a new ConnectionProfile.

Parameter

Name	Description
properties	`IConnectionProfile` Properties to set

Properties

cloudsql

public cloudsql?: (google.cloud.clouddms.v1.ICloudSqlConnectionProfile|null);

ConnectionProfile cloudsql.

Property Value

Type	Description
(google.cloud.clouddms.v1.ICloudSqlConnectionProfile\|null)

connectionProfile

public connectionProfile?: ("mysql"|"postgresql"|"cloudsql");

ConnectionProfile connectionProfile.

Property Value

Type	Description
("mysql"\|"postgresql"\|"cloudsql")

createTime

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

ConnectionProfile createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

displayName

public displayName: string;

ConnectionProfile displayName.

Property Value

Type	Description
string

error

public error?: (google.rpc.IStatus|null);

ConnectionProfile error.

Property Value

Type	Description
(google.rpc.IStatus\|null)

labels

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

ConnectionProfile labels.

Property Value

Type	Description
{ [k: string]: string }

mysql

public mysql?: (google.cloud.clouddms.v1.IMySqlConnectionProfile|null);

ConnectionProfile mysql.

Property Value

Type	Description
(google.cloud.clouddms.v1.IMySqlConnectionProfile\|null)

name

public name: string;

ConnectionProfile name.

Property Value

Type	Description
string

postgresql

public postgresql?: (google.cloud.clouddms.v1.IPostgreSqlConnectionProfile|null);

ConnectionProfile postgresql.

Property Value

Type	Description
(google.cloud.clouddms.v1.IPostgreSqlConnectionProfile\|null)

provider

public provider: (google.cloud.clouddms.v1.DatabaseProvider|keyof typeof google.cloud.clouddms.v1.DatabaseProvider);

ConnectionProfile provider.

Property Value

Type	Description
(google.cloud.clouddms.v1.DatabaseProvider\|keyof typeof google.cloud.clouddms.v1.DatabaseProvider)

state

public state: (google.cloud.clouddms.v1.ConnectionProfile.State|keyof typeof google.cloud.clouddms.v1.ConnectionProfile.State);

ConnectionProfile state.

Property Value

Type	Description
(google.cloud.clouddms.v1.ConnectionProfile.State\|keyof typeof google.cloud.clouddms.v1.ConnectionProfile.State)

updateTime

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

ConnectionProfile updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

public static create(properties?: google.cloud.clouddms.v1.IConnectionProfile): google.cloud.clouddms.v1.ConnectionProfile;

Creates a new ConnectionProfile instance using the specified properties.

Parameter

Name	Description
properties	`IConnectionProfile` Properties to set

Returns

Type	Description
google.cloud.clouddms.v1.ConnectionProfile	ConnectionProfile instance

decode(reader, length)

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

Decodes a ConnectionProfile message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.clouddms.v1.ConnectionProfile	ConnectionProfile

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.clouddms.v1.ConnectionProfile	ConnectionProfile

encode(message, writer)

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

Encodes the specified ConnectionProfile message. Does not implicitly messages.

Parameters

Name	Description
message	`IConnectionProfile` ConnectionProfile 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.clouddms.v1.IConnectionProfile, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IConnectionProfile` ConnectionProfile 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.clouddms.v1.ConnectionProfile;

Creates a ConnectionProfile 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
google.cloud.clouddms.v1.ConnectionProfile	ConnectionProfile

toJSON()

public toJSON(): { [k: string]: any };

Converts this ConnectionProfile to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.clouddms.v1.ConnectionProfile` ConnectionProfile
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 ConnectionProfile 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