Package viam.app.v1

Class App.Module

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    App.Module.Builder
    Protobuf type viam.app.v1.Module

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    ENTRYPOINT_FIELD_NUMBER
     
    static final int
    FIRST_RUN_FIELD_NUMBER
     
    static final int
    MODELS_FIELD_NUMBER
     
    static final int
    MODULE_ID_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    ORGANIZATION_ID_FIELD_NUMBER
     
    static final int
    PUBLIC_NAMESPACE_FIELD_NUMBER
     
    static final int
    TOTAL_ORGANIZATION_USAGE_FIELD_NUMBER
     
    static final int
    TOTAL_ROBOT_USAGE_FIELD_NUMBER
     
    static final int
    URL_FIELD_NUMBER
     
    static final int
    VERSIONS_FIELD_NUMBER
     
    static final int
    VISIBILITY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static App.Module
    getDefaultInstance()
     
    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
    App.ModelOrBuilder
    getModelsOrBuilder(int index)
    A list of models that are available in the module
    List<? extends App.ModelOrBuilder>
    getModelsOrBuilderList()
    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.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
    List<? extends App.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
    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.
    static App.Module.Builder
    newBuilder()
     
    static App.Module.Builder
    newBuilder(App.Module prototype)
     
    static App.Module
    parseDelimitedFrom(InputStream input)
     
    static App.Module
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static App.Module
    parseFrom(byte[] data)
     
    static App.Module
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static App.Module
    parseFrom(com.google.protobuf.ByteString data)
     
    static App.Module
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static App.Module
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static App.Module
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static App.Module
    parseFrom(InputStream input)
     
    static App.Module
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static App.Module
    parseFrom(ByteBuffer data)
     
    static App.Module
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<App.Module>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • 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:

  • 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 App.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 App.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 App.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 App.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 App.ModuleOrBuilder
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

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

    • getVersionsList

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

    • getVersionsOrBuilderList

      public List<? extends App.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 App.ModuleOrBuilder

    • getVersions

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

    • getVersionsOrBuilder

      public App.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 App.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 App.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 App.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 App.ModuleOrBuilder
      Returns:
      The bytes for description.

    • getModelsList

      public List<App.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 App.ModuleOrBuilder

    • getModelsOrBuilderList

      public List<? extends App.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 App.ModuleOrBuilder

    • getModels

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

    • getModelsOrBuilder

      public App.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 App.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 App.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 App.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 App.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 App.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 App.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 App.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 App.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 App.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 App.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 App.ModuleOrBuilder
      Returns:
      The bytes for firstRun.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static App.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 App.Module parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static App.Module.Builder newBuilder()

    • newBuilder

      public static App.Module.Builder newBuilder(App.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<App.Module,App.Module.Builder>

    • getDefaultInstance

      public static App.Module getDefaultInstance()

    • parser

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