SearchRequest class

Inheritance
Available extensions

Constructors

SearchRequest({String? query, String? contextFilter, String? kindFilter, bool? includeDeprecated, PaginationRequest? pagination, double? minScore, bool? includeRevisionMetadata, bool? includeArtifactMetadata})
factory
SearchRequest.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
SearchRequest.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

contextFilter ↔ String
Optional: Restrict search to a kref prefix (e.g., "myproject/assets")
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
includeArtifactMetadata ↔ bool
getter/setter pair
includeDeprecated ↔ bool
Include soft-deleted (deprecated) items in results
getter/setter pair
includeRevisionMetadata ↔ bool
Search depth options - control performance vs completeness tradeoff Default: Only search Item index (fastest) When enabled, also searches Revision/Artifact metadata (slower but more comprehensive)
getter/setter pair
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
kindFilter ↔ String
Optional: Filter by exact item kind (e.g., "model", "texture", "rig")
getter/setter pair
minScore ↔ double
Minimum relevance score (0.0 to 1.0, default 0.0 returns all matches)
getter/setter pair
pagination ↔ PaginationRequest
Pagination parameters
getter/setter pair
query ↔ String
Search query string (supports Lucene syntax for advanced users) Simple usage: "hero model" finds items matching both terms Fuzzy matching is automatic - typos like "heros" will match "hero"
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearContextFilter() → 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
clearIncludeArtifactMetadata() → void
clearIncludeDeprecated() → void
clearIncludeRevisionMetadata() → void
clearKindFilter() → void
clearMinScore() → void
clearPagination() → void
clearQuery() → void
clone() → SearchRequest
Creates a deep copy of the fields in this message.
override
copyWith(void updates(SearchRequest)) → SearchRequest
Apply updates to a copy of this message.
override
createEmptyInstance() → SearchRequest
Creates an empty instance of the same message type as this.
override
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensurePagination() → PaginationRequest
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
hasContextFilter() → 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
hasIncludeArtifactMetadata() → bool
hasIncludeDeprecated() → bool
hasIncludeRevisionMetadata() → bool
hasKindFilter() → bool
hasMinScore() → bool
hasPagination() → bool
hasQuery() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
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
Same as mergeFromBuffer, but takes a CodedBufferReader input.
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
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
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
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
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() → SearchRequest
getDefault() → SearchRequest