Recognizer class
A Recognizer message. Stores recognition configuration and metadata.
- Inheritance
-
- Object
- GeneratedMessage
- Recognizer
Constructors
-
Recognizer({String? name, String? uid, String? displayName, @Deprecated('This field is deprecated.') String? model, RecognitionConfig? defaultRecognitionConfig, Map<
String, String> ? annotations, Recognizer_State? state, Timestamp? createTime, Timestamp? updateTime, Timestamp? deleteTime, String? etag, bool? reconciling, Timestamp? expireTime, String? kmsKeyName, String? kmsKeyVersionName, @Deprecated('This field is deprecated.') Iterable<String> ? languageCodes}) -
factory
-
Recognizer.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- Recognizer.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
annotations
→ Map<
String, String> -
Allows users to store small amounts of arbitrary data.
Both the key and the value must be 63 characters or less each.
At most 100 annotations.
no setter
- createTime ↔ Timestamp
-
Output only. Creation time.
getter/setter pair
- defaultRecognitionConfig ↔ RecognitionConfig
-
Default configuration to use for requests with this Recognizer.
This can be overwritten by inline configuration in the
google.cloud.speech.v2.RecognizeRequest.config
field.getter/setter pair - deleteTime ↔ Timestamp
-
Output only. The time at which this Recognizer was requested for deletion.
getter/setter pair
- displayName ↔ String
-
User-settable, human-readable name for the Recognizer. Must be 63
characters or less.
getter/setter pair
- etag ↔ String
-
Output only. This checksum is computed by the server based on the value of
other fields. This may be sent on update, undelete, and delete requests to
ensure the client has an up-to-date value before proceeding.
getter/setter pair
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- expireTime ↔ Timestamp
-
Output only. The time at which this Recognizer will be purged.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited - kmsKeyName ↔ String
-
Output only. The KMS key
name with which
the Recognizer is encrypted. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
.getter/setter pair - kmsKeyVersionName ↔ String
-
Output only. The KMS key version
name
with which the Recognizer is encrypted. The expected format is
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
.getter/setter pair -
languageCodes
→ List<
String> -
Optional. The language of the supplied audio as a
BCP-47 language tag.
no setter
- model ↔ String
-
Optional. Which model to use for recognition requests. Select the model
best suited to your domain to get best results.
getter/setter pair
- name ↔ String
-
Output only. The resource name of the Recognizer.
Format:
projects/{project}/locations/{location}/recognizers/{recognizer}
.getter/setter pair - reconciling ↔ bool
-
Output only. Whether or not this Recognizer is in the process of being
updated.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state ↔ Recognizer_State
-
Output only. The Recognizer lifecycle state.
getter/setter pair
- uid ↔ String
-
Output only. System-assigned unique identifier for the Recognizer.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
- updateTime ↔ Timestamp
-
Output only. The most recent time this Recognizer was modified.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearCreateTime(
) → void -
clearDefaultRecognitionConfig(
) → void -
clearDeleteTime(
) → void -
clearDisplayName(
) → void -
clearEtag(
) → void -
clearExpireTime(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearKmsKeyName(
) → void -
clearKmsKeyVersionName(
) → void -
clearModel(
) → void -
clearName(
) → void -
clearReconciling(
) → void -
clearState(
) → void -
clearUid(
) → void -
clearUpdateTime(
) → void -
clone(
) → Recognizer -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(Recognizer)) → Recognizer -
Apply
updates
to a copy of this message.override -
createEmptyInstance(
) → Recognizer -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureCreateTime(
) → Timestamp -
ensureDefaultRecognitionConfig(
) → RecognitionConfig -
ensureDeleteTime(
) → Timestamp -
ensureExpireTime(
) → Timestamp -
ensureUpdateTime(
) → Timestamp -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension
.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber
, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasCreateTime(
) → bool -
hasDefaultRecognitionConfig(
) → bool -
hasDeleteTime(
) → bool -
hasDisplayName(
) → bool -
hasEtag(
) → bool -
hasExpireTime(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
true
if a value ofextension
is present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber
.inherited -
hasKmsKeyName(
) → bool -
hasKmsKeyVersionName(
) → bool -
hasModel(
) → bool -
hasName(
) → bool -
hasReconciling(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasState(
) → bool -
hasUid(
) → bool -
hasUpdateTime(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data
, a JSON object, encoded as described byGeneratedMessage.writeToJson
.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
other
into this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json
, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value
.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber
.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this
.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → Recognizer -
createRepeated(
) → PbList< Recognizer> -
getDefault(
) → Recognizer