Class DataplexServiceClient (2.31.0-rc)

Version latest

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

Dataplex service provides data lakes as a service.

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

Equality

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

Performance

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

Thread Safety

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

Constructors

DataplexServiceClient(DataplexServiceClient const &)

Copy and move support

Parameter
Name	Description
	DataplexServiceClient const &

DataplexServiceClient(DataplexServiceClient &&)

Copy and move support

Parameter
Name	Description
	DataplexServiceClient &&

DataplexServiceClient(std::shared_ptr< DataplexServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< DataplexServiceConnection >
opts	Options

Operators

operator=(DataplexServiceClient const &)

Copy and move support

Parameter
Name	Description
	DataplexServiceClient const &

Returns
Type	Description
DataplexServiceClient &

operator=(DataplexServiceClient &&)

Copy and move support

Parameter
Name	Description
	DataplexServiceClient &&

Returns
Type	Description
DataplexServiceClient &

Functions

CreateLake(std::string const &, google::cloud::dataplex::v1::Lake const &, std::string const &, Options)

Creates a lake resource.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the lake location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.
lake	google::cloud::dataplex::v1::Lake const & Required. Lake resource
lake_id	std::string const & Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataplex::v1::Lake > >	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.Lake proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateLake(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::Lake const &, std::string const &, Options)

Creates a lake 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 &
lake	google::cloud::dataplex::v1::Lake const &
lake_id	std::string const &
opts	Options

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

CreateLake(google::cloud::dataplex::v1::CreateLakeRequest const &, Options)

Creates a lake resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::CreateLakeRequest 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.CreateLakeRequest. 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::Lake > >	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.Lake proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateLake(NoAwaitTag, google::cloud::dataplex::v1::CreateLakeRequest const &, Options)

Creates a lake 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::CreateLakeRequest const &
opts	Options

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

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

Creates a lake 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::Lake > >

UpdateLake(google::cloud::dataplex::v1::Lake const &, google::protobuf::FieldMask const &, Options)

Updates a lake resource.

Parameters
Name	Description
lake	google::cloud::dataplex::v1::Lake const & Required. Update description. 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::Lake > >	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.Lake proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateLake(NoAwaitTag, google::cloud::dataplex::v1::Lake const &, google::protobuf::FieldMask const &, Options)

Updates a lake 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
lake	google::cloud::dataplex::v1::Lake const &
update_mask	google::protobuf::FieldMask const &
opts	Options

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

UpdateLake(google::cloud::dataplex::v1::UpdateLakeRequest const &, Options)

Updates a lake resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::UpdateLakeRequest 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.UpdateLakeRequest. 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::Lake > >	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.Lake proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateLake(NoAwaitTag, google::cloud::dataplex::v1::UpdateLakeRequest const &, Options)

Updates a lake 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::UpdateLakeRequest const &
opts	Options

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

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

Updates a lake 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::Lake > >

DeleteLake(std::string const &, Options)

Deletes a lake resource.

All zones within the lake must be deleted before the lake can be deleted.

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

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

Deletes a lake 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 >

DeleteLake(google::cloud::dataplex::v1::DeleteLakeRequest const &, Options)

Deletes a lake resource.

All zones within the lake must be deleted before the lake can be deleted.

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

DeleteLake(NoAwaitTag, google::cloud::dataplex::v1::DeleteLakeRequest const &, Options)

Deletes a lake 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::DeleteLakeRequest const &
opts	Options

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

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

Deletes a lake 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 > >

ListLakes(std::string const &, Options)

Lists lake resources in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the lake 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::Lake >	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.Lake, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListLakes(google::cloud::dataplex::v1::ListLakesRequest, Options)

Lists lake resources in a project and location.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListLakesRequest 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.ListLakesRequest. 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::Lake >	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.Lake, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLake(std::string const &, Options)

Retrieves a lake resource.

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

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

GetLake(google::cloud::dataplex::v1::GetLakeRequest const &, Options)

Retrieves a lake resource.

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

ListLakeActions(std::string const &, Options)

Lists action resources in a lake.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListLakeActions(google::cloud::dataplex::v1::ListLakeActionsRequest, Options)

Lists action resources in a lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListLakeActionsRequest 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.ListLakeActionsRequest. 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::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateZone(std::string const &, google::cloud::dataplex::v1::Zone const &, std::string const &, Options)

Creates a zone resource within a lake.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
zone	google::cloud::dataplex::v1::Zone const & Required. Zone resource.
zone_id	std::string const & Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique across all lakes from all locations in a project. Must not be one of the reserved IDs (i.e. "default", "global-temp")
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataplex::v1::Zone > >	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.Zone proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateZone(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::Zone const &, std::string const &, Options)

Creates a zone resource within a lake.

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 &
zone	google::cloud::dataplex::v1::Zone const &
zone_id	std::string const &
opts	Options

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

CreateZone(google::cloud::dataplex::v1::CreateZoneRequest const &, Options)

Creates a zone resource within a lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::CreateZoneRequest 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.CreateZoneRequest. 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::Zone > >	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.Zone proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateZone(NoAwaitTag, google::cloud::dataplex::v1::CreateZoneRequest const &, Options)

Creates a zone resource within a lake.

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

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

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

Creates a zone resource within a lake.

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

UpdateZone(google::cloud::dataplex::v1::Zone const &, google::protobuf::FieldMask const &, Options)

Updates a zone resource.

Parameters
Name	Description
zone	google::cloud::dataplex::v1::Zone const & Required. Update description. 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::Zone > >	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.Zone proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateZone(NoAwaitTag, google::cloud::dataplex::v1::Zone const &, google::protobuf::FieldMask const &, Options)

Updates a zone 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
zone	google::cloud::dataplex::v1::Zone const &
update_mask	google::protobuf::FieldMask const &
opts	Options

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

UpdateZone(google::cloud::dataplex::v1::UpdateZoneRequest const &, Options)

Updates a zone resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::UpdateZoneRequest 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.UpdateZoneRequest. 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::Zone > >	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.Zone proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateZone(NoAwaitTag, google::cloud::dataplex::v1::UpdateZoneRequest const &, Options)

Updates a zone 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::UpdateZoneRequest const &
opts	Options

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

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

Updates a zone 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::Zone > >

DeleteZone(std::string const &, Options)

Deletes a zone resource.

All assets within a zone must be deleted before the zone can be deleted.

Parameters
Name	Description
name	std::string const & Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_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.

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

Deletes a zone 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 >

DeleteZone(google::cloud::dataplex::v1::DeleteZoneRequest const &, Options)

Deletes a zone resource.

All assets within a zone must be deleted before the zone can be deleted.

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

DeleteZone(NoAwaitTag, google::cloud::dataplex::v1::DeleteZoneRequest const &, Options)

Deletes a zone 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::DeleteZoneRequest const &
opts	Options

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

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

Deletes a zone 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 > >

ListZones(std::string const &, Options)

Lists zone resources in a lake.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Zone >	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.Zone, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListZones(google::cloud::dataplex::v1::ListZonesRequest, Options)

Lists zone resources in a lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListZonesRequest 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.ListZonesRequest. 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::Zone >	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.Zone, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetZone(std::string const &, Options)

Retrieves a zone resource.

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

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

GetZone(google::cloud::dataplex::v1::GetZoneRequest const &, Options)

Retrieves a zone resource.

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

ListZoneActions(std::string const &, Options)

Lists action resources in a zone.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListZoneActions(google::cloud::dataplex::v1::ListZoneActionsRequest, Options)

Lists action resources in a zone.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListZoneActionsRequest 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.ListZoneActionsRequest. 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::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateAsset(std::string const &, google::cloud::dataplex::v1::Asset const &, std::string const &, Options)

Creates an asset resource.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
asset	google::cloud::dataplex::v1::Asset const & Required. Asset resource.
asset_id	std::string const & Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the zone.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataplex::v1::Asset > >	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.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAsset(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::Asset const &, std::string const &, Options)

Creates an asset 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 &
asset	google::cloud::dataplex::v1::Asset const &
asset_id	std::string const &
opts	Options

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

CreateAsset(google::cloud::dataplex::v1::CreateAssetRequest const &, Options)

Creates an asset resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::CreateAssetRequest 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.CreateAssetRequest. 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::Asset > >	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.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAsset(NoAwaitTag, google::cloud::dataplex::v1::CreateAssetRequest const &, Options)

Creates an asset 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::CreateAssetRequest const &
opts	Options

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

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

Creates an asset 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::Asset > >

UpdateAsset(google::cloud::dataplex::v1::Asset const &, google::protobuf::FieldMask const &, Options)

Updates an asset resource.

Parameters
Name	Description
asset	google::cloud::dataplex::v1::Asset const & Required. Update description. 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::Asset > >	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.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAsset(NoAwaitTag, google::cloud::dataplex::v1::Asset const &, google::protobuf::FieldMask const &, Options)

Updates an asset 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
asset	google::cloud::dataplex::v1::Asset const &
update_mask	google::protobuf::FieldMask const &
opts	Options

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

UpdateAsset(google::cloud::dataplex::v1::UpdateAssetRequest const &, Options)

Updates an asset resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::UpdateAssetRequest 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.UpdateAssetRequest. 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::Asset > >	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.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAsset(NoAwaitTag, google::cloud::dataplex::v1::UpdateAssetRequest const &, Options)

Updates an asset 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::UpdateAssetRequest const &
opts	Options

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

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

Updates an asset 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::Asset > >

DeleteAsset(std::string const &, Options)

Deletes an asset resource.

The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

Parameters
Name	Description
name	std::string const & Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_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.

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

Deletes an asset 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 >

DeleteAsset(google::cloud::dataplex::v1::DeleteAssetRequest const &, Options)

Deletes an asset resource.

The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.

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

DeleteAsset(NoAwaitTag, google::cloud::dataplex::v1::DeleteAssetRequest const &, Options)

Deletes an asset 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::DeleteAssetRequest const &
opts	Options

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

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

Deletes an asset 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 > >

ListAssets(std::string const &, Options)

Lists asset resources in a zone.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Asset >	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.Asset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAssets(google::cloud::dataplex::v1::ListAssetsRequest, Options)

Lists asset resources in a zone.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListAssetsRequest 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.ListAssetsRequest. 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::Asset >	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.Asset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAsset(std::string const &, Options)

Retrieves an asset resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetAsset(google::cloud::dataplex::v1::GetAssetRequest const &, Options)

Retrieves an asset resource.

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

ListAssetActions(std::string const &, Options)

Lists action resources in an asset.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAssetActions(google::cloud::dataplex::v1::ListAssetActionsRequest, Options)

Lists action resources in an asset.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListAssetActionsRequest 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.ListAssetActionsRequest. 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::Action >	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.Action, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateTask(std::string const &, google::cloud::dataplex::v1::Task const &, std::string const &, Options)

Creates a task resource within a lake.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.
task	google::cloud::dataplex::v1::Task const & Required. Task resource.
task_id	std::string const & Required. Task identifier.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataplex::v1::Task > >	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.Task proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTask(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::Task const &, std::string const &, Options)

Creates a task resource within a lake.

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 &
task	google::cloud::dataplex::v1::Task const &
task_id	std::string const &
opts	Options

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

CreateTask(google::cloud::dataplex::v1::CreateTaskRequest const &, Options)

Creates a task resource within a lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::CreateTaskRequest 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.CreateTaskRequest. 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::Task > >	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.Task proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateTask(NoAwaitTag, google::cloud::dataplex::v1::CreateTaskRequest const &, Options)

Creates a task resource within a lake.

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

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

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

Creates a task resource within a lake.

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

UpdateTask(google::cloud::dataplex::v1::Task const &, google::protobuf::FieldMask const &, Options)

Update the task resource.

Parameters
Name	Description
task	google::cloud::dataplex::v1::Task const & Required. Update description. 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::Task > >	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.Task proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTask(NoAwaitTag, google::cloud::dataplex::v1::Task const &, google::protobuf::FieldMask const &, Options)

Update the task 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
task	google::cloud::dataplex::v1::Task const &
update_mask	google::protobuf::FieldMask const &
opts	Options

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

UpdateTask(google::cloud::dataplex::v1::UpdateTaskRequest const &, Options)

Update the task resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::UpdateTaskRequest 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.UpdateTaskRequest. 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::Task > >	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.Task proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateTask(NoAwaitTag, google::cloud::dataplex::v1::UpdateTaskRequest const &, Options)

Update the task 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::UpdateTaskRequest const &
opts	Options

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

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

Update the task 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::Task > >

DeleteTask(std::string const &, Options)

Delete the task resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_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.

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

Delete the task 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 >

DeleteTask(google::cloud::dataplex::v1::DeleteTaskRequest const &, Options)

Delete the task resource.

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

DeleteTask(NoAwaitTag, google::cloud::dataplex::v1::DeleteTaskRequest const &, Options)

Delete the task 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::DeleteTaskRequest const &
opts	Options

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

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

Delete the task 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 > >

ListTasks(std::string const &, Options)

Lists tasks under the given lake.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Task >	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.Task, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTasks(google::cloud::dataplex::v1::ListTasksRequest, Options)

Lists tasks under the given lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListTasksRequest 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.ListTasksRequest. 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::Task >	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.Task, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetTask(std::string const &, Options)

Get task resource.

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

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

GetTask(google::cloud::dataplex::v1::GetTaskRequest const &, Options)

Get task resource.

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

ListJobs(std::string const &, Options)

Lists Jobs under the given task.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Job >	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.Job, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListJobs(google::cloud::dataplex::v1::ListJobsRequest, Options)

Lists Jobs under the given task.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListJobsRequest 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.ListJobsRequest. 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::Job >	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.Job, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RunTask(std::string const &, Options)

Run an on demand execution of a Task.

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

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

RunTask(google::cloud::dataplex::v1::RunTaskRequest const &, Options)

Run an on demand execution of a Task.

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

GetJob(std::string const &, Options)

Get job resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetJob(google::cloud::dataplex::v1::GetJobRequest const &, Options)

Get job resource.

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

CancelJob(std::string const &, Options)

Cancel jobs running for the task resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{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.

CancelJob(google::cloud::dataplex::v1::CancelJobRequest const &, Options)

Cancel jobs running for the task resource.

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

CreateEnvironment(std::string const &, google::cloud::dataplex::v1::Environment const &, std::string const &, Options)

Create an environment resource.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.
environment	google::cloud::dataplex::v1::Environment const & Required. Environment resource.
environment_id	std::string const & Required. Environment 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 lake.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::dataplex::v1::Environment > >	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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEnvironment(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::Environment const &, std::string const &, Options)

Create an environment 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 &
environment	google::cloud::dataplex::v1::Environment const &
environment_id	std::string const &
opts	Options

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

CreateEnvironment(google::cloud::dataplex::v1::CreateEnvironmentRequest const &, Options)

Create an environment resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::CreateEnvironmentRequest 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.CreateEnvironmentRequest. 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::Environment > >	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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEnvironment(NoAwaitTag, google::cloud::dataplex::v1::CreateEnvironmentRequest const &, Options)

Create an environment 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::CreateEnvironmentRequest const &
opts	Options

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

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

Create an environment 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::Environment > >

UpdateEnvironment(google::cloud::dataplex::v1::Environment const &, google::protobuf::FieldMask const &, Options)

Update the environment resource.

Parameters
Name	Description
environment	google::cloud::dataplex::v1::Environment const & Required. Update description. 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::Environment > >	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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEnvironment(NoAwaitTag, google::cloud::dataplex::v1::Environment const &, google::protobuf::FieldMask const &, Options)

Update the environment 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
environment	google::cloud::dataplex::v1::Environment const &
update_mask	google::protobuf::FieldMask const &
opts	Options

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

UpdateEnvironment(google::cloud::dataplex::v1::UpdateEnvironmentRequest const &, Options)

Update the environment resource.

Parameters
Name	Description
request	google::cloud::dataplex::v1::UpdateEnvironmentRequest 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.UpdateEnvironmentRequest. 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::Environment > >	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.Environment proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateEnvironment(NoAwaitTag, google::cloud::dataplex::v1::UpdateEnvironmentRequest const &, Options)

Update the environment 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::UpdateEnvironmentRequest const &
opts	Options

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

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

Update the environment 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::Environment > >

DeleteEnvironment(std::string const &, Options)

Delete the environment resource.

All the child resources must have been deleted before environment deletion can be initiated.

Parameters
Name	Description
name	std::string const & Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_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.

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

Delete the environment 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 >

DeleteEnvironment(google::cloud::dataplex::v1::DeleteEnvironmentRequest const &, Options)

Delete the environment resource.

All the child resources must have been deleted before environment deletion can be initiated.

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

DeleteEnvironment(NoAwaitTag, google::cloud::dataplex::v1::DeleteEnvironmentRequest const &, Options)

Delete the environment 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::DeleteEnvironmentRequest const &
opts	Options

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

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

Delete the environment 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 > >

ListEnvironments(std::string const &, Options)

Lists environments under the given lake.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Environment >	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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEnvironments(google::cloud::dataplex::v1::ListEnvironmentsRequest, Options)

Lists environments under the given lake.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListEnvironmentsRequest 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.ListEnvironmentsRequest. 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::Environment >	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.Environment, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEnvironment(std::string const &, Options)

Get environment resource.

Parameters
Name	Description
name	std::string const & Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetEnvironment(google::cloud::dataplex::v1::GetEnvironmentRequest const &, Options)

Get environment resource.

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

ListSessions(std::string const &, Options)

Lists session resources in an environment.

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

Returns
Type	Description
StreamRange< google::cloud::dataplex::v1::Session >	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.Session, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSessions(google::cloud::dataplex::v1::ListSessionsRequest, Options)

Lists session resources in an environment.

Parameters
Name	Description
request	google::cloud::dataplex::v1::ListSessionsRequest 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.ListSessionsRequest. 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::Session >	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.Session, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

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.

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

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