Class CatalogServiceClient (2.23.0-rc)

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, Entry and Aspect which collectively allow a data administrator to organize, manage, secure and catalog data across their organization located across cloud projects in a variety of storage systems including Cloud Storage and BigQuery.

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

CatalogServiceClient(CatalogServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CatalogServiceClient const &`

CatalogServiceClient(CatalogServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CatalogServiceClient &&`

CatalogServiceClient(std::shared_ptr< CatalogServiceConnection >, Options)

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

Operators

operator=(CatalogServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CatalogServiceClient const &`

Returns
Type	Description
`CatalogServiceClient &`

operator=(CatalogServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CatalogServiceClient &&`

Returns
Type	Description
`CatalogServiceClient &`

Functions

CreateEntryType(std::string const &, google::cloud::dataplex::v1::EntryType const &, std::string const &, Options)

Creates an EntryType.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
`entry_type`	`google::cloud::dataplex::v1::EntryType const &` Required. EntryType Resource
`entry_type_id`	`std::string const &` Required. EntryType identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::EntryType > >

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.dataplex.v1.EntryType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEntryType(google::cloud::dataplex::v1::CreateEntryTypeRequest const &, Options)

Creates an EntryType.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::CreateEntryTypeRequest 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.dataplex.v1.CreateEntryTypeRequest. 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::dataplex::v1::EntryType > >

UpdateEntryType(google::cloud::dataplex::v1::EntryType const &, google::protobuf::FieldMask const &, Options)

Updates a EntryType resource.

Parameters
Name	Description
`entry_type`	`google::cloud::dataplex::v1::EntryType const &` Required. EntryType Resource
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::EntryType > >

UpdateEntryType(google::cloud::dataplex::v1::UpdateEntryTypeRequest const &, Options)

Updates a EntryType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::UpdateEntryTypeRequest 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.dataplex.v1.UpdateEntryTypeRequest. 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::dataplex::v1::EntryType > >

DeleteEntryType(std::string const &, Options)

Deletes a EntryType resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEntryType(google::cloud::dataplex::v1::DeleteEntryTypeRequest const &, Options)

Deletes a EntryType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::DeleteEntryTypeRequest 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.dataplex.v1.DeleteEntryTypeRequest. 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::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListEntryTypes(std::string const &, Options)

Lists EntryType resources in a project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the EntryType location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::EntryType >

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.dataplex.v1.EntryType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntryTypes(google::cloud::dataplex::v1::ListEntryTypesRequest, Options)

Lists EntryType resources in a project and location.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListEntryTypesRequest` 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.dataplex.v1.ListEntryTypesRequest. 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::dataplex::v1::EntryType >

GetEntryType(std::string const &, Options)

Retrieves a EntryType resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the EntryType: `projects/{project_number}/locations/{location_id}/entryTypes/{entry_type_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetEntryType(google::cloud::dataplex::v1::GetEntryTypeRequest const &, Options)

Retrieves a EntryType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetEntryTypeRequest 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.dataplex.v1.GetEntryTypeRequest. 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::dataplex::v1::EntryType >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.EntryType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateAspectType(std::string const &, google::cloud::dataplex::v1::AspectType const &, std::string const &, Options)

Creates an AspectType.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
`aspect_type`	`google::cloud::dataplex::v1::AspectType const &` Required. AspectType Resource
`aspect_type_id`	`std::string const &` Required. AspectType identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::AspectType > >

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.dataplex.v1.AspectType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAspectType(google::cloud::dataplex::v1::CreateAspectTypeRequest const &, Options)

Creates an AspectType.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::CreateAspectTypeRequest 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.dataplex.v1.CreateAspectTypeRequest. 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::dataplex::v1::AspectType > >

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.dataplex.v1.AspectType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAspectType(google::cloud::dataplex::v1::AspectType const &, google::protobuf::FieldMask const &, Options)

Updates a AspectType resource.

Parameters
Name	Description
`aspect_type`	`google::cloud::dataplex::v1::AspectType const &` Required. AspectType Resource
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::AspectType > >

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.dataplex.v1.AspectType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAspectType(google::cloud::dataplex::v1::UpdateAspectTypeRequest const &, Options)

Updates a AspectType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::UpdateAspectTypeRequest 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.dataplex.v1.UpdateAspectTypeRequest. 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::dataplex::v1::AspectType > >

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.dataplex.v1.AspectType proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAspectType(std::string const &, Options)

Deletes a AspectType resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAspectType(google::cloud::dataplex::v1::DeleteAspectTypeRequest const &, Options)

Deletes a AspectType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::DeleteAspectTypeRequest 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.dataplex.v1.DeleteAspectTypeRequest. 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::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListAspectTypes(std::string const &, Options)

Lists AspectType resources in a project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the AspectType location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::AspectType >

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.dataplex.v1.AspectType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAspectTypes(google::cloud::dataplex::v1::ListAspectTypesRequest, Options)

Lists AspectType resources in a project and location.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListAspectTypesRequest` 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.dataplex.v1.ListAspectTypesRequest. 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::dataplex::v1::AspectType >

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.dataplex.v1.AspectType, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAspectType(std::string const &, Options)

Retrieves a AspectType resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the AspectType: `projects/{project_number}/locations/{location_id}/aspectTypes/{aspect_type_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetAspectType(google::cloud::dataplex::v1::GetAspectTypeRequest const &, Options)

Retrieves a AspectType resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetAspectTypeRequest 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.dataplex.v1.GetAspectTypeRequest. 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::dataplex::v1::AspectType >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.AspectType) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

Creates an EntryGroup.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the entryGroup, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
`entry_group`	`google::cloud::dataplex::v1::EntryGroup const &` Required. EntryGroup Resource
`entry_group_id`	`std::string const &` Required. EntryGroup identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >

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.dataplex.v1.EntryGroup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Creates an EntryGroup.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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

future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >

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.dataplex.v1.EntryGroup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Updates a EntryGroup resource.

Parameters
Name	Description
`entry_group`	`google::cloud::dataplex::v1::EntryGroup const &` Required. EntryGroup Resource
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >

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.dataplex.v1.EntryGroup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Updates a EntryGroup resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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

future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >

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.dataplex.v1.EntryGroup proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteEntryGroup(std::string const &, Options)

Deletes a EntryGroup resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a EntryGroup resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

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.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListEntryGroups(std::string const &, Options)

Lists EntryGroup resources in a project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the entryGroup location, of the form: `projects/{project_number}/locations/{location_id}` where `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::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.dataplex.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::dataplex::v1::ListEntryGroupsRequest, Options)

Lists EntryGroup resources in a project and location.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::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.dataplex.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.

GetEntryGroup(std::string const &, Options)

Retrieves a EntryGroup resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the EntryGroup: `projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::GetEntryGroupRequest const &, Options)

Retrieves a EntryGroup resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::v1::EntryGroup >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.EntryGroup) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

Creates an Entry.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent Entry Group: `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
`entry`	`google::cloud::dataplex::v1::Entry const &` Required. Entry resource.
`entry_id`	`std::string const &` Required. Entry identifier. It has to be unique within an Entry Group. Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name. For example if the Full Resource Name of a resource is `//library.googleapis.com/shelves/shelf1/books/book2`, then the suggested entry_id is `library.googleapis.com/shelves/shelf1/books/book2`. It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud. The maximum size of the field is 4000 characters.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::CreateEntryRequest const &, Options)

Creates an Entry.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::Entry const &, google::protobuf::FieldMask const &, Options)

Updates an Entry.

Parameters
Name	Description
`entry`	`google::cloud::dataplex::v1::Entry const &` Required. Entry resource.
`update_mask`	`google::protobuf::FieldMask const &` Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects". If the update_mask is empty, all modifiable fields present in the request will be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::UpdateEntryRequest const &, Options)

Updates an Entry.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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 Entry.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Entry: `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

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

Deletes an Entry.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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
`StatusOr< google::cloud::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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 within an entry group.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent Entry Group: `projects/{project}/locations/{location}/entryGroups/{entry_group}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::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.dataplex.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::dataplex::v1::ListEntriesRequest, Options)

Lists entries within an entry group.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::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.dataplex.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.

GetEntry(std::string const &, Options)

Gets a single entry.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Entry: `projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::GetEntryRequest const &, Options)

Gets a single entry.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.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::dataplex::v1::LookupEntryRequest const &, Options)

Looks up a single entry.

Parameters
Name	Description
`request`	`google::cloud::dataplex::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.dataplex.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::dataplex::v1::Entry >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.Entry) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

Searches for entries matching given query and scope.

Parameters
Name	Description
`name`	`std::string const &` Required. The project to which the request should be attributed in the following form: `projects/{project}/locations/{location}`.
`query`	`std::string const &` Required. The query against which entries in scope should be matched.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::SearchEntriesResult >

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.dataplex.v1.SearchEntriesResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchEntries(google::cloud::dataplex::v1::SearchEntriesRequest, Options)

Searches for entries matching given query and scope.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::SearchEntriesRequest` 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.dataplex.v1.SearchEntriesRequest. 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::dataplex::v1::SearchEntriesResult >

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.dataplex.v1.SearchEntriesResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.