Represents a ConnectionProfile.
Package
@google-cloud/datastreamConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datastream.v1.IConnectionProfile);Constructs a new ConnectionProfile.
| Parameter | |
|---|---|
| Name | Description |
properties |
IConnectionProfile
Properties to set |
Properties
bigqueryProfile
public bigqueryProfile?: (google.cloud.datastream.v1.IBigQueryProfile|null);ConnectionProfile bigqueryProfile.
connectivity
public connectivity?: ("staticServiceIpConnectivity"|"forwardSshConnectivity"|"privateConnectivity");ConnectionProfile connectivity.
createTime
public createTime?: (google.protobuf.ITimestamp|null);ConnectionProfile createTime.
displayName
public displayName: string;ConnectionProfile displayName.
forwardSshConnectivity
public forwardSshConnectivity?: (google.cloud.datastream.v1.IForwardSshTunnelConnectivity|null);ConnectionProfile forwardSshConnectivity.
gcsProfile
public gcsProfile?: (google.cloud.datastream.v1.IGcsProfile|null);ConnectionProfile gcsProfile.
labels
public labels: { [k: string]: string };ConnectionProfile labels.
mysqlProfile
public mysqlProfile?: (google.cloud.datastream.v1.IMysqlProfile|null);ConnectionProfile mysqlProfile.
name
public name: string;ConnectionProfile name.
oracleProfile
public oracleProfile?: (google.cloud.datastream.v1.IOracleProfile|null);ConnectionProfile oracleProfile.
postgresqlProfile
public postgresqlProfile?: (google.cloud.datastream.v1.IPostgresqlProfile|null);ConnectionProfile postgresqlProfile.
privateConnectivity
public privateConnectivity?: (google.cloud.datastream.v1.IPrivateConnectivity|null);ConnectionProfile privateConnectivity.
profile
public profile?: ("oracleProfile"|"gcsProfile"|"mysqlProfile"|"bigqueryProfile"|"postgresqlProfile");ConnectionProfile profile.
staticServiceIpConnectivity
public staticServiceIpConnectivity?: (google.cloud.datastream.v1.IStaticServiceIpConnectivity|null);ConnectionProfile staticServiceIpConnectivity.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);ConnectionProfile updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.datastream.v1.IConnectionProfile): google.cloud.datastream.v1.ConnectionProfile;Creates a new ConnectionProfile instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IConnectionProfile
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ConnectionProfile | ConnectionProfile instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1.ConnectionProfile;Decodes a ConnectionProfile 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 |
ConnectionProfile | ConnectionProfile |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1.ConnectionProfile;Decodes a ConnectionProfile message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ConnectionProfile | ConnectionProfile |
encode(message, writer)
public static encode(message: google.cloud.datastream.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.datastream.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.datastream.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 |
ConnectionProfile | ConnectionProfile |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ConnectionProfile
| 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 ConnectionProfile to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datastream.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 |
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) |
|