Datastream V1 API - Class Google::Cloud::Datastream::V1::DiscoverConnectionProfileRequest (v1.8.0)

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

Request message for 'discover' ConnectionProfile request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#connection_profile

def connection_profile() -> ::Google::Cloud::Datastream::V1::ConnectionProfile
Returns
  • (::Google::Cloud::Datastream::V1::ConnectionProfile) — Optional. An ad-hoc connection profile configuration.

    Note: The following fields are mutually exclusive: connection_profile, connection_profile_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#connection_profile=

def connection_profile=(value) -> ::Google::Cloud::Datastream::V1::ConnectionProfile
Parameter
  • value (::Google::Cloud::Datastream::V1::ConnectionProfile) — Optional. An ad-hoc connection profile configuration.

    Note: The following fields are mutually exclusive: connection_profile, connection_profile_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::ConnectionProfile) — Optional. An ad-hoc connection profile configuration.

    Note: The following fields are mutually exclusive: connection_profile, connection_profile_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#connection_profile_name

def connection_profile_name() -> ::String
Returns
  • (::String) — Optional. A reference to an existing connection profile.

    Note: The following fields are mutually exclusive: connection_profile_name, connection_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

#connection_profile_name=

def connection_profile_name=(value) -> ::String
Parameter
  • value (::String) — Optional. A reference to an existing connection profile.

    Note: The following fields are mutually exclusive: connection_profile_name, connection_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Optional. A reference to an existing connection profile.

    Note: The following fields are mutually exclusive: connection_profile_name, connection_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

#full_hierarchy

def full_hierarchy() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

    Note: The following fields are mutually exclusive: full_hierarchy, hierarchy_depth. If a field in that set is populated, all other fields in the set will automatically be cleared.

#full_hierarchy=

def full_hierarchy=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

    Note: The following fields are mutually exclusive: full_hierarchy, hierarchy_depth. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).

    Note: The following fields are mutually exclusive: full_hierarchy, hierarchy_depth. If a field in that set is populated, all other fields in the set will automatically be cleared.

#hierarchy_depth

def hierarchy_depth() -> ::Integer
Returns
  • (::Integer) — Optional. The number of hierarchy levels below the current level to be retrieved.

    Note: The following fields are mutually exclusive: hierarchy_depth, full_hierarchy. If a field in that set is populated, all other fields in the set will automatically be cleared.

#hierarchy_depth=

def hierarchy_depth=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of hierarchy levels below the current level to be retrieved.

    Note: The following fields are mutually exclusive: hierarchy_depth, full_hierarchy. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — Optional. The number of hierarchy levels below the current level to be retrieved.

    Note: The following fields are mutually exclusive: hierarchy_depth, full_hierarchy. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mongodb_cluster

def mongodb_cluster() -> ::Google::Cloud::Datastream::V1::MongodbCluster
Returns
  • (::Google::Cloud::Datastream::V1::MongodbCluster) — Optional. MongoDB cluster to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mongodb_cluster, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mongodb_cluster=

def mongodb_cluster=(value) -> ::Google::Cloud::Datastream::V1::MongodbCluster
Parameter
  • value (::Google::Cloud::Datastream::V1::MongodbCluster) — Optional. MongoDB cluster to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mongodb_cluster, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::MongodbCluster) — Optional. MongoDB cluster to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mongodb_cluster, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mysql_rdbms

def mysql_rdbms() -> ::Google::Cloud::Datastream::V1::MysqlRdbms
Returns
  • (::Google::Cloud::Datastream::V1::MysqlRdbms) — Optional. MySQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mysql_rdbms, oracle_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#mysql_rdbms=

def mysql_rdbms=(value) -> ::Google::Cloud::Datastream::V1::MysqlRdbms
Parameter
  • value (::Google::Cloud::Datastream::V1::MysqlRdbms) — Optional. MySQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mysql_rdbms, oracle_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::MysqlRdbms) — Optional. MySQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: mysql_rdbms, oracle_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#oracle_rdbms

def oracle_rdbms() -> ::Google::Cloud::Datastream::V1::OracleRdbms
Returns
  • (::Google::Cloud::Datastream::V1::OracleRdbms) — Optional. Oracle RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#oracle_rdbms=

def oracle_rdbms=(value) -> ::Google::Cloud::Datastream::V1::OracleRdbms
Parameter
  • value (::Google::Cloud::Datastream::V1::OracleRdbms) — Optional. Oracle RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::OracleRdbms) — Optional. Oracle RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.
Returns
  • (::String) — Required. The parent resource of the connection profile type. Must be in the format projects/*/locations/*.

#postgresql_rdbms

def postgresql_rdbms() -> ::Google::Cloud::Datastream::V1::PostgresqlRdbms
Returns
  • (::Google::Cloud::Datastream::V1::PostgresqlRdbms) — Optional. PostgreSQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: postgresql_rdbms, oracle_rdbms, mysql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#postgresql_rdbms=

def postgresql_rdbms=(value) -> ::Google::Cloud::Datastream::V1::PostgresqlRdbms
Parameter
  • value (::Google::Cloud::Datastream::V1::PostgresqlRdbms) — Optional. PostgreSQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: postgresql_rdbms, oracle_rdbms, mysql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::PostgresqlRdbms) — Optional. PostgreSQL RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: postgresql_rdbms, oracle_rdbms, mysql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#salesforce_org

def salesforce_org() -> ::Google::Cloud::Datastream::V1::SalesforceOrg
Returns
  • (::Google::Cloud::Datastream::V1::SalesforceOrg) — Optional. Salesforce organization to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: salesforce_org, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#salesforce_org=

def salesforce_org=(value) -> ::Google::Cloud::Datastream::V1::SalesforceOrg
Parameter
  • value (::Google::Cloud::Datastream::V1::SalesforceOrg) — Optional. Salesforce organization to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: salesforce_org, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::SalesforceOrg) — Optional. Salesforce organization to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: salesforce_org, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#source_catalog

def source_catalog() -> ::Google::Cloud::Datastream::V1::SourceCatalog
Returns
  • (::Google::Cloud::Datastream::V1::SourceCatalog) — Optional. Source catalog to enrich with child data objects and metadata. This is mainly used to represent SaaS sources databases.

    Note: The following fields are mutually exclusive: source_catalog, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database. If a field in that set is populated, all other fields in the set will automatically be cleared.

#source_catalog=

def source_catalog=(value) -> ::Google::Cloud::Datastream::V1::SourceCatalog
Parameter
  • value (::Google::Cloud::Datastream::V1::SourceCatalog) — Optional. Source catalog to enrich with child data objects and metadata. This is mainly used to represent SaaS sources databases.

    Note: The following fields are mutually exclusive: source_catalog, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::SourceCatalog) — Optional. Source catalog to enrich with child data objects and metadata. This is mainly used to represent SaaS sources databases.

    Note: The following fields are mutually exclusive: source_catalog, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, spanner_database. If a field in that set is populated, all other fields in the set will automatically be cleared.

#spanner_database

def spanner_database() -> ::Google::Cloud::Datastream::V1::SpannerDatabase
Returns
  • (::Google::Cloud::Datastream::V1::SpannerDatabase) — Optional. Spanner database to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: spanner_database, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#spanner_database=

def spanner_database=(value) -> ::Google::Cloud::Datastream::V1::SpannerDatabase
Parameter
  • value (::Google::Cloud::Datastream::V1::SpannerDatabase) — Optional. Spanner database to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: spanner_database, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::SpannerDatabase) — Optional. Spanner database to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: spanner_database, oracle_rdbms, mysql_rdbms, postgresql_rdbms, sql_server_rdbms, salesforce_org, mongodb_cluster, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sql_server_rdbms

def sql_server_rdbms() -> ::Google::Cloud::Datastream::V1::SqlServerRdbms
Returns
  • (::Google::Cloud::Datastream::V1::SqlServerRdbms) — Optional. SQLServer RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: sql_server_rdbms, oracle_rdbms, mysql_rdbms, postgresql_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sql_server_rdbms=

def sql_server_rdbms=(value) -> ::Google::Cloud::Datastream::V1::SqlServerRdbms
Parameter
  • value (::Google::Cloud::Datastream::V1::SqlServerRdbms) — Optional. SQLServer RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: sql_server_rdbms, oracle_rdbms, mysql_rdbms, postgresql_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Datastream::V1::SqlServerRdbms) — Optional. SQLServer RDBMS to enrich with child data objects and metadata.

    Note: The following fields are mutually exclusive: sql_server_rdbms, oracle_rdbms, mysql_rdbms, postgresql_rdbms, salesforce_org, mongodb_cluster, spanner_database, source_catalog. If a field in that set is populated, all other fields in the set will automatically be cleared.