Package viam.app.v1

Interface App.ModuleOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A short description of the module that explains its purpose
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the module that explains its purpose
    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.
    App.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<App.Model>
    getModelsList()
    A list of models that are available in the module
    String
    getModuleId()
    The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
    com.google.protobuf.ByteString
    getModuleIdBytes()
    The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
    String
    getName()
    The name of the module
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the module
    String
    getOrganizationId()
    The id of the organization that owns the module
    com.google.protobuf.ByteString
    getOrganizationIdBytes()
    The id of the organization that owns the module
    String
    getPublicNamespace()
    The public namespace of the organization that owns the module This is empty if no public namespace is set
    com.google.protobuf.ByteString
    getPublicNamespaceBytes()
    The public namespace of the organization that owns the module This is empty if no public namespace is set
    long
    getTotalOrganizationUsage()
    The total number of organizations using this module
    long
    getTotalRobotUsage()
    The total number of robots using this module
    String
    getUrl()
    The url to reference for documentation, code, etc.
    com.google.protobuf.ByteString
    getUrlBytes()
    The url to reference for documentation, code, etc.
    App.VersionHistory
    getVersions(int index)
    The 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()
    The 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<App.VersionHistory>
    getVersionsList()
    The 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
    App.Visibility
    getVisibility()
    The visibility of the module
    int
    getVisibilityValue()
    The visibility of the module
    boolean
    hasFirstRun()
    The path to a setup script that is run before a newly downloaded module starts.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getModuleId

      String getModuleId()
       The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
      string module_id = 1 [json_name = "moduleId"];
      Returns:
      The moduleId.

    • getModuleIdBytes

      com.google.protobuf.ByteString getModuleIdBytes()
       The id of the module (formatted as prefix:name where prefix is the module owner's orgid or namespace)
      string module_id = 1 [json_name = "moduleId"];
      Returns:
      The bytes for moduleId.

    • getName

      String getName()
       The name of the module
      string name = 2 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the module
      string name = 2 [json_name = "name"];
      Returns:
      The bytes for name.

    • getVisibilityValue

      int getVisibilityValue()
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      App.Visibility getVisibility()
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Returns:
      The visibility.

    • getVersionsList

      List<App.VersionHistory> getVersionsList()
       The 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.VersionHistory versions = 4 [json_name = "versions"];

    • getVersions

      App.VersionHistory getVersions(int index)
       The 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.VersionHistory versions = 4 [json_name = "versions"];

    • getVersionsCount

      int getVersionsCount()
       The 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.VersionHistory versions = 4 [json_name = "versions"];

    • getUrl

      String getUrl()
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Returns:
      The url.

    • getUrlBytes

      com.google.protobuf.ByteString getUrlBytes()
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Returns:
      The bytes for url.

    • getDescription

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

    • getDescriptionBytes

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

    • getModelsList

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

    • getModels

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

    • getModelsCount

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

    • getTotalRobotUsage

      long getTotalRobotUsage()
       The total number of robots using this module
      int64 total_robot_usage = 8 [json_name = "totalRobotUsage"];
      Returns:
      The totalRobotUsage.

    • getTotalOrganizationUsage

      long getTotalOrganizationUsage()
       The total number of organizations using this module
      int64 total_organization_usage = 9 [json_name = "totalOrganizationUsage"];
      Returns:
      The totalOrganizationUsage.

    • getOrganizationId

      String getOrganizationId()
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      com.google.protobuf.ByteString getOrganizationIdBytes()
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Returns:
      The bytes for organizationId.

    • getEntrypoint

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

    • getEntrypointBytes

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

    • getPublicNamespace

      String getPublicNamespace()
       The public namespace of the organization that owns the module
 This is empty if no public namespace is set
      string public_namespace = 12 [json_name = "publicNamespace"];
      Returns:
      The publicNamespace.

    • getPublicNamespaceBytes

      com.google.protobuf.ByteString getPublicNamespaceBytes()
       The public namespace of the organization that owns the module
 This is empty if no public namespace is set
      string public_namespace = 12 [json_name = "publicNamespace"];
      Returns:
      The bytes for publicNamespace.

    • hasFirstRun

      boolean hasFirstRun()
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 13 [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 = 13 [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 = 13 [json_name = "firstRun"];
      Returns:
      The bytes for firstRun.