Method: projects.locations.connectionProfiles.discover

HTTP request
Path parameters
Request body
- JSON representation
Response body
- JSON representation
Authorization scopes
Examples

Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

HTTP request

POST https://datastream.googleapis.com/v1/{parent}/connectionProfiles:discover

Path parameters

Parameters

Parameters
`parent`	`string` Required. The parent resource of the connection profile type. Must be in the format `projects//locations/`. Authorization requires the following IAM permission on the specified resource `parent`: `datastream.connectionProfiles.discover`

parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

datastream.connectionProfiles.discover

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ // Union field `target` can be only one of the following: "connectionProfile": { object (`ConnectionProfile`) }, "connectionProfileName": string // End of list of possible types for union field `target`. // Union field `hierarchy` can be only one of the following: "fullHierarchy": boolean, "hierarchyDepth": integer // End of list of possible types for union field `hierarchy`. // Union field `data_object` can be only one of the following: "oracleRdbms": { object (`OracleRdbms`) }, "mysqlRdbms": { object (`MysqlRdbms`) }, "postgresqlRdbms": { object (`PostgresqlRdbms`) }, "sqlServerRdbms": { object (`SqlServerRdbms`) } // End of list of possible types for union field `data_object`. }

{

  // Union field target can be only one of the following:
  "connectionProfile": {
    object (ConnectionProfile)
  },
  "connectionProfileName": string
  // End of list of possible types for union field target.

  // Union field hierarchy can be only one of the following:
  "fullHierarchy": boolean,
  "hierarchyDepth": integer
  // End of list of possible types for union field hierarchy.

  // Union field data_object can be only one of the following:
  "oracleRdbms": {
    object (OracleRdbms)
  },
  "mysqlRdbms": {
    object (MysqlRdbms)
  },
  "postgresqlRdbms": {
    object (PostgresqlRdbms)
  },
  "sqlServerRdbms": {
    object (SqlServerRdbms)
  }
  // End of list of possible types for union field data_object.
}

Fields
Union field `target`. The connection profile on which to run discover. `target` can be only one of the following:
`connectionProfile`	`object (ConnectionProfile)` An ad-hoc connection profile configuration.
`connectionProfileName`	`string` A reference to an existing connection profile.
Union field `hierarchy`. The depth of the retrieved hierarchy of data objects. `hierarchy` can be only one of the following:
`fullHierarchy`	`boolean` Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
`hierarchyDepth`	`integer` The number of hierarchy levels below the current level to be retrieved.
Union field `data_object`. The data object to populate with child data objects and metadata. `data_object` can be only one of the following:
`oracleRdbms`	`object (OracleRdbms)` Oracle RDBMS to enrich with child data objects and metadata.
`mysqlRdbms`	`object (MysqlRdbms)` MySQL RDBMS to enrich with child data objects and metadata.
`postgresqlRdbms`	`object (PostgresqlRdbms)` PostgreSQL RDBMS to enrich with child data objects and metadata.
`sqlServerRdbms`	`object (SqlServerRdbms)` SQLServer RDBMS to enrich with child data objects and metadata.

Response body

Response from a discover request.

If successful, the response body contains data with the following structure:

JSON representation

JSON representation
{ // Union field `data_object` can be only one of the following: "oracleRdbms": { object (`OracleRdbms`) }, "mysqlRdbms": { object (`MysqlRdbms`) }, "postgresqlRdbms": { object (`PostgresqlRdbms`) }, "sqlServerRdbms": { object (`SqlServerRdbms`) } // End of list of possible types for union field `data_object`. }

{

  // Union field data_object can be only one of the following:
  "oracleRdbms": {
    object (OracleRdbms)
  },
  "mysqlRdbms": {
    object (MysqlRdbms)
  },
  "postgresqlRdbms": {
    object (PostgresqlRdbms)
  },
  "sqlServerRdbms": {
    object (SqlServerRdbms)
  }
  // End of list of possible types for union field data_object.
}

Fields
Union field `data_object`. The data object that has been enriched by the discover API call. `data_object` can be only one of the following:
`oracleRdbms`	`object (OracleRdbms)` Enriched Oracle RDBMS object.
`mysqlRdbms`	`object (MysqlRdbms)` Enriched MySQL RDBMS object.
`postgresqlRdbms`	`object (PostgresqlRdbms)` Enriched PostgreSQL RDBMS object.
`sqlServerRdbms`	`object (SqlServerRdbms)` Enriched SQLServer RDBMS object.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.