Class DataFusionClient (2.30.0)

Service for creating and managing Data Fusion instances.

Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

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

DataFusionClient(DataFusionClient const &)

Copy and move support

Parameter
Name Description
DataFusionClient const &

DataFusionClient(DataFusionClient &&)

Copy and move support

Parameter
Name Description
DataFusionClient &&

DataFusionClient(std::shared_ptr< DataFusionConnection >, Options)

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

Operators

operator=(DataFusionClient const &)

Copy and move support

Parameter
Name Description
DataFusionClient const &
Returns
Type Description
DataFusionClient &

operator=(DataFusionClient &&)

Copy and move support

Parameter
Name Description
DataFusionClient &&
Returns
Type Description
DataFusionClient &

Functions

ListAvailableVersions(std::string const &, Options)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
parent std::string const &

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datafusion::v1::Version >

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

ListAvailableVersions(google::cloud::datafusion::v1::ListAvailableVersionsRequest, Options)

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
Name Description
request google::cloud::datafusion::v1::ListAvailableVersionsRequest

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.datafusion.v1.ListAvailableVersionsRequest. 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::datafusion::v1::Version >

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

ListInstances(google::cloud::datafusion::v1::ListInstancesRequest, Options)

Lists Data Fusion instances in the specified project and location.

Parameters
Name Description
request google::cloud::datafusion::v1::ListInstancesRequest

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.datafusion.v1.ListInstancesRequest. 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::datafusion::v1::Instance >

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

GetInstance(google::cloud::datafusion::v1::GetInstanceRequest const &, Options)

Gets details of a single Data Fusion instance.

Parameters
Name Description
request google::cloud::datafusion::v1::GetInstanceRequest 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.datafusion.v1.GetInstanceRequest. 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::datafusion::v1::Instance >

the result of the RPC. The response message type (google.cloud.datafusion.v1.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateInstance(std::string const &, google::cloud::datafusion::v1::Instance const &, std::string const &, Options)

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
parent std::string const &

Required. The instance's project and location in the format projects/{project}/locations/{location}.

instance google::cloud::datafusion::v1::Instance const &

An instance resource.

instance_id std::string const &

Required. The name of the instance to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datafusion::v1::Instance > >

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

CreateInstance(NoAwaitTag, std::string const &, google::cloud::datafusion::v1::Instance const &, std::string const &, Options)

Creates a new Data Fusion instance in the specified project and location.

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 &
instance google::cloud::datafusion::v1::Instance const &
instance_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInstance(google::cloud::datafusion::v1::CreateInstanceRequest const &, Options)

Creates a new Data Fusion instance in the specified project and location.

Parameters
Name Description
request google::cloud::datafusion::v1::CreateInstanceRequest 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.datafusion.v1.CreateInstanceRequest. 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::datafusion::v1::Instance > >

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

CreateInstance(NoAwaitTag, google::cloud::datafusion::v1::CreateInstanceRequest const &, Options)

Creates a new Data Fusion instance in the specified project and location.

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::datafusion::v1::CreateInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Data Fusion instance in the specified project and location.

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::datafusion::v1::Instance > >

DeleteInstance(std::string const &, Options)

Deletes a single Date Fusion instance.

Parameters
Name Description
name std::string const &

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

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

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

Deletes a single Date Fusion instance.

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 >

DeleteInstance(google::cloud::datafusion::v1::DeleteInstanceRequest const &, Options)

Deletes a single Date Fusion instance.

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

DeleteInstance(NoAwaitTag, google::cloud::datafusion::v1::DeleteInstanceRequest const &, Options)

Deletes a single Date Fusion instance.

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::datafusion::v1::DeleteInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a single Date Fusion instance.

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::datafusion::v1::OperationMetadata > >

UpdateInstance(google::cloud::datafusion::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates a single Data Fusion instance.

Parameters
Name Description
instance google::cloud::datafusion::v1::Instance const &

Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datafusion::v1::Instance > >

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

UpdateInstance(NoAwaitTag, google::cloud::datafusion::v1::Instance const &, google::protobuf::FieldMask const &, Options)

Updates a single Data Fusion instance.

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
instance google::cloud::datafusion::v1::Instance const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateInstance(google::cloud::datafusion::v1::UpdateInstanceRequest const &, Options)

Updates a single Data Fusion instance.

Parameters
Name Description
request google::cloud::datafusion::v1::UpdateInstanceRequest 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.datafusion.v1.UpdateInstanceRequest. 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::datafusion::v1::Instance > >

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

UpdateInstance(NoAwaitTag, google::cloud::datafusion::v1::UpdateInstanceRequest const &, Options)

Updates a single Data Fusion instance.

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::datafusion::v1::UpdateInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates a single Data Fusion instance.

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::datafusion::v1::Instance > >

RestartInstance(google::cloud::datafusion::v1::RestartInstanceRequest const &, Options)

Restart a single Data Fusion instance.

At the end of an operation instance is fully restarted.

Parameters
Name Description
request google::cloud::datafusion::v1::RestartInstanceRequest 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.datafusion.v1.RestartInstanceRequest. 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::datafusion::v1::Instance > >

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

RestartInstance(NoAwaitTag, google::cloud::datafusion::v1::RestartInstanceRequest const &, Options)

Restart a single Data Fusion instance.

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::datafusion::v1::RestartInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Restart a single Data Fusion instance.

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::datafusion::v1::Instance > >