Cloud Speech V2 Client - Class SpeechClient (1.14.3)

Reference documentation and code samples for the Cloud Speech V2 Client class SpeechClient.

Service Description: Enables speech transcription and resource management.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\Speech\V2\SpeechClient for the stable implementation

Namespace

Google \ Cloud \ Speech \ V2 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

batchRecognize

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.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::batchRecognizeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\BatchRecognizeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createCustomClass

Creates a CustomClass.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::createCustomClassAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreateCustomClassRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createPhraseSet

Creates a PhraseSet.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::createPhraseSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreatePhraseSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createRecognizer

Creates a Recognizer.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::createRecognizerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreateRecognizerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteCustomClass

Deletes the CustomClass.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::deleteCustomClassAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeleteCustomClassRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deletePhraseSet

Deletes the PhraseSet.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::deletePhraseSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeletePhraseSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteRecognizer

Deletes the Recognizer.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::deleteRecognizerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeleteRecognizerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getConfig

Returns the requested Config.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::getConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\Config`

getCustomClass

Returns the requested CustomClass.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::getCustomClassAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetCustomClassRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\CustomClass`

getPhraseSet

Returns the requested PhraseSet.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::getPhraseSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetPhraseSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\PhraseSet`

getRecognizer

Returns the requested Recognizer. Fails with NOT_FOUND if the requested Recognizer doesn't exist.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::getRecognizerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetRecognizerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\Recognizer`

listCustomClasses

Lists CustomClasses.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::listCustomClassesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListCustomClassesRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listPhraseSets

Lists PhraseSets.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::listPhraseSetsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListPhraseSetsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listRecognizers

Lists Recognizers.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::listRecognizersAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListRecognizersRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

recognize

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

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::recognizeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\RecognizeRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\RecognizeResponse`

streamingRecognize

Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

undeleteCustomClass

Undeletes the CustomClass.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::undeleteCustomClassAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeleteCustomClassRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

undeletePhraseSet

Undeletes the PhraseSet.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::undeletePhraseSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeletePhraseSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

undeleteRecognizer

Undeletes the Recognizer.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::undeleteRecognizerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeleteRecognizerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateConfig

Updates the Config.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::updateConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateConfigRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Speech\V2\Config`

updateCustomClass

Updates the CustomClass.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::updateCustomClassAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateCustomClassRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updatePhraseSet

Updates the PhraseSet.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::updatePhraseSetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdatePhraseSetRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateRecognizer

Updates the Recognizer.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::updateRecognizerAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateRecognizerRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getLocation

Gets information about a location.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Location\Location`

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Speech\V2\Client\SpeechClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

batchRecognizeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\BatchRecognizeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createCustomClassAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreateCustomClassRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createPhraseSetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreatePhraseSetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createRecognizerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\CreateRecognizerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteCustomClassAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeleteCustomClassRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deletePhraseSetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeletePhraseSetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteRecognizerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\DeleteRecognizerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getCustomClassAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetCustomClassRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getPhraseSetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetPhraseSetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getRecognizerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\GetRecognizerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listCustomClassesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListCustomClassesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPhraseSetsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListPhraseSetsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listRecognizersAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\ListRecognizersRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

recognizeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\RecognizeRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

undeleteCustomClassAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeleteCustomClassRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

undeletePhraseSetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeletePhraseSetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

undeleteRecognizerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UndeleteRecognizerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateCustomClassAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateCustomClassRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updatePhraseSetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdatePhraseSetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateRecognizerAsync

Parameters
Name	Description
`request`	`Google\Cloud\Speech\V2\UpdateRecognizerRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::configName

Formats a string containing the fully-qualified path to represent a config resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted config resource.

static::cryptoKeyName

Formats a string containing the fully-qualified path to represent a crypto_key resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`

Returns
Type	Description
`string`	The formatted crypto_key resource.

static::cryptoKeyVersionName

Formats a string containing the fully-qualified path to represent a crypto_key_version resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`
`cryptoKeyVersion`	`string`

Returns
Type	Description
`string`	The formatted crypto_key_version resource.

static::customClassName

Formats a string containing the fully-qualified path to represent a custom_class resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`customClass`	`string`

Returns
Type	Description
`string`	The formatted custom_class resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::phraseSetName

Formats a string containing the fully-qualified path to represent a phrase_set resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`phraseSet`	`string`

Returns
Type	Description
`string`	The formatted phrase_set resource.

static::recognizerName

Formats a string containing the fully-qualified path to represent a recognizer resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`recognizer`	`string`

Returns
Type	Description
`string`	The formatted recognizer resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

config: projects/{project}/locations/{location}/config
cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
customClass: projects/{project}/locations/{location}/customClasses/{custom_class}
location: projects/{project}/locations/{location}
phraseSet: projects/{project}/locations/{location}/phraseSets/{phrase_set}
recognizer: projects/{project}/locations/{location}/recognizers/{recognizer}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.