Package viam.app.v1

Interface AppOuterClass.ModuleMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
AppOuterClass.ModuleMetadata, AppOuterClass.ModuleMetadata.Builder
Enclosing class:
AppOuterClass
public static interface AppOuterClass.ModuleMetadataOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntrypoint()
    The executable to run to start the module program
    com.google.protobuf.ByteString
    getEntrypointBytes()
    The executable to run to start the module program
    String
    getFirstRun()
    The path to a setup script that is run before a newly downloaded module starts.
    com.google.protobuf.ByteString
    getFirstRunBytes()
    The path to a setup script that is run before a newly downloaded module starts.
    String
    getMarkdownDescription()
    markdown content for the entire module
    com.google.protobuf.ByteString
    getMarkdownDescriptionBytes()
    markdown content for the entire module
    AppOuterClass.Model
    getModels(int index)
    A list of models that are available in the module
    int
    getModelsCount()
    A list of models that are available in the module
    List<AppOuterClass.Model>
    getModelsList()
    A list of models that are available in the module
    AppOuterClass.ModuleVersion
    getVersions(int index)
    A list of versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version
    int
    getVersionsCount()
    A list of versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version
    List<AppOuterClass.ModuleVersion>
    getVersionsList()
    A list of versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version
    boolean
    hasFirstRun()
    The path to a setup script that is run before a newly downloaded module starts.
    boolean
    hasMarkdownDescription()
    markdown content for the entire module

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getModelsList

      List<AppOuterClass.Model> getModelsList()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 1 [json_name = "models"];

    • getModels

      AppOuterClass.Model getModels(int index)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 1 [json_name = "models"];

    • getModelsCount

      int getModelsCount()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 1 [json_name = "models"];

    • getVersionsList

      List<AppOuterClass.ModuleVersion> getVersionsList()
       A list of versions of the module that are available
 When this is returned from the backend, the versions are sorted in ascending order by the semver version
      repeated .viam.app.v1.ModuleVersion versions = 2 [json_name = "versions"];

    • getVersions

      AppOuterClass.ModuleVersion getVersions(int index)
       A list of versions of the module that are available
 When this is returned from the backend, the versions are sorted in ascending order by the semver version
      repeated .viam.app.v1.ModuleVersion versions = 2 [json_name = "versions"];

    • getVersionsCount

      int getVersionsCount()
       A list of versions of the module that are available
 When this is returned from the backend, the versions are sorted in ascending order by the semver version
      repeated .viam.app.v1.ModuleVersion versions = 2 [json_name = "versions"];

    • getEntrypoint

      String getEntrypoint()
       The executable to run to start the module program
      string entrypoint = 3 [json_name = "entrypoint"];
      Returns:
      The entrypoint.

    • getEntrypointBytes

      com.google.protobuf.ByteString getEntrypointBytes()
       The executable to run to start the module program
      string entrypoint = 3 [json_name = "entrypoint"];
      Returns:
      The bytes for entrypoint.

    • hasFirstRun

      boolean hasFirstRun()
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 4 [json_name = "firstRun"];
      Returns:
      Whether the firstRun field is set.

    • getFirstRun

      String getFirstRun()
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 4 [json_name = "firstRun"];
      Returns:
      The firstRun.

    • getFirstRunBytes

      com.google.protobuf.ByteString getFirstRunBytes()
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 4 [json_name = "firstRun"];
      Returns:
      The bytes for firstRun.

    • hasMarkdownDescription

      boolean hasMarkdownDescription()
       markdown content for the entire module
      optional string markdown_description = 5 [json_name = "markdownDescription"];
      Returns:
      Whether the markdownDescription field is set.

    • getMarkdownDescription

      String getMarkdownDescription()
       markdown content for the entire module
      optional string markdown_description = 5 [json_name = "markdownDescription"];
      Returns:
      The markdownDescription.

    • getMarkdownDescriptionBytes

      com.google.protobuf.ByteString getMarkdownDescriptionBytes()
       markdown content for the entire module
      optional string markdown_description = 5 [json_name = "markdownDescription"];
      Returns:
      The bytes for markdownDescription.