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 |
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.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetLake(std::string const &, Options)
Retrieves a lake resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the lake: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetZone(std::string const &, Options)
Retrieves a zone resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the zone: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetAsset(std::string const &, Options)
Retrieves an asset resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the asset: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetTask(std::string const &, Options)
Get task resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the task: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetJob(std::string const &, Options)
Get job resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the job: |
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 |
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 |
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 |
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: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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: |
environment |
google::cloud::dataplex::v1::Environment const &
Required. Environment resource. |
environment_id |
std::string const &
Required. Environment identifier.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
GetEnvironment(std::string const &, Options)
Get environment resource.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the environment: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |