Package viam.app.v1

Interface AppOuterClass.RegistryItemOrBuilder

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

  • Method Details

    • getItemId

      String getItemId()
       The id of the item, containing either:
 namespace:item_name when a namespace exists on the org.
 org_id:item_name when a namespace does not exist.
      string item_id = 1 [json_name = "itemId"];
      Returns:
      The itemId.

    • getItemIdBytes

      com.google.protobuf.ByteString getItemIdBytes()
       The id of the item, containing either:
 namespace:item_name when a namespace exists on the org.
 org_id:item_name when a namespace does not exist.
      string item_id = 1 [json_name = "itemId"];
      Returns:
      The bytes for itemId.

    • getOrganizationId

      String getOrganizationId()
       The id of the organization that owns the item
      string organization_id = 2 [json_name = "organizationId"];
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      com.google.protobuf.ByteString getOrganizationIdBytes()
       The id of the organization that owns the item
      string organization_id = 2 [json_name = "organizationId"];
      Returns:
      The bytes for organizationId.

    • getPublicNamespace

      String getPublicNamespace()
       The public namespace of the organization that owns the module
 This is empty if no public namespace is set
      string public_namespace = 3 [json_name = "publicNamespace"];
      Returns:
      The publicNamespace.

    • getPublicNamespaceBytes

      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 = 3 [json_name = "publicNamespace"];
      Returns:
      The bytes for publicNamespace.

    • getName

      String getName()
       The name of the registry item
      string name = 4 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the registry item
      string name = 4 [json_name = "name"];
      Returns:
      The bytes for name.

    • getTypeValue

      int getTypeValue()
       The type of the item in the registry
      .viam.app.packages.v1.PackageType type = 5 [json_name = "type"];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Packages.PackageType getType()
       The type of the item in the registry
      .viam.app.packages.v1.PackageType type = 5 [json_name = "type"];
      Returns:
      The type.

    • getVisibilityValue

      int getVisibilityValue()
       The visibility of the registry item
      .viam.app.v1.Visibility visibility = 6 [json_name = "visibility"];
      Returns:
      The enum numeric value on the wire for visibility.

    • getVisibility

      AppOuterClass.Visibility getVisibility()
       The visibility of the registry item
      .viam.app.v1.Visibility visibility = 6 [json_name = "visibility"];
      Returns:
      The visibility.

    • getUrl

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

    • getUrlBytes

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

    • getDescription

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

    • getDescriptionBytes

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

    • getTotalRobotUsage

      long getTotalRobotUsage()
       The total number of robots using this item
      int64 total_robot_usage = 9 [json_name = "totalRobotUsage"];
      Returns:
      The totalRobotUsage.

    • getTotalExternalRobotUsage

      long getTotalExternalRobotUsage()
       The total number of robots using this item outside of the owning org
      int64 total_external_robot_usage = 13 [json_name = "totalExternalRobotUsage"];
      Returns:
      The totalExternalRobotUsage.

    • getTotalOrganizationUsage

      long getTotalOrganizationUsage()
       The total number of organizations using this item
      int64 total_organization_usage = 10 [json_name = "totalOrganizationUsage"];
      Returns:
      The totalOrganizationUsage.

    • getTotalExternalOrganizationUsage

      long getTotalExternalOrganizationUsage()
       The total number of organizations using this item outside of the owning org
      int64 total_external_organization_usage = 14 [json_name = "totalExternalOrganizationUsage"];
      Returns:
      The totalExternalOrganizationUsage.

    • hasModuleMetadata

      boolean hasModuleMetadata()
      .viam.app.v1.ModuleMetadata module_metadata = 11 [json_name = "moduleMetadata"];
      Returns:
      Whether the moduleMetadata field is set.

    • getModuleMetadata

      AppOuterClass.ModuleMetadata getModuleMetadata()
      .viam.app.v1.ModuleMetadata module_metadata = 11 [json_name = "moduleMetadata"];
      Returns:
      The moduleMetadata.

    • hasMlModelMetadata

      boolean hasMlModelMetadata()
      .viam.app.v1.MLModelMetadata ml_model_metadata = 12 [json_name = "mlModelMetadata"];
      Returns:
      Whether the mlModelMetadata field is set.

    • getMlModelMetadata

      AppOuterClass.MLModelMetadata getMlModelMetadata()
      .viam.app.v1.MLModelMetadata ml_model_metadata = 12 [json_name = "mlModelMetadata"];
      Returns:
      The mlModelMetadata.

    • hasMlTrainingMetadata

      boolean hasMlTrainingMetadata()
      .viam.app.v1.MLTrainingMetadata ml_training_metadata = 18 [json_name = "mlTrainingMetadata"];
      Returns:
      Whether the mlTrainingMetadata field is set.

    • getMlTrainingMetadata

      AppOuterClass.MLTrainingMetadata getMlTrainingMetadata()
      .viam.app.v1.MLTrainingMetadata ml_training_metadata = 18 [json_name = "mlTrainingMetadata"];
      Returns:
      The mlTrainingMetadata.

    • hasCreatedAt

      boolean hasCreatedAt()
       When the item was created
      .google.protobuf.Timestamp created_at = 15 [json_name = "createdAt"];
      Returns:
      Whether the createdAt field is set.

    • getCreatedAt

      com.google.protobuf.Timestamp getCreatedAt()
       When the item was created
      .google.protobuf.Timestamp created_at = 15 [json_name = "createdAt"];
      Returns:
      The createdAt.

    • hasUpdatedAt

      boolean hasUpdatedAt()
       When the item was last updated, either through an update or upload.
      .google.protobuf.Timestamp updated_at = 16 [json_name = "updatedAt"];
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      com.google.protobuf.Timestamp getUpdatedAt()
       When the item was last updated, either through an update or upload.
      .google.protobuf.Timestamp updated_at = 16 [json_name = "updatedAt"];
      Returns:
      The updatedAt.

    • hasDeprecatedStatus

      boolean hasDeprecatedStatus()
       Whether the item is deprecated
      optional .viam.app.v1.DeprecatedStatus deprecated_status = 17 [json_name = "deprecatedStatus"];
      Returns:
      Whether the deprecatedStatus field is set.

    • getDeprecatedStatus

      AppOuterClass.DeprecatedStatus getDeprecatedStatus()
       Whether the item is deprecated
      optional .viam.app.v1.DeprecatedStatus deprecated_status = 17 [json_name = "deprecatedStatus"];
      Returns:
      The deprecatedStatus.

    • hasBilling

      boolean hasBilling()
       Usage cost information used by billing jobs to bill for monthly usage of the item.
 This is unset when no cost has been configured for the item.
      optional .viam.app.v1.RegistryItemBilling billing = 19 [json_name = "billing"];
      Returns:
      Whether the billing field is set.

    • getBilling

      AppOuterClass.RegistryItemBilling getBilling()
       Usage cost information used by billing jobs to bill for monthly usage of the item.
 This is unset when no cost has been configured for the item.
      optional .viam.app.v1.RegistryItemBilling billing = 19 [json_name = "billing"];
      Returns:
      The billing.

    • getMetadataCase

      AppOuterClass.RegistryItem.MetadataCase getMetadataCase()