Package viam.app.v1

Interface App.ModelOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
App.Model, App.Model.Builder
Enclosing class:
App
public static interface App.ModelOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getApi()
    The colon-delimited-triplet of the api implemented by the model
    com.google.protobuf.ByteString
    getApiBytes()
    The colon-delimited-triplet of the api implemented by the model
    String
    getDescription()
    A short description of the model that explains its purpose
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the model that explains its purpose
    String
    getMarkdownDocumentation()
    The markdown content describing the usage of the model
    com.google.protobuf.ByteString
    getMarkdownDocumentationBytes()
    The markdown content describing the usage of the model
    String
    getModel()
    The colon-delimited-triplet of the model
    com.google.protobuf.ByteString
    getModelBytes()
    The colon-delimited-triplet of the model
    boolean
    hasDescription()
    A short description of the model that explains its purpose
    boolean
    hasMarkdownDocumentation()
    The markdown content describing the usage of the model

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getApi

      String getApi()
       The colon-delimited-triplet of the api implemented by the model
      string api = 1 [json_name = "api"];
      Returns:
      The api.

    • getApiBytes

      com.google.protobuf.ByteString getApiBytes()
       The colon-delimited-triplet of the api implemented by the model
      string api = 1 [json_name = "api"];
      Returns:
      The bytes for api.

    • getModel

      String getModel()
       The colon-delimited-triplet of the model
      string model = 2 [json_name = "model"];
      Returns:
      The model.

    • getModelBytes

      com.google.protobuf.ByteString getModelBytes()
       The colon-delimited-triplet of the model
      string model = 2 [json_name = "model"];
      Returns:
      The bytes for model.

    • hasMarkdownDocumentation

      boolean hasMarkdownDocumentation()
       The markdown content describing the usage of the model
      optional string markdown_documentation = 3 [json_name = "markdownDocumentation"];
      Returns:
      Whether the markdownDocumentation field is set.

    • getMarkdownDocumentation

      String getMarkdownDocumentation()
       The markdown content describing the usage of the model
      optional string markdown_documentation = 3 [json_name = "markdownDocumentation"];
      Returns:
      The markdownDocumentation.

    • getMarkdownDocumentationBytes

      com.google.protobuf.ByteString getMarkdownDocumentationBytes()
       The markdown content describing the usage of the model
      optional string markdown_documentation = 3 [json_name = "markdownDocumentation"];
      Returns:
      The bytes for markdownDocumentation.

    • hasDescription

      boolean hasDescription()
       A short description of the model that explains its purpose
      optional string description = 4 [json_name = "description"];
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       A short description of the model that explains its purpose
      optional string description = 4 [json_name = "description"];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A short description of the model that explains its purpose
      optional string description = 4 [json_name = "description"];
      Returns:
      The bytes for description.