Class SpeechClient (2.13.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(ExperimentalTag, std::shared_ptr< SpeechConnection >, Options)

Parameters
Name	Description
	`ExperimentalTag`
`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 > >

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 >

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 > >

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 > >

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 > >

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 > >

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 > >

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 > >

Recognize(std::string const &, google::cloud::speech::v2::RecognitionConfig const &, google::protobuf::FieldMask const &, std::string const &, Options)

Performs synchronous Speech recognition: receive results after all audio has been sent and processed.

Parameters
Name	Description
`recognizer`	`std::string const &` Required. The name of the Recognizer to use during recognition. The expected format is `projects/{project}/locations/{location}/recognizers/{recognizer}`.
`config`	`google::cloud::speech::v2::RecognitionConfig const &` Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.RecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.
`config_mask`	`google::protobuf::FieldMask const &` The list of fields in [config][google.cloud.speech.v2.RecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all non-default valued fields in [config][google.cloud.speech.v2.RecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (`*`) is provided, [config][google.cloud.speech.v2.RecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.
`content`	`std::string const &` The audio data bytes encoded as specified in [RecognitionConfig][google.cloud.speech.v2.RecognitionConfig]. As with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

Recognize(google::cloud::speech::v2::RecognizeRequest const &, Options)

Performs synchronous Speech recognition: receive results after all audio has been sent and processed.

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

AsyncStreamingRecognize(Options)

Performs bidirectional streaming speech recognition: receive results while sending audio.

This method is only available via the gRPC API (not REST).

Parameter
Name	Description
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::speech::v2::StreamingRecognizeRequest, google::cloud::speech::v2::StreamingRecognizeResponse > >

An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.speech.v2.StreamingRecognizeRequest) and response messages (google.cloud.speech.v2.StreamingRecognizeResponse) are mapped to C++ classes using the Protobuf mapping rules.

BatchRecognize(std::string const &, google::cloud::speech::v2::RecognitionConfig const &, google::protobuf::FieldMask const &, std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &, Options)

Performs batch asynchronous speech recognition: send a request with N audio files and receive a long running operation that can be polled to see when the transcriptions are finished.

Parameters
Name	Description
`recognizer`	`std::string const &` Required. Resource name of the recognizer to be used for ASR.
`config`	`google::cloud::speech::v2::RecognitionConfig const &` Features and audio metadata to use for the Automatic Speech Recognition. This field in combination with the [config_mask][google.cloud.speech.v2.BatchRecognizeRequest.config_mask] field can be used to override parts of the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the Recognizer resource.
`config_mask`	`google::protobuf::FieldMask const &` The list of fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] that override the values in the [default_recognition_config][google.cloud.speech.v2.Recognizer.default_recognition_config] of the recognizer during this recognition request. If no mask is provided, all given fields in [config][google.cloud.speech.v2.BatchRecognizeRequest.config] override the values in the recognizer for this recognition request. If a mask is provided, only the fields listed in the mask override the config in the recognizer for this recognition request. If a wildcard (`*`) is provided, [config][google.cloud.speech.v2.BatchRecognizeRequest.config] completely overrides and replaces the config in the recognizer for this recognition request.
`files`	`std::vector< google::cloud::speech::v2::BatchRecognizeFileMetadata > const &` Audio files with file metadata for ASR. The maximum number of files allowed to be specified is 5.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::BatchRecognizeResponse > >

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

BatchRecognize(google::cloud::speech::v2::BatchRecognizeRequest const &, Options)

Performs batch asynchronous speech recognition: send a request with N audio files and receive a long running operation that can be polled to see when the transcriptions are finished.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::BatchRecognizeRequest 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.BatchRecognizeRequest. 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::BatchRecognizeResponse > >

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

GetConfig(std::string const &, Options)

Returns the requested Config.

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

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

GetConfig(google::cloud::speech::v2::GetConfigRequest const &, Options)

Returns the requested Config.

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

UpdateConfig(google::cloud::speech::v2::Config const &, google::protobuf::FieldMask const &, Options)

Updates the Config.

Parameters
Name	Description
`config`	`google::cloud::speech::v2::Config const &` Required. The config to update. The config's `name` field is used to identify the config to be updated. The expected format is `projects/{project}/locations/{location}/config`.
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

UpdateConfig(google::cloud::speech::v2::UpdateConfigRequest const &, Options)

Updates the Config.

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

CreateCustomClass(std::string const &, google::cloud::speech::v2::CustomClass const &, std::string const &, Options)

Creates a CustomClass.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location where this CustomClass will be created. The expected format is `projects/{project}/locations/{location}`.
`custom_class`	`google::cloud::speech::v2::CustomClass const &` Required. The CustomClass to create.
`custom_class_id`	`std::string const &` The ID to use for the CustomClass, which will become the final component of the CustomClass'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::CustomClass > >

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

CreateCustomClass(google::cloud::speech::v2::CreateCustomClassRequest const &, Options)

Creates a CustomClass.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::CreateCustomClassRequest 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.CreateCustomClassRequest. 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::CustomClass > >

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

ListCustomClasses(std::string const &, Options)

Lists CustomClasses.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location of CustomClass resources 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::CustomClass >

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

ListCustomClasses(google::cloud::speech::v2::ListCustomClassesRequest, Options)

Lists CustomClasses.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::ListCustomClassesRequest` 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.ListCustomClassesRequest. 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::CustomClass >

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

GetCustomClass(std::string const &, Options)

Returns the requested CustomClass.

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

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

GetCustomClass(google::cloud::speech::v2::GetCustomClassRequest const &, Options)

Returns the requested CustomClass.

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

UpdateCustomClass(google::cloud::speech::v2::CustomClass const &, google::protobuf::FieldMask const &, Options)

Updates the CustomClass.

Parameters
Name	Description
`custom_class`	`google::cloud::speech::v2::CustomClass const &` Required. The CustomClass to update. The CustomClass's `name` field is used to identify the CustomClass to update. Format: `projects/{project}/locations/{location}/customClasses/{custom_class}`.
`update_mask`	`google::protobuf::FieldMask const &` The list of fields to be updated. If empty, all fields are considered for update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::CustomClass > >

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

UpdateCustomClass(google::cloud::speech::v2::UpdateCustomClassRequest const &, Options)

Updates the CustomClass.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::UpdateCustomClassRequest 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.UpdateCustomClassRequest. 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::CustomClass > >

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

DeleteCustomClass(std::string const &, Options)

Deletes the CustomClass.

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

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::CustomClass > >

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

DeleteCustomClass(google::cloud::speech::v2::DeleteCustomClassRequest const &, Options)

Deletes the CustomClass.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::DeleteCustomClassRequest 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.DeleteCustomClassRequest. 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::CustomClass > >

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

UndeleteCustomClass(std::string const &, Options)

Undeletes the CustomClass.

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

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::CustomClass > >

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

UndeleteCustomClass(google::cloud::speech::v2::UndeleteCustomClassRequest const &, Options)

Undeletes the CustomClass.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::UndeleteCustomClassRequest 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.UndeleteCustomClassRequest. 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::CustomClass > >

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

CreatePhraseSet(std::string const &, google::cloud::speech::v2::PhraseSet const &, std::string const &, Options)

Creates a PhraseSet.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location where this PhraseSet will be created. The expected format is `projects/{project}/locations/{location}`.
`phrase_set`	`google::cloud::speech::v2::PhraseSet const &` Required. The PhraseSet to create.
`phrase_set_id`	`std::string const &` The ID to use for the PhraseSet, which will become the final component of the PhraseSet'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::PhraseSet > >

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

CreatePhraseSet(google::cloud::speech::v2::CreatePhraseSetRequest const &, Options)

Creates a PhraseSet.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::CreatePhraseSetRequest 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.CreatePhraseSetRequest. 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::PhraseSet > >

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

ListPhraseSets(std::string const &, Options)

Lists PhraseSets.

Parameters
Name	Description
`parent`	`std::string const &` Required. The project and location of PhraseSet resources 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::PhraseSet >

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

ListPhraseSets(google::cloud::speech::v2::ListPhraseSetsRequest, Options)

Lists PhraseSets.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::ListPhraseSetsRequest` 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.ListPhraseSetsRequest. 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::PhraseSet >

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

GetPhraseSet(std::string const &, Options)

Returns the requested PhraseSet.

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

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

GetPhraseSet(google::cloud::speech::v2::GetPhraseSetRequest const &, Options)

Returns the requested PhraseSet.

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

UpdatePhraseSet(google::cloud::speech::v2::PhraseSet const &, google::protobuf::FieldMask const &, Options)

Updates the PhraseSet.

Parameters
Name	Description
`phrase_set`	`google::cloud::speech::v2::PhraseSet const &` Required. The PhraseSet to update. The PhraseSet's `name` field is used to identify the PhraseSet to update. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.
`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 PhraseSet resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::PhraseSet > >

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

UpdatePhraseSet(google::cloud::speech::v2::UpdatePhraseSetRequest const &, Options)

Updates the PhraseSet.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::UpdatePhraseSetRequest 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.UpdatePhraseSetRequest. 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::PhraseSet > >

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

DeletePhraseSet(std::string const &, Options)

Deletes the PhraseSet.

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

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::PhraseSet > >

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

DeletePhraseSet(google::cloud::speech::v2::DeletePhraseSetRequest const &, Options)

Deletes the PhraseSet.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::DeletePhraseSetRequest 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.DeletePhraseSetRequest. 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::PhraseSet > >

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

UndeletePhraseSet(std::string const &, Options)

Undeletes the PhraseSet.

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

Returns

Type Description

future< StatusOr< google::cloud::speech::v2::PhraseSet > >

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

UndeletePhraseSet(google::cloud::speech::v2::UndeletePhraseSetRequest const &, Options)

Undeletes the PhraseSet.

Parameters
Name	Description
`request`	`google::cloud::speech::v2::UndeletePhraseSetRequest 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.UndeletePhraseSetRequest. 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::PhraseSet > >

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