Package viam.app.data.v1

Interface Data.IndexOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Data.Index, Data.Index.Builder
Enclosing class:
Data
public static interface Data.IndexOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Data.IndexableCollection
    getCollectionType()
    .viam.app.data.v1.IndexableCollection collection_type = 1 [json_name = "collectionType"];
    int
    getCollectionTypeValue()
    .viam.app.data.v1.IndexableCollection collection_type = 1 [json_name = "collectionType"];
    Data.IndexCreator
    getCreatedBy()
    .viam.app.data.v1.IndexCreator created_by = 5 [json_name = "createdBy"];
    int
    getCreatedByValue()
    .viam.app.data.v1.IndexCreator created_by = 5 [json_name = "createdBy"];
    String
    getIndexName()
    string index_name = 3 [json_name = "indexName"];
    com.google.protobuf.ByteString
    getIndexNameBytes()
    string index_name = 3 [json_name = "indexName"];
    com.google.protobuf.ByteString
    getIndexSpec(int index)
    index_spec defines a MongoDB index in JSON format
    int
    getIndexSpecCount()
    index_spec defines a MongoDB index in JSON format
    List<com.google.protobuf.ByteString>
    getIndexSpecList()
    index_spec defines a MongoDB index in JSON format
    String
    getPipelineName()
    optional string pipeline_name = 2 [json_name = "pipelineName"];
    com.google.protobuf.ByteString
    getPipelineNameBytes()
    optional string pipeline_name = 2 [json_name = "pipelineName"];
    boolean
    hasPipelineName()
    optional string pipeline_name = 2 [json_name = "pipelineName"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getCollectionTypeValue

      int getCollectionTypeValue()
      .viam.app.data.v1.IndexableCollection collection_type = 1 [json_name = "collectionType"];
      Returns:
      The enum numeric value on the wire for collectionType.

    • getCollectionType

      Data.IndexableCollection getCollectionType()
      .viam.app.data.v1.IndexableCollection collection_type = 1 [json_name = "collectionType"];
      Returns:
      The collectionType.

    • hasPipelineName

      boolean hasPipelineName()
      optional string pipeline_name = 2 [json_name = "pipelineName"];
      Returns:
      Whether the pipelineName field is set.

    • getPipelineName

      String getPipelineName()
      optional string pipeline_name = 2 [json_name = "pipelineName"];
      Returns:
      The pipelineName.

    • getPipelineNameBytes

      com.google.protobuf.ByteString getPipelineNameBytes()
      optional string pipeline_name = 2 [json_name = "pipelineName"];
      Returns:
      The bytes for pipelineName.

    • getIndexName

      String getIndexName()
      string index_name = 3 [json_name = "indexName"];
      Returns:
      The indexName.

    • getIndexNameBytes

      com.google.protobuf.ByteString getIndexNameBytes()
      string index_name = 3 [json_name = "indexName"];
      Returns:
      The bytes for indexName.

    • getIndexSpecList

      List<com.google.protobuf.ByteString> getIndexSpecList()
       index_spec defines a MongoDB index in JSON format
      repeated bytes index_spec = 4 [json_name = "indexSpec"];
      Returns:
      A list containing the indexSpec.

    • getIndexSpecCount

      int getIndexSpecCount()
       index_spec defines a MongoDB index in JSON format
      repeated bytes index_spec = 4 [json_name = "indexSpec"];
      Returns:
      The count of indexSpec.

    • getIndexSpec

      com.google.protobuf.ByteString getIndexSpec(int index)
       index_spec defines a MongoDB index in JSON format
      repeated bytes index_spec = 4 [json_name = "indexSpec"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The indexSpec at the given index.

    • getCreatedByValue

      int getCreatedByValue()
      .viam.app.data.v1.IndexCreator created_by = 5 [json_name = "createdBy"];
      Returns:
      The enum numeric value on the wire for createdBy.

    • getCreatedBy

      Data.IndexCreator getCreatedBy()
      .viam.app.data.v1.IndexCreator created_by = 5 [json_name = "createdBy"];
      Returns:
      The createdBy.