Class SpeechClient (2.15.1)

Version 2.15.1

• 2.20.0-rc (latest)
• 2.19.0

Enables speech transcription and resource management.

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

SpeechClient(SpeechClient const &)

Copy and move support

Parameter
Name	Description
	SpeechClient const &

SpeechClient(SpeechClient &&)

Copy and move support

Parameter
Name	Description
	SpeechClient &&

SpeechClient(std::shared_ptr< SpeechConnection >, Options)

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

Operators

operator=(SpeechClient const &)

Copy and move support

Parameter
Name	Description
	SpeechClient const &

Returns
Type	Description
SpeechClient &

operator=(SpeechClient &&)

Copy and move support

Parameter
Name	Description
	SpeechClient &&

Returns
Type	Description
SpeechClient &

Functions

CreateRecognizer(std::string const &, google::cloud::speech::v2::Recognizer const &, std::string const &, Options)

Creates a Recognizer.

Parameters
Name	Description
parent	std::string const & Required. The project and location where this Recognizer will be created. The expected format is projects/{project}/locations/{location}.
recognizer	google::cloud::speech::v2::Recognizer const & Required. The Recognizer to create.
recognizer_id	std::string const & The ID to use for the Recognizer, which will become the final component of the Recognizer's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

CreateRecognizer(google::cloud::speech::v2::CreateRecognizerRequest const &, Options)

Creates a Recognizer.

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

ListRecognizers(std::string const &, Options)

Lists Recognizers.

Parameters
Name	Description
parent	std::string const & Required. The project and location of Recognizers to list. The expected format is projects/{project}/locations/{location}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

ListRecognizers(google::cloud::speech::v2::ListRecognizersRequest, Options)

Lists Recognizers.

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

GetRecognizer(std::string const &, Options)

Returns the requested Recognizer.

Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn't exist.

Parameters
Name	Description
name	std::string const & Required. The name of the Recognizer to retrieve. The expected format is projects/{project}/locations/{location}/recognizers/{recognizer}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

GetRecognizer(google::cloud::speech::v2::GetRecognizerRequest const &, Options)

Returns the requested Recognizer.

Fails with [NOT_FOUND][google.rpc.Code.NOT_FOUND] if the requested Recognizer doesn't exist.

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

UpdateRecognizer(google::cloud::speech::v2::Recognizer const &, google::protobuf::FieldMask const &, Options)

Updates the Recognizer.

Parameters
Name	Description
recognizer	google::cloud::speech::v2::Recognizer const & Required. The Recognizer to update. The Recognizer's name field is used to identify the Recognizer to update. Format: projects/{project}/locations/{location}/recognizers/{recognizer}.
update_mask	google::protobuf::FieldMask const & The list of fields to update. If empty, all non-default valued fields are considered for update. Use * to update the entire Recognizer resource.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateRecognizer(google::cloud::speech::v2::UpdateRecognizerRequest const &, Options)

Updates the Recognizer.

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

DeleteRecognizer(std::string const &, Options)

Deletes the Recognizer.

Parameters
Name	Description
name	std::string const & Required. The name of the Recognizer to delete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

DeleteRecognizer(google::cloud::speech::v2::DeleteRecognizerRequest const &, Options)

Deletes the Recognizer.

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

UndeleteRecognizer(std::string const &, Options)

Undeletes the Recognizer.

Parameters
Name	Description
name	std::string const & Required. The name of the Recognizer to undelete. Format: projects/{project}/locations/{location}/recognizers/{recognizer}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

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

UndeleteRecognizer(google::cloud::speech::v2::UndeleteRecognizerRequest const &, Options)

Undeletes the Recognizer.

Parameters
Name	Description
request	google::cloud::speech::v2::UndeleteRecognizerRequest 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.speech.v2.UndeleteRecognizerRequest. 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::speech::v2::Recognizer > >	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.speech.v2.Recognizer proto message. The C++ class representing this message is creat