Package viam.app.v1

Interface AppOuterClass.UpdateModuleRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AppOuterClass.App
    getApps(int index)
    A list of applications associated with the module
    int
    getAppsCount()
    A list of applications associated with the module
    List<AppOuterClass.App>
    getAppsList()
    A list of applications associated with the module
    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.
    String
    getMarkdownDescription()
    longer documentation provided in markdown format
    com.google.protobuf.ByteString
    getMarkdownDescriptionBytes()
    longer documentation provided in markdown format
    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
    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
    getUrl()
    The url to reference for documentation, code, etc.
    com.google.protobuf.ByteString
    getUrlBytes()
    The url to reference for documentation, code, etc.
    AppOuterClass.Visibility
    getVisibility()
    The visibility that should be set for the module
    int
    getVisibilityValue()
    The visibility that should be set for the module
    boolean
    hasFirstRun()
    The path to a setup script that is run before a newly downloaded module starts.
    boolean
    hasMarkdownDescription()
    longer documentation provided in markdown format

    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.

    • getVisibilityValue

      int getVisibilityValue()
       The visibility that should be set for the module
      .viam.app.v1.Visibility visibility = 2 [json_name = "visibility"];
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      AppOuterClass.Visibility getVisibility()
       The visibility that should be set for the module
      .viam.app.v1.Visibility visibility = 2 [json_name = "visibility"];
      Returns:
      The visibility.

    • getUrl

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

    • getUrlBytes

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

    • getDescription

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

    • getDescriptionBytes

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

    • getModelsList

      List<AppOuterClass.Model> getModelsList()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 5 [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 = 5 [json_name = "models"];

    • getModelsCount

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

    • getEntrypoint

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

    • getEntrypointBytes

      com.google.protobuf.ByteString getEntrypointBytes()
       The executable to run to start the module program
      string entrypoint = 6 [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 = 7 [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 = 7 [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 = 7 [json_name = "firstRun"];
      Returns:
      The bytes for firstRun.

    • getAppsList

      List<AppOuterClass.App> getAppsList()
       A list of applications associated with the module
      repeated .viam.app.v1.App apps = 8 [json_name = "apps"];

    • getApps

      AppOuterClass.App getApps(int index)
       A list of applications associated with the module
      repeated .viam.app.v1.App apps = 8 [json_name = "apps"];

    • getAppsCount

      int getAppsCount()
       A list of applications associated with the module
      repeated .viam.app.v1.App apps = 8 [json_name = "apps"];

    • hasMarkdownDescription

      boolean hasMarkdownDescription()
       longer documentation provided in markdown format
      optional string markdown_description = 9 [json_name = "markdownDescription"];
      Returns:
      Whether the markdownDescription field is set.

    • getMarkdownDescription

      String getMarkdownDescription()
       longer documentation provided in markdown format
      optional string markdown_description = 9 [json_name = "markdownDescription"];
      Returns:
      The markdownDescription.

    • getMarkdownDescriptionBytes

      com.google.protobuf.ByteString getMarkdownDescriptionBytes()
       longer documentation provided in markdown format
      optional string markdown_description = 9 [json_name = "markdownDescription"];
      Returns:
      The bytes for markdownDescription.