Class CatalogServiceClient (2.40.0-rc)

The primary resources offered by this service are EntryGroups, EntryTypes, AspectTypes, and Entries.

They collectively let data administrators organize, manage, secure, and catalog data located across cloud projects in their organization 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 Google Cloud 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(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::EntryType const &, std::string const &, Options)

Creates an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`entry_type`	`google::cloud::dataplex::v1::EntryType const &`
`entry_type_id`	`std::string const &`
`opts`	`Options`

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

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 > >

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

Creates an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::CreateEntryTypeRequest const &`
`opts`	`Options`

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

CreateEntryType(google::longrunning::Operation const &, Options)

Creates an EntryType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::EntryType > >`

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

Updates an EntryType.

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(NoAwaitTag, google::cloud::dataplex::v1::EntryType const &, google::protobuf::FieldMask const &, Options)

Updates an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`entry_type`	`google::cloud::dataplex::v1::EntryType const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

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

Updates an EntryType.

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 > >

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

Updates an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::UpdateEntryTypeRequest const &`
`opts`	`Options`

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

UpdateEntryType(google::longrunning::Operation const &, Options)

Updates an EntryType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::EntryType > >`

DeleteEntryType(std::string const &, Options)

Deletes an EntryType.

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(NoAwaitTag, std::string const &, Options)

Deletes an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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

Deletes an EntryType.

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.

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

Deletes an EntryType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::DeleteEntryTypeRequest const &`
`opts`	`Options`

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

DeleteEntryType(google::longrunning::Operation const &, Options)

Deletes an EntryType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >`

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 Google Cloud 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)

Gets an EntryType.

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)

Gets an EntryType.

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 Google Cloud 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(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::AspectType const &, std::string const &, Options)

Creates an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`aspect_type`	`google::cloud::dataplex::v1::AspectType const &`
`aspect_type_id`	`std::string const &`
`opts`	`Options`

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

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.

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

Creates an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::CreateAspectTypeRequest const &`
`opts`	`Options`

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

CreateAspectType(google::longrunning::Operation const &, Options)

Creates an AspectType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::AspectType > >`

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

Updates an AspectType.

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(NoAwaitTag, google::cloud::dataplex::v1::AspectType const &, google::protobuf::FieldMask const &, Options)

Updates an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`aspect_type`	`google::cloud::dataplex::v1::AspectType const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

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

Updates an AspectType.

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.

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

Updates an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::UpdateAspectTypeRequest const &`
`opts`	`Options`

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

UpdateAspectType(google::longrunning::Operation const &, Options)

Updates an AspectType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::AspectType > >`

DeleteAspectType(std::string const &, Options)

Deletes an AspectType.

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(NoAwaitTag, std::string const &, Options)

Deletes an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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

Deletes an AspectType.

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.

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

Deletes an AspectType.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::DeleteAspectTypeRequest const &`
`opts`	`Options`

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

DeleteAspectType(google::longrunning::Operation const &, Options)

Deletes an AspectType.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >`

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 Google Cloud 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)

Gets an AspectType.

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)

Gets an AspectType.

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(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::EntryGroup const &, std::string const &, Options)

Creates an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`entry_group`	`google::cloud::dataplex::v1::EntryGroup const &`
`entry_group_id`	`std::string const &`
`opts`	`Options`

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

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.

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

Creates an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::CreateEntryGroupRequest const &`
`opts`	`Options`

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

CreateEntryGroup(google::longrunning::Operation const &, Options)

Creates an EntryGroup.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >`

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

Updates an EntryGroup.

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(NoAwaitTag, google::cloud::dataplex::v1::EntryGroup const &, google::protobuf::FieldMask const &, Options)

Updates an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`entry_group`	`google::cloud::dataplex::v1::EntryGroup const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

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

Updates an EntryGroup.

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.

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

Updates an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::UpdateEntryGroupRequest const &`
`opts`	`Options`

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

UpdateEntryGroup(google::longrunning::Operation const &, Options)

Updates an EntryGroup.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::EntryGroup > >`

DeleteEntryGroup(std::string const &, Options)

Deletes an EntryGroup.

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(NoAwaitTag, std::string const &, Options)

Deletes an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

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

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

Deletes an EntryGroup.

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.

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

Deletes an EntryGroup.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::DeleteEntryGroupRequest const &`
`opts`	`Options`

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

DeleteEntryGroup(google::longrunning::Operation const &, Options)

Deletes an EntryGroup.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >`

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 Google Cloud 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)

Gets an EntryGroup.

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)

Gets an EntryGroup.

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 an Entry ID format based on full resource names. The format is a full resource name of the resource without the prefix double slashes in the API service name part of the 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 providers or systems other 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, the service will update all modifiable fields present in the request.
`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 EntryGroup.

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 EntryGroup.

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 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.

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

Gets an 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 an entry by name using the permission on the source system.

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 the 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. The query syntax is defined in Search syntax for Dataplex Catalog.
`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 the 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.

CreateMetadataJob(std::string const &, google::cloud::dataplex::v1::MetadataJob const &, std::string const &, Options)

Creates a metadata job.

For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent location, in the format `projects/{project_id_or_number}/locations/{location_id}`
`metadata_job`	`google::cloud::dataplex::v1::MetadataJob const &` Required. The metadata job resource.
`metadata_job_id`	`std::string const &` Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix `metadata-job-`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

CreateMetadataJob(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::MetadataJob const &, std::string const &, Options)

Creates a metadata job.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`metadata_job`	`google::cloud::dataplex::v1::MetadataJob const &`
`metadata_job_id`	`std::string const &`
`opts`	`Options`

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

CreateMetadataJob(google::cloud::dataplex::v1::CreateMetadataJobRequest const &, Options)

Creates a metadata job.

For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

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

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

CreateMetadataJob(NoAwaitTag, google::cloud::dataplex::v1::CreateMetadataJobRequest const &, Options)

Creates a metadata job.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::CreateMetadataJobRequest const &`
`opts`	`Options`

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

CreateMetadataJob(google::longrunning::Operation const &, Options)

Creates a metadata job.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::MetadataJob > >`

GetMetadataJob(std::string const &, Options)

Gets a metadata job.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the metadata job, in the format `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetMetadataJob(google::cloud::dataplex::v1::GetMetadataJobRequest const &, Options)

Gets a metadata job.

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

ListMetadataJobs(std::string const &, Options)

Lists metadata jobs.

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

Returns

Type Description

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

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

ListMetadataJobs(google::cloud::dataplex::v1::ListMetadataJobsRequest, Options)

Lists metadata jobs.

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

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

CancelMetadataJob(std::string const &, Options)

Cancels a metadata job.

If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the job, in the format `projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`
`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.

CancelMetadataJob(google::cloud::dataplex::v1::CancelMetadataJobRequest const &, Options)

Cancels a metadata job.

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

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

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

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

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

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

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

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(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

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)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

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.

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

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation's parent resource.
`filter`	`std::string const &` The standard list filter.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::longrunning::Operation >

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name	Description
`request`	`google::longrunning::ListOperationsRequest` 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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

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

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be deleted.
`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.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

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

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource to be cancelled.
`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.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

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

Class CatalogServiceClient (2.40.0-rc) Stay organized with collections Save and categorize content based on your preferences.

Equality

Performance

Thread Safety

Constructors

CatalogServiceClient(CatalogServiceClient const &)

CatalogServiceClient(CatalogServiceClient &&)

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

Operators

operator=(CatalogServiceClient const &)

operator=(CatalogServiceClient &&)

Functions

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

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

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

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

CreateEntryType(google::longrunning::Operation const &, Options)

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

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

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

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

UpdateEntryType(google::longrunning::Operation const &, Options)

DeleteEntryType(std::string const &, Options)

DeleteEntryType(NoAwaitTag, std::string const &, Options)

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

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

DeleteEntryType(google::longrunning::Operation const &, Options)

ListEntryTypes(std::string const &, Options)

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

GetEntryType(std::string const &, Options)

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

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

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

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

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

CreateAspectType(google::longrunning::Operation const &, Options)

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

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

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

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

UpdateAspectType(google::longrunning::Operation const &, Options)

DeleteAspectType(std::string const &, Options)

DeleteAspectType(NoAwaitTag, std::string const &, Options)

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

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

DeleteAspectType(google::longrunning::Operation const &, Options)

ListAspectTypes(std::string const &, Options)

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

GetAspectType(std::string const &, Options)

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

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

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

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

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

CreateEntryGroup(google::longrunning::Operation const &, Options)

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

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

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

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

UpdateEntryGroup(google::longrunning::Operation const &, Options)

DeleteEntryGroup(std::string const &, Options)

DeleteEntryGroup(NoAwaitTag, std::string const &, Options)

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

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

DeleteEntryGroup(google::longrunning::Operation const &, Options)

ListEntryGroups(std::string const &, Options)

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

GetEntryGroup(std::string const &, Options)

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

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

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

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

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

DeleteEntry(std::string const &, Options)

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

ListEntries(std::string const &, Options)

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

GetEntry(std::string const &, Options)

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

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

Class CatalogServiceClient (2.40.0-rc)