Class DataTransferServiceClient (2.47.0-rc)

DataTransferService is the service for the Data Transfer API.

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

DataTransferServiceClient(DataTransferServiceClient const &)

Copy and move support

Parameter
Name Description
DataTransferServiceClient const &

DataTransferServiceClient(DataTransferServiceClient &&)

Copy and move support

Parameter
Name Description
DataTransferServiceClient &&

DataTransferServiceClient(std::shared_ptr< DataTransferServiceConnection >, Options)

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

Operators

operator=(DataTransferServiceClient const &)

Copy and move support

Parameter
Name Description
DataTransferServiceClient const &
Returns
Type Description
DataTransferServiceClient &

operator=(DataTransferServiceClient &&)

Copy and move support

Parameter
Name Description
DataTransferServiceClient &&
Returns
Type Description
DataTransferServiceClient &

Functions

ListMulticloudDataTransferConfigs(std::string const &, Options)

Lists the MulticloudDataTransferConfig resources in a specified project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig >

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

ListMulticloudDataTransferConfigs(google::cloud::networkconnectivity::v1::ListMulticloudDataTransferConfigsRequest, Options)

Lists the MulticloudDataTransferConfig resources in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::ListMulticloudDataTransferConfigsRequest

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.networkconnectivity.v1.ListMulticloudDataTransferConfigsRequest. 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::networkconnectivity::v1::MulticloudDataTransferConfig >

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

GetMulticloudDataTransferConfig(std::string const &, Options)

Gets the details of a MulticloudDataTransferConfig resource.

Parameters
Name Description
name std::string const &

Required. The name of the MulticloudDataTransferConfig resource to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig >

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

GetMulticloudDataTransferConfig(google::cloud::networkconnectivity::v1::GetMulticloudDataTransferConfigRequest const &, Options)

Gets the details of a MulticloudDataTransferConfig resource.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::GetMulticloudDataTransferConfigRequest 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.networkconnectivity.v1.GetMulticloudDataTransferConfigRequest. 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::networkconnectivity::v1::MulticloudDataTransferConfig >

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

CreateMulticloudDataTransferConfig(std::string const &, google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &, std::string const &, Options)

Creates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource.

multicloud_data_transfer_config google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &

Required. The MulticloudDataTransferConfig resource to create.

multicloud_data_transfer_config_id std::string const &

Required. The ID to use for the MulticloudDataTransferConfig resource, which becomes the final component of the MulticloudDataTransferConfig resource name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig > >

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

CreateMulticloudDataTransferConfig(NoAwaitTag, std::string const &, google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &, std::string const &, Options)

Creates a MulticloudDataTransferConfig resource in a 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 &
multicloud_data_transfer_config google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &
multicloud_data_transfer_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateMulticloudDataTransferConfig(google::cloud::networkconnectivity::v1::CreateMulticloudDataTransferConfigRequest const &, Options)

Creates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::CreateMulticloudDataTransferConfigRequest 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.networkconnectivity.v1.CreateMulticloudDataTransferConfigRequest. 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::networkconnectivity::v1::MulticloudDataTransferConfig > >

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

CreateMulticloudDataTransferConfig(NoAwaitTag, google::cloud::networkconnectivity::v1::CreateMulticloudDataTransferConfigRequest const &, Options)

Creates a MulticloudDataTransferConfig resource in a 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::networkconnectivity::v1::CreateMulticloudDataTransferConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a MulticloudDataTransferConfig resource in a 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::networkconnectivity::v1::MulticloudDataTransferConfig > >

UpdateMulticloudDataTransferConfig(google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &, google::protobuf::FieldMask const &, Options)

Updates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name Description
multicloud_data_transfer_config google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &

Required. The MulticloudDataTransferConfig resource to update.

update_mask google::protobuf::FieldMask const &

Optional. FieldMask is used to specify the fields in the MulticloudDataTransferConfig resource to be overwritten by the update. The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig > >

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

UpdateMulticloudDataTransferConfig(NoAwaitTag, google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &, google::protobuf::FieldMask const &, Options)

Updates a MulticloudDataTransferConfig resource in a 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
multicloud_data_transfer_config google::cloud::networkconnectivity::v1::MulticloudDataTransferConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateMulticloudDataTransferConfig(google::cloud::networkconnectivity::v1::UpdateMulticloudDataTransferConfigRequest const &, Options)

Updates a MulticloudDataTransferConfig resource in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::UpdateMulticloudDataTransferConfigRequest 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.networkconnectivity.v1.UpdateMulticloudDataTransferConfigRequest. 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::networkconnectivity::v1::MulticloudDataTransferConfig > >

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

UpdateMulticloudDataTransferConfig(NoAwaitTag, google::cloud::networkconnectivity::v1::UpdateMulticloudDataTransferConfigRequest const &, Options)

Updates a MulticloudDataTransferConfig resource in a 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::networkconnectivity::v1::UpdateMulticloudDataTransferConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates a MulticloudDataTransferConfig resource in a 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::networkconnectivity::v1::MulticloudDataTransferConfig > >

DeleteMulticloudDataTransferConfig(std::string const &, Options)

Deletes a MulticloudDataTransferConfig resource.

Parameters
Name Description
name std::string const &

Required. The name of the MulticloudDataTransferConfig resource to delete.

opts Options

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

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

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

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

DeleteMulticloudDataTransferConfig(google::cloud::networkconnectivity::v1::DeleteMulticloudDataTransferConfigRequest const &, Options)

Deletes a MulticloudDataTransferConfig resource.

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

DeleteMulticloudDataTransferConfig(NoAwaitTag, google::cloud::networkconnectivity::v1::DeleteMulticloudDataTransferConfigRequest const &, Options)

Deletes a MulticloudDataTransferConfig 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::networkconnectivity::v1::DeleteMulticloudDataTransferConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a MulticloudDataTransferConfig 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::networkconnectivity::v1::OperationMetadata > >

ListDestinations(std::string const &, Options)

Lists the Destination resources in a specified project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkconnectivity::v1::Destination >

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

ListDestinations(google::cloud::networkconnectivity::v1::ListDestinationsRequest, Options)

Lists the Destination resources in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::ListDestinationsRequest

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.networkconnectivity.v1.ListDestinationsRequest. 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::networkconnectivity::v1::Destination >

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

GetDestination(std::string const &, Options)

Gets the details of a Destination resource.

Parameters
Name Description
name std::string const &

Required. The name of the Destination resource to get.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkconnectivity::v1::Destination >

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

GetDestination(google::cloud::networkconnectivity::v1::GetDestinationRequest const &, Options)

Gets the details of a Destination resource.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::GetDestinationRequest 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.networkconnectivity.v1.GetDestinationRequest. 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::networkconnectivity::v1::Destination >

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

CreateDestination(std::string const &, google::cloud::networkconnectivity::v1::Destination const &, std::string const &, Options)

Creates a Destination resource in a specified project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource.

destination google::cloud::networkconnectivity::v1::Destination const &

Required. The Destination resource to create.

destination_id std::string const &

Required. The ID to use for the Destination resource, which becomes the final component of the Destination resource name.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkconnectivity::v1::Destination > >

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

CreateDestination(NoAwaitTag, std::string const &, google::cloud::networkconnectivity::v1::Destination const &, std::string const &, Options)

Creates a Destination resource in a 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 &
destination google::cloud::networkconnectivity::v1::Destination const &
destination_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDestination(google::cloud::networkconnectivity::v1::CreateDestinationRequest const &, Options)

Creates a Destination resource in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::CreateDestinationRequest 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.networkconnectivity.v1.CreateDestinationRequest. 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::networkconnectivity::v1::Destination > >

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

CreateDestination(NoAwaitTag, google::cloud::networkconnectivity::v1::CreateDestinationRequest const &, Options)

Creates a Destination resource in a 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::networkconnectivity::v1::CreateDestinationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a Destination resource in a 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::networkconnectivity::v1::Destination > >

UpdateDestination(google::cloud::networkconnectivity::v1::Destination const &, google::protobuf::FieldMask const &, Options)

Updates a Destination resource in a specified project and location.

Parameters
Name Description
destination google::cloud::networkconnectivity::v1::Destination const &

Required. The Destination resource to update.

update_mask google::protobuf::FieldMask const &

Optional. FieldMask is used to specify the fields to be overwritten in the Destination resource by the update. The fields specified in update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If you don't specify a mask, all fields are overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::networkconnectivity::v1::Destination > >

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

UpdateDestination(NoAwaitTag, google::cloud::networkconnectivity::v1::Destination const &, google::protobuf::FieldMask const &, Options)

Updates a Destination resource in a 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
destination google::cloud::networkconnectivity::v1::Destination const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDestination(google::cloud::networkconnectivity::v1::UpdateDestinationRequest const &, Options)

Updates a Destination resource in a specified project and location.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::UpdateDestinationRequest 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.networkconnectivity.v1.UpdateDestinationRequest. 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::networkconnectivity::v1::Destination > >

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

UpdateDestination(NoAwaitTag, google::cloud::networkconnectivity::v1::UpdateDestinationRequest const &, Options)

Updates a Destination resource in a 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::networkconnectivity::v1::UpdateDestinationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates a Destination resource in a 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::networkconnectivity::v1::Destination > >

DeleteDestination(std::string const &, Options)

Deletes a Destination resource.

Parameters
Name Description
name std::string const &

Required. The name of the Destination resource to delete.

opts Options

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

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

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

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

DeleteDestination(google::cloud::networkconnectivity::v1::DeleteDestinationRequest const &, Options)

Deletes a Destination resource.

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

DeleteDestination(NoAwaitTag, google::cloud::networkconnectivity::v1::DeleteDestinationRequest const &, Options)

Deletes a Destination 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::networkconnectivity::v1::DeleteDestinationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a Destination 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::networkconnectivity::v1::OperationMetadata > >

GetMulticloudDataTransferSupportedService(std::string const &, Options)

Gets the details of a service that is supported for Data Transfer Essentials.

Parameters
Name Description
name std::string const &

Required. The name of the service.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::networkconnectivity::v1::MulticloudDataTransferSupportedService >

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

GetMulticloudDataTransferSupportedService(google::cloud::networkconnectivity::v1::GetMulticloudDataTransferSupportedServiceRequest const &, Options)

Gets the details of a service that is supported for Data Transfer Essentials.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::GetMulticloudDataTransferSupportedServiceRequest 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.networkconnectivity.v1.GetMulticloudDataTransferSupportedServiceRequest. 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::networkconnectivity::v1::MulticloudDataTransferSupportedService >

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

ListMulticloudDataTransferSupportedServices(std::string const &, Options)

Lists the services in the project for a region that are supported for Data Transfer Essentials.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::networkconnectivity::v1::MulticloudDataTransferSupportedService >

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

ListMulticloudDataTransferSupportedServices(google::cloud::networkconnectivity::v1::ListMulticloudDataTransferSupportedServicesRequest, Options)

Lists the services in the project for a region that are supported for Data Transfer Essentials.

Parameters
Name Description
request google::cloud::networkconnectivity::v1::ListMulticloudDataTransferSupportedServicesRequest

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.networkconnectivity.v1.ListMulticloudDataTransferSupportedServicesRequest. 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::networkconnectivity::v1::MulticloudDataTransferSupportedService >

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.networkconnectivity.v1.MulticloudDataTransferSupportedService, 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.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Lists operations that match the specified filter in the request.

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

Parameters
Name Description
request google::longrunning::ListOperationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.ListOperationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

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

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

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

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

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

Gets the latest state of a long-running operation.

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

Parameters
Name Description
request google::longrunning::GetOperationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.longrunning.GetOperationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

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

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

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

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

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

Deletes a long-running operation.

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.