Class DatastreamClient (2.12.0)

Version 2.12.0

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

Datastream service.

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

DatastreamClient(DatastreamClient const &)

Copy and move support

Parameter
Name	Description
	DatastreamClient const &

DatastreamClient(DatastreamClient &&)

Copy and move support

Parameter
Name	Description
	DatastreamClient &&

DatastreamClient(std::shared_ptr< DatastreamConnection >, Options)

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

Operators

operator=(DatastreamClient const &)

Copy and move support

Parameter
Name	Description
	DatastreamClient const &

Returns
Type	Description
DatastreamClient &

operator=(DatastreamClient &&)

Copy and move support

Parameter
Name	Description
	DatastreamClient &&

Returns
Type	Description
DatastreamClient &

Functions

ListConnectionProfiles(std::string const &, Options)

Use this method to list connection profiles created in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of connection profiles.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListConnectionProfiles(google::cloud::datastream::v1::ListConnectionProfilesRequest, Options)

Use this method to list connection profiles created in a project and location.

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

GetConnectionProfile(std::string const &, Options)

Use this method to get details about a connection profile.

Parameters
Name	Description
name	std::string const & Required. The name of the connection profile resource to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetConnectionProfile(google::cloud::datastream::v1::GetConnectionProfileRequest const &, Options)

Use this method to get details about a connection profile.

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

CreateConnectionProfile(std::string const &, google::cloud::datastream::v1::ConnectionProfile const &, std::string const &, Options)

Use this method to create a connection profile in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of ConnectionProfiles.
connection_profile	google::cloud::datastream::v1::ConnectionProfile const & Required. The connection profile resource to create.
connection_profile_id	std::string const & Required. The connection profile identifier.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateConnectionProfile(google::cloud::datastream::v1::CreateConnectionProfileRequest const &, Options)

Use this method to create a connection profile in a project and location.

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

UpdateConnectionProfile(google::cloud::datastream::v1::ConnectionProfile const &, google::protobuf::FieldMask const &, Options)

Use this method to update the parameters of a connection profile.

Parameters
Name	Description
connection_profile	google::cloud::datastream::v1::ConnectionProfile const & Required. The connection profile to update.
update_mask	google::protobuf::FieldMask const & Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile resource by the update. 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 then all fields will be overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateConnectionProfile(google::cloud::datastream::v1::UpdateConnectionProfileRequest const &, Options)

Use this method to update the parameters of a connection profile.

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

DeleteConnectionProfile(std::string const &, Options)

Use this method to delete a connection profile.

Parameters
Name	Description
name	std::string const & Required. The name of the connection profile resource to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteConnectionProfile(google::cloud::datastream::v1::DeleteConnectionProfileRequest const &, Options)

Use this method to delete a connection profile.

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

DiscoverConnectionProfile(google::cloud::datastream::v1::DiscoverConnectionProfileRequest const &, Options)

Use this method to discover a connection profile.

The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.

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

ListStreams(std::string const &, Options)

Use this method to list streams in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of streams.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListStreams(google::cloud::datastream::v1::ListStreamsRequest, Options)

Use this method to list streams in a project and location.

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

GetStream(std::string const &, Options)

Use this method to get details about a stream.

Parameters
Name	Description
name	std::string const & Required. The name of the stream resource to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetStream(google::cloud::datastream::v1::GetStreamRequest const &, Options)

Use this method to get details about a stream.

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

CreateStream(std::string const &, google::cloud::datastream::v1::Stream const &, std::string const &, Options)

Use this method to create a stream.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of streams.
stream	google::cloud::datastream::v1::Stream const & Required. The stream resource to create.
stream_id	std::string const & Required. The stream identifier.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateStream(google::cloud::datastream::v1::CreateStreamRequest const &, Options)

Use this method to create a stream.

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

UpdateStream(google::cloud::datastream::v1::Stream const &, google::protobuf::FieldMask const &, Options)

Use this method to update the configuration of a stream.

Parameters
Name	Description
stream	google::cloud::datastream::v1::Stream const & Required. The stream resource to update.
update_mask	google::protobuf::FieldMask const & Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. 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 then all fields will be overwritten.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateStream(google::cloud::datastream::v1::UpdateStreamRequest const &, Options)

Use this method to update the configuration of a stream.

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

DeleteStream(std::string const &, Options)

Use this method to delete a stream.

Parameters
Name	Description
name	std::string const & Required. The name of the stream resource to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteStream(google::cloud::datastream::v1::DeleteStreamRequest const &, Options)

Use this method to delete a stream.

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

GetStreamObject(std::string const &, Options)

Use this method to get details about a stream object.

Parameters
Name	Description
name	std::string const & Required. The name of the stream object resource to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetStreamObject(google::cloud::datastream::v1::GetStreamObjectRequest const &, Options)

Use this method to get details about a stream object.

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

LookupStreamObject(google::cloud::datastream::v1::LookupStreamObjectRequest const &, Options)

Use this method to look up a stream object by its source object identifier.

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

ListStreamObjects(std::string const &, Options)

Use this method to list the objects of a specific stream.

Parameters
Name	Description
parent	std::string const & Required. The parent stream that owns the collection of objects.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListStreamObjects(google::cloud::datastream::v1::ListStreamObjectsRequest, Options)

Use this method to list the objects of a specific stream.

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

StartBackfillJob(std::string const &, Options)

Use this method to start a backfill job for the specified stream object.

Parameters
Name	Description
object	std::string const & Required. The name of the stream object resource to start a backfill job for.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

StartBackfillJob(google::cloud::datastream::v1::StartBackfillJobRequest const &, Options)

Use this method to start a backfill job for the specified stream object.

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

StopBackfillJob(std::string const &, Options)

Use this method to stop a backfill job for the specified stream object.

Parameters
Name	Description
object	std::string const & Required. The name of the stream object resource to stop the backfill job for.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

StopBackfillJob(google::cloud::datastream::v1::StopBackfillJobRequest const &, Options)

Use this method to stop a backfill job for the specified stream object.

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

FetchStaticIps(std::string const &, Options)

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

Parameters
Name	Description
name	std::string const & Required. The resource name for the location for which static IPs should be returned. Must be in the format projects/*/locations/*.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< std::string >	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 a std::string.

FetchStaticIps(google::cloud::datastream::v1::FetchStaticIpsRequest, Options)

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

Parameters
Name	Description
request	google::cloud::datastream::v1::FetchStaticIpsRequest 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.datastream.v1.FetchStaticIpsRequest. 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< std::string >	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 a std::string.

CreatePrivateConnection(std::string const &, google::cloud::datastream::v1::PrivateConnection const &, std::string const &, Options)

Use this method to create a private connectivity configuration.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of PrivateConnections.
private_connection	google::cloud::datastream::v1::PrivateConnection const & Required. The Private Connectivity resource to create.
private_connection_id	std::string const & Required. The private connectivity identifier.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreatePrivateConnection(google::cloud::datastream::v1::CreatePrivateConnectionRequest const &, Options)

Use this method to create a private connectivity configuration.

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

GetPrivateConnection(std::string const &, Options)

Use this method to get details about a private connectivity configuration.

Parameters
Name	Description
name	std::string const & Required. The name of the private connectivity configuration to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetPrivateConnection(google::cloud::datastream::v1::GetPrivateConnectionRequest const &, Options)

Use this method to get details about a private connectivity configuration.

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

ListPrivateConnections(std::string const &, Options)

Use this method to list private connectivity configurations in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of private connectivity configurations.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListPrivateConnections(google::cloud::datastream::v1::ListPrivateConnectionsRequest, Options)

Use this method to list private connectivity configurations in a project and location.

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

DeletePrivateConnection(std::string const &, Options)

Use this method to delete a private connectivity configuration.

Parameters
Name	Description
name	std::string const & Required. The name of the private connectivity configuration to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

DeletePrivateConnection(google::cloud::datastream::v1::DeletePrivateConnectionRequest const &, Options)

Use this method to delete a private connectivity configuration.

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

CreateRoute(std::string const &, google::cloud::datastream::v1::Route const &, std::string const &, Options)

Use this method to create a route for a private connectivity configuration in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of Routes.
route	google::cloud::datastream::v1::Route const & Required. The Route resource to create.
route_id	std::string const & Required. The Route identifier.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateRoute(google::cloud::datastream::v1::CreateRouteRequest const &, Options)

Use this method to create a route for a private connectivity configuration in a project and location.

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

GetRoute(std::string const &, Options)

Use this method to get details about a route.

Parameters
Name	Description
name	std::string const & Required. The name of the Route resource to get.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetRoute(google::cloud::datastream::v1::GetRouteRequest const &, Options)

Use this method to get details about a route.

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

ListRoutes(std::string const &, Options)

Use this method to list routes created for a private connectivity configuration in a project and location.

Parameters
Name	Description
parent	std::string const & Required. The parent that owns the collection of Routess.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListRoutes(google::cloud::datastream::v1::ListRoutesRequest, Options)

Use this method to list routes created for a private connectivity configuration in a project and location.

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

DeleteRoute(std::string const &, Options)

Use this method to delete a route.

Parameters
Name	Description
name	std::string const & Required. The name of the Route resource to delete.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteRoute(google::cloud::datastream::v1::DeleteRouteRequest const &, Options)

Use this method to delete a route.

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