Reference documentation and code samples for the Cloud Speech-to-Text V2 API class Google::Cloud::Speech::V2::Config.
Message representing the config for the Speech-to-Text API. This includes an
optional KMS key
with which incoming data will be encrypted.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#kms_key_name
defkms_key_name()->::String
Returns
(::String) — Optional. An optional KMS key
name that if
present, will be used to encrypt Speech-to-Text resources at-rest. Updating
this key will not encrypt existing resources using this key; only new
resources will be encrypted using this key. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
#kms_key_name=
defkms_key_name=(value)->::String
Parameter
value (::String) — Optional. An optional KMS key
name that if
present, will be used to encrypt Speech-to-Text resources at-rest. Updating
this key will not encrypt existing resources using this key; only new
resources will be encrypted using this key. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
Returns
(::String) — Optional. An optional KMS key
name that if
present, will be used to encrypt Speech-to-Text resources at-rest. Updating
this key will not encrypt existing resources using this key; only new
resources will be encrypted using this key. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
#name
defname()->::String
Returns
(::String) — Output only. Identifier. The name of the config resource. There is exactly
one config resource per project per location. The expected format is
projects/{project}/locations/{location}/config.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Speech-to-Text V2 API - Class Google::Cloud::Speech::V2::Config (v1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-Config)\n- [1.2.0](/ruby/docs/reference/google-cloud-speech-v2/1.2.0/Google-Cloud-Speech-V2-Config)\n- [1.1.0](/ruby/docs/reference/google-cloud-speech-v2/1.1.0/Google-Cloud-Speech-V2-Config)\n- [1.0.1](/ruby/docs/reference/google-cloud-speech-v2/1.0.1/Google-Cloud-Speech-V2-Config)\n- [0.16.0](/ruby/docs/reference/google-cloud-speech-v2/0.16.0/Google-Cloud-Speech-V2-Config)\n- [0.15.0](/ruby/docs/reference/google-cloud-speech-v2/0.15.0/Google-Cloud-Speech-V2-Config)\n- [0.14.0](/ruby/docs/reference/google-cloud-speech-v2/0.14.0/Google-Cloud-Speech-V2-Config)\n- [0.13.1](/ruby/docs/reference/google-cloud-speech-v2/0.13.1/Google-Cloud-Speech-V2-Config)\n- [0.12.0](/ruby/docs/reference/google-cloud-speech-v2/0.12.0/Google-Cloud-Speech-V2-Config)\n- [0.11.0](/ruby/docs/reference/google-cloud-speech-v2/0.11.0/Google-Cloud-Speech-V2-Config)\n- [0.10.0](/ruby/docs/reference/google-cloud-speech-v2/0.10.0/Google-Cloud-Speech-V2-Config)\n- [0.9.2](/ruby/docs/reference/google-cloud-speech-v2/0.9.2/Google-Cloud-Speech-V2-Config)\n- [0.8.0](/ruby/docs/reference/google-cloud-speech-v2/0.8.0/Google-Cloud-Speech-V2-Config)\n- [0.7.0](/ruby/docs/reference/google-cloud-speech-v2/0.7.0/Google-Cloud-Speech-V2-Config)\n- [0.6.0](/ruby/docs/reference/google-cloud-speech-v2/0.6.0/Google-Cloud-Speech-V2-Config)\n- [0.5.1](/ruby/docs/reference/google-cloud-speech-v2/0.5.1/Google-Cloud-Speech-V2-Config)\n- [0.4.0](/ruby/docs/reference/google-cloud-speech-v2/0.4.0/Google-Cloud-Speech-V2-Config)\n- [0.3.0](/ruby/docs/reference/google-cloud-speech-v2/0.3.0/Google-Cloud-Speech-V2-Config)\n- [0.2.0](/ruby/docs/reference/google-cloud-speech-v2/0.2.0/Google-Cloud-Speech-V2-Config)\n- [0.1.0](/ruby/docs/reference/google-cloud-speech-v2/0.1.0/Google-Cloud-Speech-V2-Config) \nReference documentation and code samples for the Cloud Speech-to-Text V2 API class Google::Cloud::Speech::V2::Config.\n\nMessage representing the config for the Speech-to-Text API. This includes an\noptional [KMS key](https://cloud.google.com/kms/docs/resource-hierarchy#keys)\nwith which incoming data will be encrypted. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #kms_key_name\n\n def kms_key_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. An optional [KMS key\n name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) that if present, will be used to encrypt Speech-to-Text resources at-rest. Updating this key will not encrypt existing resources using this key; only new resources will be encrypted using this key. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.\n\n### #kms_key_name=\n\n def kms_key_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. An optional [KMS key\nname](https://cloud.google.com/kms/docs/resource-hierarchy#keys) that if present, will be used to encrypt Speech-to-Text resources at-rest. Updating this key will not encrypt existing resources using this key; only new resources will be encrypted using this key. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. \n**Returns**\n\n- (::String) --- Optional. An optional [KMS key\n name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) that if present, will be used to encrypt Speech-to-Text resources at-rest. Updating this key will not encrypt existing resources using this key; only new resources will be encrypted using this key. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Identifier. The name of the config resource. There is exactly one config resource per project per location. The expected format is `projects/{project}/locations/{location}/config`.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The most recent time this resource was modified."]]