Package viam.app.data.v1

Interface Data.CreateIndexRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Data.IndexableCollection
    getCollectionType()
    .viam.app.data.v1.IndexableCollection collection_type = 2 [json_name = "collectionType"];
    int
    getCollectionTypeValue()
    .viam.app.data.v1.IndexableCollection collection_type = 2 [json_name = "collectionType"];
    com.google.protobuf.ByteString
    getIndexSpec(int index)
    index_spec accepts a MongoDB index specification defined in JSON format
    int
    getIndexSpecCount()
    index_spec accepts a MongoDB index specification defined in JSON format
    List<com.google.protobuf.ByteString>
    getIndexSpecList()
    index_spec accepts a MongoDB index specification defined in JSON format
    String
    getOrganizationId()
    string organization_id = 1 [json_name = "organizationId"];
    com.google.protobuf.ByteString
    getOrganizationIdBytes()
    string organization_id = 1 [json_name = "organizationId"];
    String
    getPipelineName()
    optional string pipeline_name = 3 [json_name = "pipelineName"];
    com.google.protobuf.ByteString
    getPipelineNameBytes()
    optional string pipeline_name = 3 [json_name = "pipelineName"];
    boolean
    hasPipelineName()
    optional string pipeline_name = 3 [json_name = "pipelineName"];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getOrganizationId

      String getOrganizationId()
      string organization_id = 1 [json_name = "organizationId"];
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      com.google.protobuf.ByteString getOrganizationIdBytes()
      string organization_id = 1 [json_name = "organizationId"];
      Returns:
      The bytes for organizationId.

    • getCollectionTypeValue

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

    • getCollectionType

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

    • hasPipelineName

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

    • getPipelineName

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

    • getPipelineNameBytes

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

    • getIndexSpecList

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

    • getIndexSpecCount

      int getIndexSpecCount()
       index_spec accepts a MongoDB index specification defined 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 accepts a MongoDB index specification defined 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.