Google Cloud Datastream V1 Client - Class DiscoverConnectionProfileRequest (1.5.5)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class DiscoverConnectionProfileRequest.

Request message for 'discover' ConnectionProfile request.

Generated from protobuf message google.cloud.datastream.v1.DiscoverConnectionProfileRequest

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

↳ connection_profile Google\Cloud\Datastream\V1\ConnectionProfile

An ad-hoc connection profile configuration.

↳ connection_profile_name string

A reference to an existing connection profile.

↳ full_hierarchy bool

Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

↳ hierarchy_depth int

The number of hierarchy levels below the current level to be retrieved.

↳ oracle_rdbms Google\Cloud\Datastream\V1\OracleRdbms

Oracle RDBMS to enrich with child data objects and metadata.

↳ mysql_rdbms Google\Cloud\Datastream\V1\MysqlRdbms

MySQL RDBMS to enrich with child data objects and metadata.

↳ postgresql_rdbms Google\Cloud\Datastream\V1\PostgresqlRdbms

PostgreSQL RDBMS to enrich with child data objects and metadata.

getParent

Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

Returns
Type Description
string

setParent

Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectionProfile

An ad-hoc connection profile configuration.

Returns
Type Description
Google\Cloud\Datastream\V1\ConnectionProfile|null

hasConnectionProfile

setConnectionProfile

An ad-hoc connection profile configuration.

Parameter
Name Description
var Google\Cloud\Datastream\V1\ConnectionProfile
Returns
Type Description
$this

getConnectionProfileName

A reference to an existing connection profile.

Returns
Type Description
string

hasConnectionProfileName

setConnectionProfileName

A reference to an existing connection profile.

Parameter
Name Description
var string
Returns
Type Description
$this

getFullHierarchy

Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

Returns
Type Description
bool

hasFullHierarchy

setFullHierarchy

Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

Parameter
Name Description
var bool
Returns
Type Description
$this

getHierarchyDepth

The number of hierarchy levels below the current level to be retrieved.

Returns
Type Description
int

hasHierarchyDepth

setHierarchyDepth

The number of hierarchy levels below the current level to be retrieved.

Parameter
Name Description
var int
Returns
Type Description
$this

getOracleRdbms

Oracle RDBMS to enrich with child data objects and metadata.

Returns
Type Description
Google\Cloud\Datastream\V1\OracleRdbms|null

hasOracleRdbms

setOracleRdbms

Oracle RDBMS to enrich with child data objects and metadata.

Parameter
Name Description
var Google\Cloud\Datastream\V1\OracleRdbms
Returns
Type Description
$this

getMysqlRdbms

MySQL RDBMS to enrich with child data objects and metadata.

Returns
Type Description
Google\Cloud\Datastream\V1\MysqlRdbms|null

hasMysqlRdbms

setMysqlRdbms

MySQL RDBMS to enrich with child data objects and metadata.

Parameter
Name Description
var Google\Cloud\Datastream\V1\MysqlRdbms
Returns
Type Description
$this

getPostgresqlRdbms

PostgreSQL RDBMS to enrich with child data objects and metadata.

Returns
Type Description
Google\Cloud\Datastream\V1\PostgresqlRdbms|null

hasPostgresqlRdbms

setPostgresqlRdbms

PostgreSQL RDBMS to enrich with child data objects and metadata.

Parameter
Name Description
var Google\Cloud\Datastream\V1\PostgresqlRdbms
Returns
Type Description
$this

getTarget

Returns
Type Description
string

getHierarchy

Returns
Type Description
string

getDataObject

Returns
Type Description
string