IndexOptions class

Inheritance

• Object
• GeneratedMessage
• IndexOptions

Constructors

IndexOptions({BoolValue? background, Int32Value? expireAfterSeconds, StringValue? name, BoolValue? sparse, List<int>? storageEngine, BoolValue? unique, Int32Value? version, StringValue? defaultLanguage, StringValue? languageOverride, Int32Value? textVersion, List<int>? weights, Int32Value? sphereVersion, Int32Value? bits, DoubleValue? max, DoubleValue? min, Int32Value? bucketSize, List<int>? partialFilterExpression, List<int>? collation, List<int>? wildcardProjection, BoolValue? hidden})

factory

IndexOptions.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

IndexOptions.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

background ↔ BoolValue

getter/setter pair

bits ↔ Int32Value

getter/setter pair

bucketSize ↔ Int32Value

getter/setter pair

collation ↔ List<int>

getter/setter pair

defaultLanguage ↔ StringValue

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

expireAfterSeconds ↔ Int32Value

getter/setter pair

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

hidden ↔ BoolValue

getter/setter pair

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

languageOverride ↔ StringValue

getter/setter pair

max ↔ DoubleValue

getter/setter pair

min ↔ DoubleValue

getter/setter pair

name ↔ StringValue

getter/setter pair

partialFilterExpression ↔ List<int>

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sparse ↔ BoolValue

getter/setter pair

sphereVersion ↔ Int32Value

getter/setter pair

storageEngine ↔ List<int>

getter/setter pair

textVersion ↔ Int32Value

getter/setter pair

unique ↔ BoolValue

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

version ↔ Int32Value

getter/setter pair

weights ↔ List<int>

getter/setter pair

wildcardProjection ↔ List<int>

getter/setter pair

Methods

$_ensure<T>(int index) → T

For generated code only.

inherited

$_get<T>(int index, T defaultValue) → T

For generated code only.

inherited

$_getB(int index, bool defaultValue) → bool

For generated code only.

inherited

$_getBF(int index) → bool

For generated code only.

inherited

$_getI(int index, int defaultValue) → int

For generated code only.

inherited

$_getI64(int index) → Int64

For generated code only.

inherited

$_getIZ(int index) → int

For generated code only.

inherited

$_getList<T>(int index) → List<T>

For generated code only.

inherited

$_getMap<K, V>(int index) → Map<K, V>

For generated code only.

inherited

$_getN<T>(int index) → T

For generated code only.

inherited

$_getS(int index, String defaultValue) → String

For generated code only.

inherited

$_getSZ(int index) → String

For generated code only.

inherited

$_has(int index) → bool

For generated code only.

inherited

$_setBool(int index, bool value) → void

For generated code only.

inherited

$_setBytes(int index, List<int> value) → void

For generated code only.

inherited

$_setDouble(int index, double value) → void

For generated code only.

inherited

$_setFloat(int index, double value) → void

For generated code only.

inherited

$_setInt64(int index, Int64 value) → void

For generated code only.

inherited

$_setSignedInt32(int index, int value) → void

For generated code only.

inherited

$_setString(int index, String value) → void

For generated code only.

inherited

$_setUnsignedInt32(int index, int value) → void

For generated code only.

inherited

$_whichOneof(int oneofIndex) → int

inherited

addExtension(Extension extension, dynamic 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

clearBackground() → void

clearBits() → void

clearBucketSize() → void

clearCollation() → void

clearDefaultLanguage() → void

clearExpireAfterSeconds() → 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

clearHidden() → void

clearLanguageOverride() → void

clearMax() → void

clearMin() → void

clearName() → void

clearPartialFilterExpression() → void

clearSparse() → void

clearSphereVersion() → void

clearStorageEngine() → void

clearTextVersion() → void

clearUnique() → void

clearVersion() → void

clearWeights() → void

clearWildcardProjection() → void

clone() → IndexOptions

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(IndexOptions)) → IndexOptions

Apply updates to a copy of this message.

override

createEmptyInstance() → IndexOptions

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

ensureBackground() → BoolValue

ensureBits() → Int32Value

ensureBucketSize() → Int32Value

ensureDefaultLanguage() → StringValue

ensureExpireAfterSeconds() → Int32Value

ensureHidden() → BoolValue

ensureLanguageOverride() → StringValue

ensureMax() → DoubleValue

ensureMin() → DoubleValue

ensureName() → StringValue

ensureSparse() → BoolValue

ensureSphereVersion() → Int32Value

ensureTextVersion() → Int32Value

ensureUnique() → BoolValue

ensureVersion() → Int32Value

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

hasBackground() → bool

hasBits() → bool

hasBucketSize() → bool

hasCollation() → bool

hasDefaultLanguage() → bool

hasExpireAfterSeconds() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasHidden() → bool

hasLanguageOverride() → bool

hasMax() → bool

hasMin() → bool

hasName() → bool

hasPartialFilterExpression() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasSparse() → bool

hasSphereVersion() → bool

hasStorageEngine() → bool

hasTextVersion() → bool

hasUnique() → bool

hasVersion() → bool

hasWeights() → bool

hasWildcardProjection() → 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 by GeneratedMessage.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() → IndexOptions

createRepeated() → PbList<IndexOptions>

getDefault() → IndexOptions