Class DataTaxonomyServiceClient (2.32.0)

DataTaxonomyService enables attribute-based governance.

The resources currently offered include DataTaxonomy and DataAttribute.

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

DataTaxonomyServiceClient(DataTaxonomyServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataTaxonomyServiceClient const &`

DataTaxonomyServiceClient(DataTaxonomyServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataTaxonomyServiceClient &&`

DataTaxonomyServiceClient(std::shared_ptr< DataTaxonomyServiceConnection >, Options)

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

Operators

operator=(DataTaxonomyServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataTaxonomyServiceClient const &`

Returns
Type	Description
`DataTaxonomyServiceClient &`

operator=(DataTaxonomyServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataTaxonomyServiceClient &&`

Returns
Type	Description
`DataTaxonomyServiceClient &`

Functions

CreateDataTaxonomy(std::string const &, google::cloud::dataplex::v1::DataTaxonomy const &, std::string const &, Options)

Create a DataTaxonomy resource.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the data taxonomy location, of the form: projects/{project_number}/locations/{location_id} where `location_id` refers to a GCP region.
`data_taxonomy`	`google::cloud::dataplex::v1::DataTaxonomy const &` Required. DataTaxonomy resource.
`data_taxonomy_id`	`std::string const &` Required. DataTaxonomy identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the Project.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

CreateDataTaxonomy(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::DataTaxonomy const &, std::string const &, Options)

Create a DataTaxonomy resource.

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 &`
`data_taxonomy`	`google::cloud::dataplex::v1::DataTaxonomy const &`
`data_taxonomy_id`	`std::string const &`
`opts`	`Options`

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

CreateDataTaxonomy(google::cloud::dataplex::v1::CreateDataTaxonomyRequest const &, Options)

Create a DataTaxonomy resource.

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

CreateDataTaxonomy(NoAwaitTag, google::cloud::dataplex::v1::CreateDataTaxonomyRequest const &, Options)

Create a DataTaxonomy resource.

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::CreateDataTaxonomyRequest const &`
`opts`	`Options`

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

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

Create a DataTaxonomy resource.

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::DataTaxonomy > >`

UpdateDataTaxonomy(google::cloud::dataplex::v1::DataTaxonomy const &, google::protobuf::FieldMask const &, Options)

Updates a DataTaxonomy resource.

Parameters
Name	Description
`data_taxonomy`	`google::cloud::dataplex::v1::DataTaxonomy const &` Required. Only fields specified in `update_mask` are updated.
`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::DataTaxonomy > >

UpdateDataTaxonomy(NoAwaitTag, google::cloud::dataplex::v1::DataTaxonomy const &, google::protobuf::FieldMask const &, Options)

Updates a DataTaxonomy resource.

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`
`data_taxonomy`	`google::cloud::dataplex::v1::DataTaxonomy const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

UpdateDataTaxonomy(google::cloud::dataplex::v1::UpdateDataTaxonomyRequest const &, Options)

Updates a DataTaxonomy resource.

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

UpdateDataTaxonomy(NoAwaitTag, google::cloud::dataplex::v1::UpdateDataTaxonomyRequest const &, Options)

Updates a DataTaxonomy resource.

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::UpdateDataTaxonomyRequest const &`
`opts`	`Options`

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

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

Updates a DataTaxonomy resource.

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::DataTaxonomy > >`

DeleteDataTaxonomy(std::string const &, Options)

Deletes a DataTaxonomy resource.

All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_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.

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

Deletes a DataTaxonomy resource.

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

DeleteDataTaxonomy(google::cloud::dataplex::v1::DeleteDataTaxonomyRequest const &, Options)

Deletes a DataTaxonomy resource.

All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

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

DeleteDataTaxonomy(NoAwaitTag, google::cloud::dataplex::v1::DeleteDataTaxonomyRequest const &, Options)

Deletes a DataTaxonomy resource.

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::DeleteDataTaxonomyRequest const &`
`opts`	`Options`

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

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

Deletes a DataTaxonomy resource.

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

ListDataTaxonomies(std::string const &, Options)

Lists DataTaxonomy resources in a project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the DataTaxonomy 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::DataTaxonomy >

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

ListDataTaxonomies(google::cloud::dataplex::v1::ListDataTaxonomiesRequest, Options)

Lists DataTaxonomy resources in a project and location.

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

GetDataTaxonomy(std::string const &, Options)

Retrieves a DataTaxonomy resource.

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

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

GetDataTaxonomy(google::cloud::dataplex::v1::GetDataTaxonomyRequest const &, Options)

Retrieves a DataTaxonomy resource.

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

CreateDataAttributeBinding(std::string const &, google::cloud::dataplex::v1::DataAttributeBinding const &, std::string const &, Options)

Create a DataAttributeBinding resource.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}
`data_attribute_binding`	`google::cloud::dataplex::v1::DataAttributeBinding const &` Required. DataAttributeBinding resource.
`data_attribute_binding_id`	`std::string const &` Required. DataAttributeBinding identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the Location.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

CreateDataAttributeBinding(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::DataAttributeBinding const &, std::string const &, Options)

Create a DataAttributeBinding resource.

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 &`
`data_attribute_binding`	`google::cloud::dataplex::v1::DataAttributeBinding const &`
`data_attribute_binding_id`	`std::string const &`
`opts`	`Options`

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

CreateDataAttributeBinding(google::cloud::dataplex::v1::CreateDataAttributeBindingRequest const &, Options)

Create a DataAttributeBinding resource.

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

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

CreateDataAttributeBinding(NoAwaitTag, google::cloud::dataplex::v1::CreateDataAttributeBindingRequest const &, Options)

Create a DataAttributeBinding resource.

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::CreateDataAttributeBindingRequest const &`
`opts`	`Options`

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

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

Create a DataAttributeBinding resource.

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::DataAttributeBinding > >`

UpdateDataAttributeBinding(google::cloud::dataplex::v1::DataAttributeBinding const &, google::protobuf::FieldMask const &, Options)

Updates a DataAttributeBinding resource.

Parameters
Name	Description
`data_attribute_binding`	`google::cloud::dataplex::v1::DataAttributeBinding const &` Required. Only fields specified in `update_mask` are updated.
`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::DataAttributeBinding > >

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

UpdateDataAttributeBinding(NoAwaitTag, google::cloud::dataplex::v1::DataAttributeBinding const &, google::protobuf::FieldMask const &, Options)

Updates a DataAttributeBinding resource.

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`
`data_attribute_binding`	`google::cloud::dataplex::v1::DataAttributeBinding const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

UpdateDataAttributeBinding(google::cloud::dataplex::v1::UpdateDataAttributeBindingRequest const &, Options)

Updates a DataAttributeBinding resource.

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

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

UpdateDataAttributeBinding(NoAwaitTag, google::cloud::dataplex::v1::UpdateDataAttributeBindingRequest const &, Options)

Updates a DataAttributeBinding resource.

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::UpdateDataAttributeBindingRequest const &`
`opts`	`Options`

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

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

Updates a DataAttributeBinding resource.

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::DataAttributeBinding > >`

DeleteDataAttributeBinding(std::string const &, Options)

Deletes a DataAttributeBinding resource.

All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_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.

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

Deletes a DataAttributeBinding resource.

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

DeleteDataAttributeBinding(google::cloud::dataplex::v1::DeleteDataAttributeBindingRequest const &, Options)

Deletes a DataAttributeBinding resource.

All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

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

DeleteDataAttributeBinding(NoAwaitTag, google::cloud::dataplex::v1::DeleteDataAttributeBindingRequest const &, Options)

Deletes a DataAttributeBinding resource.

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::DeleteDataAttributeBindingRequest const &`
`opts`	`Options`

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

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

Deletes a DataAttributeBinding resource.

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

ListDataAttributeBindings(std::string const &, Options)

Lists DataAttributeBinding resources in a project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the Location: projects/{project_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::DataAttributeBinding >

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

ListDataAttributeBindings(google::cloud::dataplex::v1::ListDataAttributeBindingsRequest, Options)

Lists DataAttributeBinding resources in a project and location.

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

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

GetDataAttributeBinding(std::string const &, Options)

Retrieves a DataAttributeBinding resource.

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

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

GetDataAttributeBinding(google::cloud::dataplex::v1::GetDataAttributeBindingRequest const &, Options)

Retrieves a DataAttributeBinding resource.

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

CreateDataAttribute(std::string const &, google::cloud::dataplex::v1::DataAttribute const &, std::string const &, Options)

Create a DataAttribute resource.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}
`data_attribute`	`google::cloud::dataplex::v1::DataAttribute const &` Required. DataAttribute resource.
`data_attribute_id`	`std::string const &` Required. DataAttribute identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must be between 1-63 characters. Must end with a number or a letter. Must be unique within the DataTaxonomy.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

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

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

CreateDataAttribute(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::DataAttribute const &, std::string const &, Options)

Create a DataAttribute resource.

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 &`
`data_attribute`	`google::cloud::dataplex::v1::DataAttribute const &`
`data_attribute_id`	`std::string const &`
`opts`	`Options`

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

CreateDataAttribute(google::cloud::dataplex::v1::CreateDataAttributeRequest const &, Options)

Create a DataAttribute resource.

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

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

CreateDataAttribute(NoAwaitTag, google::cloud::dataplex::v1::CreateDataAttributeRequest const &, Options)

Create a DataAttribute resource.

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::CreateDataAttributeRequest const &`
`opts`	`Options`

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

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

Create a DataAttribute resource.

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::DataAttribute > >`

UpdateDataAttribute(google::cloud::dataplex::v1::DataAttribute const &, google::protobuf::FieldMask const &, Options)

Updates a DataAttribute resource.

Parameters
Name	Description
`data_attribute`	`google::cloud::dataplex::v1::DataAttribute const &` Required. Only fields specified in `update_mask` are updated.
`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::DataAttribute > >

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

UpdateDataAttribute(NoAwaitTag, google::cloud::dataplex::v1::DataAttribute const &, google::protobuf::FieldMask const &, Options)

Updates a DataAttribute resource.

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`
`data_attribute`	`google::cloud::dataplex::v1::DataAttribute const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

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

UpdateDataAttribute(google::cloud::dataplex::v1::UpdateDataAttributeRequest const &, Options)

Updates a DataAttribute resource.

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

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

UpdateDataAttribute(NoAwaitTag, google::cloud::dataplex::v1::UpdateDataAttributeRequest const &, Options)

Updates a DataAttribute resource.

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::UpdateDataAttributeRequest const &`
`opts`	`Options`

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

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

Updates a DataAttribute resource.

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::DataAttribute > >`

DeleteDataAttribute(std::string const &, Options)

Deletes a Data Attribute resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_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.

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

Deletes a Data Attribute resource.

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

DeleteDataAttribute(google::cloud::dataplex::v1::DeleteDataAttributeRequest const &, Options)

Deletes a Data Attribute resource.

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

DeleteDataAttribute(NoAwaitTag, google::cloud::dataplex::v1::DeleteDataAttributeRequest const &, Options)

Deletes a Data Attribute resource.

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::DeleteDataAttributeRequest const &`
`opts`	`Options`

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

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

Deletes a Data Attribute resource.

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

ListDataAttributes(std::string const &, Options)

Lists Data Attribute resources in a DataTaxonomy.

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

Returns

Type Description

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

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

ListDataAttributes(google::cloud::dataplex::v1::ListDataAttributesRequest, Options)

Lists Data Attribute resources in a DataTaxonomy.

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

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

GetDataAttribute(std::string const &, Options)

Retrieves a Data Attribute resource.

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

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

GetDataAttribute(google::cloud::dataplex::v1::GetDataAttributeRequest const &, Options)

Retrieves a Data Attribute resource.

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

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.