Class DataCatalogClient (2.21.0)

Data Catalog API service allows you to discover, understand, and manage your data.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DataCatalogClient(DataCatalogClient const &)

Copy and move support

Parameter
Name	Description
	`DataCatalogClient const &`

DataCatalogClient(DataCatalogClient &&)

Copy and move support

Parameter
Name	Description
	`DataCatalogClient &&`

DataCatalogClient(std::shared_ptr< DataCatalogConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DataCatalogConnection >`
`opts`	`Options`

Operators

operator=(DataCatalogClient const &)

Copy and move support

Parameter
Name	Description
	`DataCatalogClient const &`

Returns
Type	Description
`DataCatalogClient &`

operator=(DataCatalogClient &&)

Copy and move support

Parameter
Name	Description
	`DataCatalogClient &&`

Returns
Type	Description
`DataCatalogClient &`

Functions

SearchCatalog(google::cloud::datacatalog::v1::SearchCatalogRequest::Scope const &, std::string const &, Options)

Searches Data Catalog for multiple resources like entries and tags that match a query.

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`scope`	`google::cloud::datacatalog::v1::SearchCatalogRequest::Scope const &` Required. The scope of this search request. The `scope` is invalid if `include_org_ids`, `include_project_ids` are empty AND `include_gcp_public_datasets` is set to `false`. In this case, the request returns an error.
`query`	`std::string const &` Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax. An empty query string returns all data assets (in the specified scope) that you have access to. A query string can be a simple `xyz` or qualified by predicates: `name:x` `column:y` `description:z`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::SearchCatalogResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.SearchCatalogResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchCatalog(google::cloud::datacatalog::v1::SearchCatalogRequest, Options)

Searches Data Catalog for multiple resources like entries and tags that match a query.

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::SearchCatalogRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.SearchCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::SearchCatalogResult >

CreateEntryGroup(std::string const &, std::string const &, google::cloud::datacatalog::v1::EntryGroup const &, Options)

Creates an entry group.

An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups.

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups.

Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name.
`entry_group_id`	`std::string const &` Required. The ID of the entry group to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
`entry_group`	`google::cloud::datacatalog::v1::EntryGroup const &` The entry group to create. Defaults to empty.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEntryGroup(google::cloud::datacatalog::v1::CreateEntryGroupRequest const &, Options)

Creates an entry group.

An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups.

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::CreateEntryGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.CreateEntryGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEntryGroup(std::string const &, Options)

Gets an entry group.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry group to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEntryGroup(std::string const &, google::protobuf::FieldMask const &, Options)

Gets an entry group.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry group to get.
`read_mask`	`google::protobuf::FieldMask const &` The fields to return. If empty or omitted, all fields are returned.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEntryGroup(google::cloud::datacatalog::v1::GetEntryGroupRequest const &, Options)

Gets an entry group.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::GetEntryGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.GetEntryGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntryGroup(google::cloud::datacatalog::v1::EntryGroup const &, Options)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`entry_group`	`google::cloud::datacatalog::v1::EntryGroup const &` Required. Updates for the entry group. The `name` field must be set.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntryGroup(google::cloud::datacatalog::v1::EntryGroup const &, google::protobuf::FieldMask const &, Options)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`entry_group`	`google::cloud::datacatalog::v1::EntryGroup const &` Required. Updates for the entry group. The `name` field must be set.
`update_mask`	`google::protobuf::FieldMask const &` Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntryGroup(google::cloud::datacatalog::v1::UpdateEntryGroupRequest const &, Options)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UpdateEntryGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UpdateEntryGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteEntryGroup(std::string const &, Options)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry group to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteEntryGroup(google::cloud::datacatalog::v1::DeleteEntryGroupRequest const &, Options)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::DeleteEntryGroupRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.DeleteEntryGroupRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListEntryGroups(std::string const &, Options)

Lists entry groups.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the location that contains the entry groups to list. Can be provided as a URL.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::EntryGroup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.EntryGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntryGroups(google::cloud::datacatalog::v1::ListEntryGroupsRequest, Options)

Lists entry groups.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ListEntryGroupsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ListEntryGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::EntryGroup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.EntryGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateEntry(std::string const &, std::string const &, google::cloud::datacatalog::v1::Entry const &, Options)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name.
`entry_id`	`std::string const &` Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.
`entry`	`google::cloud::datacatalog::v1::Entry const &` Required. The entry to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEntry(google::cloud::datacatalog::v1::CreateEntryRequest const &, Options)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::CreateEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.CreateEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntry(google::cloud::datacatalog::v1::Entry const &, Options)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`entry`	`google::cloud::datacatalog::v1::Entry const &` Required. Updates for the entry. The `name` field must be set.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntry(google::cloud::datacatalog::v1::Entry const &, google::protobuf::FieldMask const &, Options)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`entry`	`google::cloud::datacatalog::v1::Entry const &` Required. Updates for the entry. The `name` field must be set.
`update_mask`	`google::protobuf::FieldMask const &` Names of fields whose values to overwrite on an entry. For more information, see UpdateEntryRequest.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEntry(google::cloud::datacatalog::v1::UpdateEntryRequest const &, Options)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UpdateEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UpdateEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteEntry(std::string const &, Options)

Deletes an existing entry.

You can delete only the entries created by the CreateEntry method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteEntry(google::cloud::datacatalog::v1::DeleteEntryRequest const &, Options)

Deletes an existing entry.

You can delete only the entries created by the CreateEntry method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::DeleteEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.DeleteEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetEntry(std::string const &, Options)

Gets an entry.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEntry(google::cloud::datacatalog::v1::GetEntryRequest const &, Options)

Gets an entry.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::GetEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.GetEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

LookupEntry(google::cloud::datacatalog::v1::LookupEntryRequest const &, Options)

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::LookupEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.LookupEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Entry >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListEntries(std::string const &, Options)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the entry group that contains the entries to list. Can be provided in URL format.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::Entry >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.Entry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntries(google::cloud::datacatalog::v1::ListEntriesRequest, Options)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ListEntriesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ListEntriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::Entry >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.Entry, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ModifyEntryOverview(google::cloud::datacatalog::v1::ModifyEntryOverviewRequest const &, Options)

Modifies entry overview, part of the business context of an Entry.

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ModifyEntryOverviewRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ModifyEntryOverviewRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::EntryOverview >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.EntryOverview) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ModifyEntryContacts(google::cloud::datacatalog::v1::ModifyEntryContactsRequest const &, Options)

Modifies contacts, part of the business context of an Entry.

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ModifyEntryContactsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ModifyEntryContactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Contacts >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Contacts) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTagTemplate(std::string const &, std::string const &, google::cloud::datacatalog::v1::TagTemplate const &, Options)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project and the template location region.
`tag_template_id`	`std::string const &` Required. The ID of the tag template to create. The ID must contain only lowercase letters (a-z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum size is 64 bytes when encoded in UTF-8.
`tag_template`	`google::cloud::datacatalog::v1::TagTemplate const &` Required. The tag template to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTagTemplate(google::cloud::datacatalog::v1::CreateTagTemplateRequest const &, Options)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::CreateTagTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.CreateTagTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTagTemplate(std::string const &, Options)

Gets a tag template.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetTagTemplate(google::cloud::datacatalog::v1::GetTagTemplateRequest const &, Options)

Gets a tag template.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::GetTagTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.GetTagTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplate(google::cloud::datacatalog::v1::TagTemplate const &, Options)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`tag_template`	`google::cloud::datacatalog::v1::TagTemplate const &` Required. The template to update. The `name` field must be set.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplate(google::cloud::datacatalog::v1::TagTemplate const &, google::protobuf::FieldMask const &, Options)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`tag_template`	`google::cloud::datacatalog::v1::TagTemplate const &` Required. The template to update. The `name` field must be set.
`update_mask`	`google::protobuf::FieldMask const &` Names of fields whose values to overwrite on a tag template. Currently, only `display_name` and `is_publicly_readable` can be overwritten. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. Note: Updating the `is_publicly_readable` field may require up to 12 hours to take effect in search results.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplate(google::cloud::datacatalog::v1::UpdateTagTemplateRequest const &, Options)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UpdateTagTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UpdateTagTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplate >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTagTemplate(std::string const &, bool, Options)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template to delete.
`force`	`bool` Required. If true, deletes all tags that use this template. Currently, `true` is the only supported value.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTagTemplate(google::cloud::datacatalog::v1::DeleteTagTemplateRequest const &, Options)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::DeleteTagTemplateRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.DeleteTagTemplateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateTagTemplateField(std::string const &, std::string const &, google::cloud::datacatalog::v1::TagTemplateField const &, Options)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the project and the template location region.
`tag_template_field_id`	`std::string const &` Required. The ID of the tag template field to create. Note: Adding a required field to an existing template is not allowed. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template.
`tag_template_field`	`google::cloud::datacatalog::v1::TagTemplateField const &` Required. The tag template field to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTagTemplateField(google::cloud::datacatalog::v1::CreateTagTemplateFieldRequest const &, Options)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::CreateTagTemplateFieldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.CreateTagTemplateFieldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplateField(std::string const &, google::cloud::datacatalog::v1::TagTemplateField const &, Options)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template field.
`tag_template_field`	`google::cloud::datacatalog::v1::TagTemplateField const &` Required. The template to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplateField(std::string const &, google::cloud::datacatalog::v1::TagTemplateField const &, google::protobuf::FieldMask const &, Options)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template field.
`tag_template_field`	`google::cloud::datacatalog::v1::TagTemplateField const &` Required. The template to update.
`update_mask`	`google::protobuf::FieldMask const &` Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable: `display_name` `type.enum_type` `is_required` If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed. Additionally, updating a template field from optional to required is not allowed.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTagTemplateField(google::cloud::datacatalog::v1::UpdateTagTemplateFieldRequest const &, Options)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UpdateTagTemplateFieldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UpdateTagTemplateFieldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameTagTemplateField(std::string const &, std::string const &, Options)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template field.
`new_tag_template_field_id`	`std::string const &` Required. The new ID of this tag template field. For example, `my_new_field`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameTagTemplateField(google::cloud::datacatalog::v1::RenameTagTemplateFieldRequest const &, Options)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::RenameTagTemplateFieldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.RenameTagTemplateFieldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameTagTemplateFieldEnumValue(std::string const &, std::string const &, Options)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the enum field value.
`new_enum_value_display_name`	`std::string const &` Required. The new display name of the enum value. For example, `my_new_enum_value`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenameTagTemplateFieldEnumValue(google::cloud::datacatalog::v1::RenameTagTemplateFieldEnumValueRequest const &, Options)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::RenameTagTemplateFieldEnumValueRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.RenameTagTemplateFieldEnumValueRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::TagTemplateField >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.TagTemplateField) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTagTemplateField(std::string const &, bool, Options)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag template field to delete.
`force`	`bool` Required. If true, deletes this field from any tags that use it. Currently, `true` is the only supported value.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTagTemplateField(google::cloud::datacatalog::v1::DeleteTagTemplateFieldRequest const &, Options)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::DeleteTagTemplateFieldRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.DeleteTagTemplateFieldRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

CreateTag(std::string const &, google::cloud::datacatalog::v1::Tag const &, Options)

Creates a tag and assigns it to:

An Entry if the method name is projects.locations.entryGroups.entries.tags.create.
Or EntryGroupif the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the resource to attach this tag to. Tags can be attached to entries or entry groups. An entry can have up to 1000 attached tags. Note: The tag and its child resources might not be stored in the location specified in its name.
`tag`	`google::cloud::datacatalog::v1::Tag const &` Required. The tag to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Tag >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateTag(google::cloud::datacatalog::v1::CreateTagRequest const &, Options)

Creates a tag and assigns it to:

An Entry if the method name is projects.locations.entryGroups.entries.tags.create.
Or EntryGroupif the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::CreateTagRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.CreateTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Tag >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTag(google::cloud::datacatalog::v1::Tag const &, Options)

Updates an existing tag.

Parameters
Name	Description
`tag`	`google::cloud::datacatalog::v1::Tag const &` Required. The updated tag. The "name" field must be set.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Tag >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTag(google::cloud::datacatalog::v1::Tag const &, google::protobuf::FieldMask const &, Options)

Updates an existing tag.

Parameters
Name	Description
`tag`	`google::cloud::datacatalog::v1::Tag const &` Required. The updated tag. The "name" field must be set.
`update_mask`	`google::protobuf::FieldMask const &` Names of fields whose values to overwrite on a tag. Currently, a tag has the only modifiable field with the name `fields`. In general, if this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Tag >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateTag(google::cloud::datacatalog::v1::UpdateTagRequest const &, Options)

Updates an existing tag.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UpdateTagRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UpdateTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::Tag >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.Tag) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteTag(std::string const &, Options)

Deletes a tag.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the tag to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteTag(google::cloud::datacatalog::v1::DeleteTagRequest const &, Options)

Deletes a tag.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::DeleteTagRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.DeleteTagRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListTags(std::string const &, Options)

Lists tags assigned to an Entry.

The columns in the response are lowercased.

Parameters
Name	Description
`parent`	`std::string const &` Required. The name of the Data Catalog resource to list the tags of. The resource can be an Entry or an EntryGroup (without `/entries/{entries}` at the end).
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::Tag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.Tag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTags(google::cloud::datacatalog::v1::ListTagsRequest, Options)

Lists tags assigned to an Entry.

The columns in the response are lowercased.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ListTagsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ListTagsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::datacatalog::v1::Tag >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.v1.Tag, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

ReconcileTags creates or updates a list of tags on the entry.

If the ReconcileTagsRequest.force_delete_missing parameter is set, the operation deletes tags not included in the input tag list.

ReconcileTags returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] google.cloud.datacatalog.v1.ReconcileTagsResponse message.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ReconcileTagsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ReconcileTagsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::datacatalog::v1::ReconcileTagsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.v1.ReconcileTagsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StarEntry(std::string const &, Options)

Marks an Entry as starred by the current user.

Starring information is private to each user.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry to mark as starred.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::StarEntryResponse >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.StarEntryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

StarEntry(google::cloud::datacatalog::v1::StarEntryRequest const &, Options)

Marks an Entry as starred by the current user.

Starring information is private to each user.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::StarEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.StarEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::StarEntryResponse >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.StarEntryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UnstarEntry(std::string const &, Options)

Marks an Entry as NOT starred by the current user.

Starring information is private to each user.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the entry to mark as not starred.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::UnstarEntryResponse >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.UnstarEntryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UnstarEntry(google::cloud::datacatalog::v1::UnstarEntryRequest const &, Options)

Marks an Entry as NOT starred by the current user.

Starring information is private to each user.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::UnstarEntryRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.UnstarEntryRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::datacatalog::v1::UnstarEntryResponse >`	the result of the RPC. The response message type (google.cloud.datacatalog.v1.UnstarEntryResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)

Sets an access control policy for a resource.

Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`policy`	`google::iam::v1::Policy const &` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(std::string const &, IamUpdater const &, Options)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
Name	Description
`resource`	`std::string const &` Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
`updater`	`IamUpdater const &` Required. Functor to map the current policy to a new one.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets an access control policy for a resource.

Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIamPolicy(std::string const &, Options)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`resource`	`std::string const &` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.

No Google IAM permissions are required to call this method.

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog.

Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.

ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.

ImportEntries returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message.

Parameters
Name	Description
`request`	`google::cloud::datacatalog::v1::ImportEntriesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.v1.ImportEntriesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::datacatalog::v1::ImportEntriesResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.v1.ImportEntriesResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.