Class protos.google.cloud.datastream.v1.DiscoverConnectionProfileRequest (3.3.0)

Represents a DiscoverConnectionProfileRequest.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1.IDiscoverConnectionProfileRequest);

Constructs a new DiscoverConnectionProfileRequest.

Parameter
Name Description
properties IDiscoverConnectionProfileRequest

Properties to set

Properties

connectionProfile

public connectionProfile?: (google.cloud.datastream.v1.IConnectionProfile|null);

DiscoverConnectionProfileRequest connectionProfile.

connectionProfileName

public connectionProfileName?: (string|null);

DiscoverConnectionProfileRequest connectionProfileName.

dataObject

public dataObject?: ("oracleRdbms"|"mysqlRdbms"|"postgresqlRdbms"|"sqlServerRdbms");

DiscoverConnectionProfileRequest dataObject.

fullHierarchy

public fullHierarchy?: (boolean|null);

DiscoverConnectionProfileRequest fullHierarchy.

hierarchy

public hierarchy?: ("fullHierarchy"|"hierarchyDepth");

DiscoverConnectionProfileRequest hierarchy.

hierarchyDepth

public hierarchyDepth?: (number|null);

DiscoverConnectionProfileRequest hierarchyDepth.

mysqlRdbms

public mysqlRdbms?: (google.cloud.datastream.v1.IMysqlRdbms|null);

DiscoverConnectionProfileRequest mysqlRdbms.

oracleRdbms

public oracleRdbms?: (google.cloud.datastream.v1.IOracleRdbms|null);

DiscoverConnectionProfileRequest oracleRdbms.

parent

public parent: string;

DiscoverConnectionProfileRequest parent.

postgresqlRdbms

public postgresqlRdbms?: (google.cloud.datastream.v1.IPostgresqlRdbms|null);

DiscoverConnectionProfileRequest postgresqlRdbms.

sqlServerRdbms

public sqlServerRdbms?: (google.cloud.datastream.v1.ISqlServerRdbms|null);

DiscoverConnectionProfileRequest sqlServerRdbms.

target

public target?: ("connectionProfile"|"connectionProfileName");

DiscoverConnectionProfileRequest target.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.IDiscoverConnectionProfileRequest): google.cloud.datastream.v1.DiscoverConnectionProfileRequest;

Creates a new DiscoverConnectionProfileRequest instance using the specified properties.

Parameter
Name Description
properties IDiscoverConnectionProfileRequest

Properties to set
Returns
Type Description
DiscoverConnectionProfileRequest

DiscoverConnectionProfileRequest instance

decode(reader, length)

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

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

DiscoverConnectionProfileRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
DiscoverConnectionProfileRequest

DiscoverConnectionProfileRequest

encode(message, writer)

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

Encodes the specified DiscoverConnectionProfileRequest message. Does not implicitly messages.

Parameters
Name Description
message IDiscoverConnectionProfileRequest

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

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

Parameters
Name Description
message IDiscoverConnectionProfileRequest

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

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

DiscoverConnectionProfileRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DiscoverConnectionProfileRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DiscoverConnectionProfileRequest

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