Class DataCatalogConnection (2.33.0-rc)

Version latest

• 2.33.0-rc (latest)
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

The DataCatalogConnection object for DataCatalogClient.

This interface defines virtual methods for each of the user-facing overload sets in DataCatalogClient. This allows users to inject custom behavior (e.g., with a Google Mock object) when writing tests that use objects of type DataCatalogClient.

To create a concrete instance, see MakeDataCatalogConnection().

For mocking, see datacatalog_v1_mocks::MockDataCatalogConnection.

Functions

virtual options()

Returns
Type	Description
Options

virtual SearchCatalog(google::cloud::datacatalog::v1::SearchCatalogRequest)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::SearchCatalogRequest

Returns
Type	Description
StreamRange< google::cloud::datacatalog::v1::SearchCatalogResult >

virtual CreateEntryGroup(google::cloud::datacatalog::v1::CreateEntryGroupRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::CreateEntryGroupRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::EntryGroup >

virtual GetEntryGroup(google::cloud::datacatalog::v1::GetEntryGroupRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::GetEntryGroupRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::EntryGroup >

virtual UpdateEntryGroup(google::cloud::datacatalog::v1::UpdateEntryGroupRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UpdateEntryGroupRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::EntryGroup >

virtual DeleteEntryGroup(google::cloud::datacatalog::v1::DeleteEntryGroupRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::DeleteEntryGroupRequest const &

Returns
Type	Description
Status

virtual ListEntryGroups(google::cloud::datacatalog::v1::ListEntryGroupsRequest)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ListEntryGroupsRequest

Returns
Type	Description
StreamRange< google::cloud::datacatalog::v1::EntryGroup >

virtual CreateEntry(google::cloud::datacatalog::v1::CreateEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::CreateEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Entry >

virtual UpdateEntry(google::cloud::datacatalog::v1::UpdateEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UpdateEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Entry >

virtual DeleteEntry(google::cloud::datacatalog::v1::DeleteEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::DeleteEntryRequest const &

Returns
Type	Description
Status

virtual GetEntry(google::cloud::datacatalog::v1::GetEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::GetEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Entry >

virtual LookupEntry(google::cloud::datacatalog::v1::LookupEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::LookupEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Entry >

virtual ListEntries(google::cloud::datacatalog::v1::ListEntriesRequest)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ListEntriesRequest

Returns
Type	Description
StreamRange< google::cloud::datacatalog::v1::Entry >

virtual ModifyEntryOverview(google::cloud::datacatalog::v1::ModifyEntryOverviewRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ModifyEntryOverviewRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::EntryOverview >

virtual ModifyEntryContacts(google::cloud::datacatalog::v1::ModifyEntryContactsRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ModifyEntryContactsRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Contacts >

virtual CreateTagTemplate(google::cloud::datacatalog::v1::CreateTagTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::CreateTagTemplateRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplate >

virtual GetTagTemplate(google::cloud::datacatalog::v1::GetTagTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::GetTagTemplateRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplate >

virtual UpdateTagTemplate(google::cloud::datacatalog::v1::UpdateTagTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UpdateTagTemplateRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplate >

virtual DeleteTagTemplate(google::cloud::datacatalog::v1::DeleteTagTemplateRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::DeleteTagTemplateRequest const &

Returns
Type	Description
Status

virtual CreateTagTemplateField(google::cloud::datacatalog::v1::CreateTagTemplateFieldRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::CreateTagTemplateFieldRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplateField >

virtual UpdateTagTemplateField(google::cloud::datacatalog::v1::UpdateTagTemplateFieldRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UpdateTagTemplateFieldRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplateField >

virtual RenameTagTemplateField(google::cloud::datacatalog::v1::RenameTagTemplateFieldRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::RenameTagTemplateFieldRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplateField >

virtual RenameTagTemplateFieldEnumValue(google::cloud::datacatalog::v1::RenameTagTemplateFieldEnumValueRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::RenameTagTemplateFieldEnumValueRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::TagTemplateField >

virtual DeleteTagTemplateField(google::cloud::datacatalog::v1::DeleteTagTemplateFieldRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::DeleteTagTemplateFieldRequest const &

Returns
Type	Description
Status

virtual CreateTag(google::cloud::datacatalog::v1::CreateTagRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::CreateTagRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Tag >

virtual UpdateTag(google::cloud::datacatalog::v1::UpdateTagRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UpdateTagRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::Tag >

virtual DeleteTag(google::cloud::datacatalog::v1::DeleteTagRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::DeleteTagRequest const &

Returns
Type	Description
Status

virtual ListTags(google::cloud::datacatalog::v1::ListTagsRequest)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ListTagsRequest

Returns
Type	Description
StreamRange< google::cloud::datacatalog::v1::Tag >

virtual ReconcileTags(google::cloud::datacatalog::v1::ReconcileTagsRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ReconcileTagsRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::datacatalog::v1::ReconcileTagsResponse > >

virtual ReconcileTags(NoAwaitTag, google::cloud::datacatalog::v1::ReconcileTagsRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::datacatalog::v1::ReconcileTagsRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual ReconcileTags(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::datacatalog::v1::ReconcileTagsResponse > >

virtual StarEntry(google::cloud::datacatalog::v1::StarEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::StarEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::StarEntryResponse >

virtual UnstarEntry(google::cloud::datacatalog::v1::UnstarEntryRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::UnstarEntryRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::UnstarEntryResponse >

virtual SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &)

Parameter
Name	Description
request	google::iam::v1::SetIamPolicyRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::Policy >

virtual GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &)

Parameter
Name	Description
request	google::iam::v1::GetIamPolicyRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::Policy >

virtual TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &)

Parameter
Name	Description
request	google::iam::v1::TestIamPermissionsRequest const &

Returns
Type	Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

virtual ImportEntries(google::cloud::datacatalog::v1::ImportEntriesRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::ImportEntriesRequest const &

Returns
Type	Description
future< StatusOr< google::cloud::datacatalog::v1::ImportEntriesResponse > >

virtual ImportEntries(NoAwaitTag, google::cloud::datacatalog::v1::ImportEntriesRequest const &)

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::datacatalog::v1::ImportEntriesRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual ImportEntries(google::longrunning::Operation const &)

Parameter
Name	Description
operation	google::longrunning::Operation const &

Returns
Type	Description
future< StatusOr< google::cloud::datacatalog::v1::ImportEntriesResponse > >

virtual SetConfig(google::cloud::datacatalog::v1::SetConfigRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::SetConfigRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::MigrationConfig >

virtual RetrieveConfig(google::cloud::datacatalog::v1::RetrieveConfigRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::RetrieveConfigRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::OrganizationConfig >

virtual RetrieveEffectiveConfig(google::cloud::datacatalog::v1::RetrieveEffectiveConfigRequest const &)

Parameter
Name	Description
request	google::cloud::datacatalog::v1::RetrieveEffectiveConfigRequest const &

Returns
Type	Description
StatusOr< google::cloud::datacatalog::v1::MigrationConfig >

virtual ListOperations(google::longrunning::ListOperationsRequest)

Parameter
Name	Description
request	google::longrunning::ListOperationsRequest

Returns
Type	Description
StreamRange< google::longrunning::Operation >

virtual GetOperation(google::longrunning::GetOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::GetOperationRequest const &

Returns
Type	Description
StatusOr< google::longrunning::Operation >

virtual DeleteOperation(google::longrunning::DeleteOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::DeleteOperationRequest const &

Returns
Type	Description
Status

virtual CancelOperation(google::longrunning::CancelOperationRequest const &)

Parameter
Name	Description
request	google::longrunning::CancelOperationRequest const &

Returns
Type	Description
Status