Package viam.app.v1

Class App.Module.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<App.Module,App.Module.Builder>
viam.app.v1.App.Module.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable, App.ModuleOrBuilder
Enclosing class:
App.Module
public static final class App.Module.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<App.Module,App.Module.Builder> implements App.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 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.

    • setModuleId

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

    • setName

      public App.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 App.Module.Builder clearName()
       The name of the module
      string name = 2 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

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

    • setVisibilityValue

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

    • setVisibility

      public App.Module.Builder setVisibility(App.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 App.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<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

    • 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

    • setVersions

      public App.Module.Builder setVersions(int index, App.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 App.Module.Builder setVersions(int index, App.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 App.Module.Builder addVersions(App.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 App.Module.Builder addVersions(int index, App.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 App.Module.Builder addVersions(App.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 App.Module.Builder addVersions(int index, App.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 App.Module.Builder addAllVersions(Iterable<? extends App.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 App.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 App.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 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.

    • setUrl

      public App.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 App.Module.Builder clearUrl()
       The url to reference for documentation, code, etc.
      string url = 5 [json_name = "url"];
      Returns:
      This builder for chaining.

    • setUrlBytes

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

    • setDescription

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

    • 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

    • setModels

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

    • setModels

      public App.Module.Builder setModels(int index, App.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 App.Module.Builder addModels(App.Model value)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • addModels

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

    • addModels

      public App.Module.Builder addModels(App.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 App.Module.Builder addModels(int index, App.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 App.Module.Builder addAllModels(Iterable<? extends App.Model> values)
       A list of models that are available in the module
      repeated .viam.app.v1.Model models = 7 [json_name = "models"];

    • clearModels

      public App.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 App.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 App.ModuleOrBuilder
      Returns:
      The totalRobotUsage.

    • setTotalRobotUsage

      public App.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 App.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 App.ModuleOrBuilder
      Returns:
      The totalOrganizationUsage.

    • setTotalOrganizationUsage

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

    • setOrganizationId

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

    • setEntrypoint

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

    • setPublicNamespace

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

    • setFirstRun

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