Package viam.app.v1

Class AppOuterClass.Module.Builder

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

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

    • setModuleId

      public AppOuterClass.Module.Builder setModuleId(String value)
       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"];
      Parameters:
      value - The moduleId to set.
      Returns:
      This builder for chaining.

    • clearModuleId

      public AppOuterClass.Module.Builder clearModuleId()
       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:
      This builder for chaining.

    • setModuleIdBytes

      public AppOuterClass.Module.Builder setModuleIdBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for moduleId to set.
      Returns:
      This builder for chaining.

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

    • setName

      public AppOuterClass.Module.Builder setName(String value)
       The name of the module
      string name = 2 [json_name = "name"];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public AppOuterClass.Module.Builder clearName()
       The name of the module
      string name = 2 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

      public AppOuterClass.Module.Builder setNameBytes(com.google.protobuf.ByteString value)
       The name of the module
      string name = 2 [json_name = "name"];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setVisibilityValue

      public AppOuterClass.Module.Builder setVisibilityValue(int value)
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Parameters:
      value - The visibility to set.
      Returns:
      This builder for chaining.

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

    • setVisibility

      public AppOuterClass.Module.Builder setVisibility(AppOuterClass.Visibility value)
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Parameters:
      value - The enum numeric value on the wire for visibility to set.
      Returns:
      This builder for chaining.

    • clearVisibility

      public AppOuterClass.Module.Builder clearVisibility()
       The visibility of the module
      .viam.app.v1.Visibility visibility = 3 [json_name = "visibility"];
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setVersions

      public AppOuterClass.Module.Builder setVersions(int index, AppOuterClass.VersionHistory value)
       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"];

    • setVersions

      public AppOuterClass.Module.Builder setVersions(int index, AppOuterClass.VersionHistory.Builder builderForValue)
       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"];

    • addVersions

      public AppOuterClass.Module.Builder addVersions(AppOuterClass.VersionHistory value)
       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"];

    • addVersions

      public AppOuterClass.Module.Builder addVersions(int index, AppOuterClass.VersionHistory value)
       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"];

    • addVersions

      public AppOuterClass.Module.Builder addVersions(AppOuterClass.VersionHistory.Builder builderForValue)
       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"];

    • addVersions

      public AppOuterClass.Module.Builder addVersions(int index, AppOuterClass.VersionHistory.Builder builderForValue)
       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"];

    • addAllVersions

      public AppOuterClass.Module.Builder addAllVersions(Iterable<? extends AppOuterClass.VersionHistory> values)
       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"];

    • clearVersions

      public AppOuterClass.Module.Builder clearVersions()
       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"];

    • removeVersions

      public AppOuterClass.Module.Builder removeVersions(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.

    • setUrl

      public AppOuterClass.Module.Builder setUrl(String value)
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Parameters:
      value - The url to set.
      Returns:
      This builder for chaining.

    • clearUrl

      public AppOuterClass.Module.Builder clearUrl()
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Returns:
      This builder for chaining.

    • setUrlBytes

      public AppOuterClass.Module.Builder setUrlBytes(com.google.protobuf.ByteString value)
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Parameters:
      value - The bytes for url to set.
      Returns:
      This builder for chaining.

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

    • setDescription

      public AppOuterClass.Module.Builder setDescription(String value)
       A short description of the module that explains its purpose
      string description = 6 [json_name = "description"];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public AppOuterClass.Module.Builder clearDescription()
       A short description of the module that explains its purpose
      string description = 6 [json_name = "description"];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public AppOuterClass.Module.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       A short description of the module that explains its purpose
      string description = 6 [json_name = "description"];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setModels

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

    • setModels

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

    • addModels

      public AppOuterClass.Module.Builder addModels(AppOuterClass.Model value)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • addModels

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

    • addModels

      public AppOuterClass.Module.Builder addModels(AppOuterClass.Model.Builder builderForValue)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • addModels

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

    • addAllModels

      public AppOuterClass.Module.Builder addAllModels(Iterable<? extends AppOuterClass.Model> values)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • clearModels

      public AppOuterClass.Module.Builder clearModels()
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • removeModels

      public AppOuterClass.Module.Builder removeModels(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.

    • setTotalRobotUsage

      public AppOuterClass.Module.Builder setTotalRobotUsage(long value)
       The total number of robots using this module
      int64 total_robot_usage = 8 [json_name = "totalRobotUsage"];
      Parameters:
      value - The totalRobotUsage to set.
      Returns:
      This builder for chaining.

    • clearTotalRobotUsage

      public AppOuterClass.Module.Builder clearTotalRobotUsage()
       The total number of robots using this module
      int64 total_robot_usage = 8 [json_name = "totalRobotUsage"];
      Returns:
      This builder for chaining.

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

    • setTotalOrganizationUsage

      public AppOuterClass.Module.Builder setTotalOrganizationUsage(long value)
       The total number of organizations using this module
      int64 total_organization_usage = 9 [json_name = "totalOrganizationUsage"];
      Parameters:
      value - The totalOrganizationUsage to set.
      Returns:
      This builder for chaining.

    • clearTotalOrganizationUsage

      public AppOuterClass.Module.Builder clearTotalOrganizationUsage()
       The total number of organizations using this module
      int64 total_organization_usage = 9 [json_name = "totalOrganizationUsage"];
      Returns:
      This builder for chaining.

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

    • setOrganizationId

      public AppOuterClass.Module.Builder setOrganizationId(String value)
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Parameters:
      value - The organizationId to set.
      Returns:
      This builder for chaining.

    • clearOrganizationId

      public AppOuterClass.Module.Builder clearOrganizationId()
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Returns:
      This builder for chaining.

    • setOrganizationIdBytes

      public AppOuterClass.Module.Builder setOrganizationIdBytes(com.google.protobuf.ByteString value)
       The id of the organization that owns the module
      string organization_id = 10 [json_name = "organizationId"];
      Parameters:
      value - The bytes for organizationId to set.
      Returns:
      This builder for chaining.

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

    • setEntrypoint

      public AppOuterClass.Module.Builder setEntrypoint(String value)
       The executable to run to start the module program
      string entrypoint = 11 [json_name = "entrypoint"];
      Parameters:
      value - The entrypoint to set.
      Returns:
      This builder for chaining.

    • clearEntrypoint

      public AppOuterClass.Module.Builder clearEntrypoint()
       The executable to run to start the module program
      string entrypoint = 11 [json_name = "entrypoint"];
      Returns:
      This builder for chaining.

    • setEntrypointBytes

      public AppOuterClass.Module.Builder setEntrypointBytes(com.google.protobuf.ByteString value)
       The executable to run to start the module program
      string entrypoint = 11 [json_name = "entrypoint"];
      Parameters:
      value - The bytes for entrypoint to set.
      Returns:
      This builder for chaining.

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

    • setPublicNamespace

      public AppOuterClass.Module.Builder setPublicNamespace(String value)
       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"];
      Parameters:
      value - The publicNamespace to set.
      Returns:
      This builder for chaining.

    • clearPublicNamespace

      public AppOuterClass.Module.Builder clearPublicNamespace()
       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:
      This builder for chaining.

    • setPublicNamespaceBytes

      public AppOuterClass.Module.Builder setPublicNamespaceBytes(com.google.protobuf.ByteString value)
       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"];
      Parameters:
      value - The bytes for publicNamespace to set.
      Returns:
      This builder for chaining.

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

    • setFirstRun

      public AppOuterClass.Module.Builder setFirstRun(String value)
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 13 [json_name = "firstRun"];
      Parameters:
      value - The firstRun to set.
      Returns:
      This builder for chaining.

    • clearFirstRun

      public AppOuterClass.Module.Builder clearFirstRun()
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 13 [json_name = "firstRun"];
      Returns:
      This builder for chaining.

    • setFirstRunBytes

      public AppOuterClass.Module.Builder setFirstRunBytes(com.google.protobuf.ByteString value)
       The path to a setup script that is run before a newly downloaded module starts.
      optional string first_run = 13 [json_name = "firstRun"];
      Parameters:
      value - The bytes for firstRun to set.
      Returns:
      This builder for chaining.

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

    • setMarkdownDescription

      public AppOuterClass.Module.Builder setMarkdownDescription(String value)
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Parameters:
      value - The markdownDescription to set.
      Returns:
      This builder for chaining.

    • clearMarkdownDescription

      public AppOuterClass.Module.Builder clearMarkdownDescription()
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Returns:
      This builder for chaining.

    • setMarkdownDescriptionBytes

      public AppOuterClass.Module.Builder setMarkdownDescriptionBytes(com.google.protobuf.ByteString value)
       Longer documentation provided in markdown format
      optional string markdown_description = 14 [json_name = "markdownDescription"];
      Parameters:
      value - The bytes for markdownDescription to set.
      Returns:
      This builder for chaining.