Class Index

Generated

from message viam.app.data.v1.Index

Hierarchy

Constructors

constructor

Properties

collectionType createdBy indexName indexSpec pipelineName? fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

  • new Index(data?: PartialMessage<Index>): Index

    Parameters

    • Optionaldata: PartialMessage<Index>

    Returns Index

Properties

collectionType

collectionType: IndexableCollection

Generated

from field: viam.app.data.v1.IndexableCollection collection_type = 1;

createdBy

createdBy: IndexCreator

Generated

from field: viam.app.data.v1.IndexCreator created_by = 5;

indexName

indexName: string

Generated

from field: string index_name = 3;

indexSpec

indexSpec: Uint8Array[]

index_spec defines a MongoDB index in JSON format

Generated

from field: repeated bytes index_spec = 4;

OptionalpipelineName

pipelineName?: string

Generated

from field: optional string pipeline_name = 2;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "viam.app.data.v1.Index"

Methods

clone

  • clone(): Index

    Create a deep copy.

    Returns Index

equals

  • equals(other: undefined | null | Index | PlainMessage<Index>): boolean

    Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    Parameters

    Returns boolean

fromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this

    Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<Index>

    Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<Index>

toBinary

  • toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array

    Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

toJson

  • toJson(options?: Partial<JsonWriteOptions>): JsonValue

    Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

ProtectedtoJSON

  • toJSON(): JsonValue

    Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

toJsonString

  • toJsonString(options?: Partial<JsonWriteStringOptions>): string

    Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

StaticfromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Index

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns Index

StaticfromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Index

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Index

StaticfromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Index

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Index

Settings

Member Visibility

On This Page

Constructors
Properties
Methods