Google Cloud Datastream V1 Client - Class DiscoverConnectionProfileRequest (2.1.1)

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`	`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`	`OracleRdbms` Oracle RDBMS to enrich with child data objects and metadata.
`↳ mysql_rdbms`	`MysqlRdbms` MySQL RDBMS to enrich with child data objects and metadata.
`↳ postgresql_rdbms`	`PostgresqlRdbms` PostgreSQL RDBMS to enrich with child data objects and metadata.
`↳ sql_server_rdbms`	`SqlServerRdbms` SQLServer 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
`ConnectionProfile\|null`

hasConnectionProfile

setConnectionProfile

An ad-hoc connection profile configuration.

Parameter
Name	Description
`var`	`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
`OracleRdbms\|null`

hasOracleRdbms

setOracleRdbms

Oracle RDBMS to enrich with child data objects and metadata.

Parameter
Name	Description
`var`	`OracleRdbms`

Returns
Type	Description
`$this`

getMysqlRdbms

MySQL RDBMS to enrich with child data objects and metadata.

Returns
Type	Description
`MysqlRdbms\|null`

hasMysqlRdbms

setMysqlRdbms