Package viam.app.v1

Class AppOuterClass.Module

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<AppOuterClass.Module,AppOuterClass.Module.Builder>
viam.app.v1.AppOuterClass.Module
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, AppOuterClass.ModuleOrBuilder
Enclosing class:
AppOuterClass
public static final class AppOuterClass.Module extends com.google.protobuf.GeneratedMessageLite<AppOuterClass.Module,AppOuterClass.Module.Builder> implements AppOuterClass.ModuleOrBuilder
Protobuf type viam.app.v1.Module

  • Field Details

    • MODULE_ID_FIELD_NUMBER

      public static final int MODULE_ID_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • VISIBILITY_FIELD_NUMBER

      public static final int VISIBILITY_FIELD_NUMBER
      See Also:

    • VERSIONS_FIELD_NUMBER

      public static final int VERSIONS_FIELD_NUMBER
      See Also:

    • URL_FIELD_NUMBER

      public static final int URL_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • MODELS_FIELD_NUMBER

      public static final int MODELS_FIELD_NUMBER
      See Also:

    • TOTAL_ROBOT_USAGE_FIELD_NUMBER

      public static final int TOTAL_ROBOT_USAGE_FIELD_NUMBER
      See Also:

    • TOTAL_ORGANIZATION_USAGE_FIELD_NUMBER

      public static final int TOTAL_ORGANIZATION_USAGE_FIELD_NUMBER
      See Also:

    • ORGANIZATION_ID_FIELD_NUMBER

      public static final int ORGANIZATION_ID_FIELD_NUMBER
      See Also:

    • ENTRYPOINT_FIELD_NUMBER

      public static final int ENTRYPOINT_FIELD_NUMBER
      See Also:

    • PUBLIC_NAMESPACE_FIELD_NUMBER

      public static final int PUBLIC_NAMESPACE_FIELD_NUMBER
      See Also:

    • FIRST_RUN_FIELD_NUMBER

      public static final int FIRST_RUN_FIELD_NUMBER
      See Also:

    • MARKDOWN_DESCRIPTION_FIELD_NUMBER

      public static final int MARKDOWN_DESCRIPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getModuleId

      public 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"];
      Specified by:
      getModuleId in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The moduleId.

    • getModuleIdBytes

      public 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"];
      Specified by:
      getModuleIdBytes in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The bytes for moduleId.

    • getName

      public String getName()
       The name of the module
      string name = 2 [json_name = "name"];
      Specified by:
      getName in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the module
      string name = 2 [json_name = "name"];
      Specified by:
      getNameBytes in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The bytes for name.

    • getVisibilityValue

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

    • getVisibility

      public AppOuterClass.Visibility getVisibility()
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Specified by:
      getVisibility in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The visibility.

    • getVersionsList

      public List<AppOuterClass.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"];
      Specified by:
      getVersionsList in interface AppOuterClass.ModuleOrBuilder

    • getVersionsOrBuilderList

      public List<? extends AppOuterClass.VersionHistoryOrBuilder> getVersionsOrBuilderList()
       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

      public 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"];
      Specified by:
      getVersionsCount in interface AppOuterClass.ModuleOrBuilder

    • getVersions

      public AppOuterClass.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"];
      Specified by:
      getVersions in interface AppOuterClass.ModuleOrBuilder

    • getVersionsOrBuilder

      public AppOuterClass.VersionHistoryOrBuilder getVersionsOrBuilder(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"];

    • getUrl

      public String getUrl()
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Specified by:
      getUrl in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The url.

    • getUrlBytes

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

    • getDescription

      public String getDescription()
       A short description of the module that explains its purpose
      string description = 6 [json_name = "description"];
      Specified by:
      getDescription in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

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

    • getModelsList

      public List<AppOuterClass.Model> getModelsList()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];
      Specified by:
      getModelsList in interface AppOuterClass.ModuleOrBuilder

    • getModelsOrBuilderList

      public List<? extends AppOuterClass.ModelOrBuilder> getModelsOrBuilderList()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • getModelsCount

      public int getModelsCount()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];
      Specified by:
      getModelsCount in interface AppOuterClass.ModuleOrBuilder

    • getModels

      public AppOuterClass.Model getModels(int index)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];
      Specified by:
      getModels in interface AppOuterClass.ModuleOrBuilder

    • getModelsOrBuilder

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

    • getTotalRobotUsage

      public long getTotalRobotUsage()
       The total number of robots using this module
      int64 total_robot_usage = 8 [json_name = "totalRobotUsage"];
      Specified by:
      getTotalRobotUsage in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The totalRobotUsage.

    • getTotalOrganizationUsage

      public long getTotalOrganizationUsage()
       The total number of organizations using this module
      int64 total_organization_usage = 9 [json_name = "totalOrganizationUsage"];
      Specified by:
      getTotalOrganizationUsage in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The totalOrganizationUsage.

    • getOrganizationId

      public String getOrganizationId()
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Specified by:
      getOrganizationId in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The organizationId.

    • getOrganizationIdBytes

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

    • getEntrypoint

      public String getEntrypoint()
       The executable to run to start the module program
      string entrypoint = 11 [json_name = "entrypoint"];
      Specified by:
      getEntrypoint in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The entrypoint.

    • getEntrypointBytes

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

    • getPublicNamespace

      public 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"];
      Specified by:
      getPublicNamespace in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The publicNamespace.

    • getPublicNamespaceBytes

      public 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"];
      Specified by:
      getPublicNamespaceBytes in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The bytes for publicNamespace.

    • hasFirstRun

      public 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"];
      Specified by:
      hasFirstRun in interface AppOuterClass.ModuleOrBuilder
      Returns:
      Whether the firstRun field is set.

    • getFirstRun

      public 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"];
      Specified by:
      getFirstRun in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The firstRun.

    • getFirstRunBytes

      public 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"];
      Specified by:
      getFirstRunBytes in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The bytes for firstRun.

    • hasMarkdownDescription

      public boolean hasMarkdownDescription()
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Specified by:
      hasMarkdownDescription in interface AppOuterClass.ModuleOrBuilder
      Returns:
      Whether the markdownDescription field is set.

    • getMarkdownDescription

      public String getMarkdownDescription()
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Specified by:
      getMarkdownDescription in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The markdownDescription.

    • getMarkdownDescriptionBytes

      public com.google.protobuf.ByteString getMarkdownDescriptionBytes()
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Specified by:
      getMarkdownDescriptionBytes in interface AppOuterClass.ModuleOrBuilder
      Returns:
      The bytes for markdownDescription.

    • parseFrom

      public static AppOuterClass.Module parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AppOuterClass.Module parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AppOuterClass.Module parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AppOuterClass.Module parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AppOuterClass.Module parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AppOuterClass.Module parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AppOuterClass.Module parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static AppOuterClass.Module.Builder newBuilder()

    • newBuilder

      public static AppOuterClass.Module.Builder newBuilder(AppOuterClass.Module prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<AppOuterClass.Module,AppOuterClass.Module.Builder>

    • getDefaultInstance

      public static AppOuterClass.Module getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AppOuterClass.Module> parser()