Package viam.app.v1

Interface AppOuterClass.RobotPartOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCreatedOn()
    .google.protobuf.Timestamp created_on = 13 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\""];
    String
    getDnsName()
    dns_name part name used for fqdn and local fqdn.
    com.google.protobuf.ByteString
    getDnsNameBytes()
    dns_name part name used for fqdn and local fqdn.
    String
    getFqdn()
    string fqdn = 9 [json_name = "fqdn"];
    com.google.protobuf.ByteString
    getFqdnBytes()
    string fqdn = 9 [json_name = "fqdn"];
    String
    getId()
    string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"_id\" json:\"id,omitempty\""];
    com.google.protobuf.ByteString
    getIdBytes()
    string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"_id\" json:\"id,omitempty\""];
    com.google.protobuf.Timestamp
    getLastAccess()
    .google.protobuf.Timestamp last_access = 6 [json_name = "lastAccess", (.tagger.v1.tags) = "bson:\"last_access\" json:\"last_access\""];
    com.google.protobuf.Timestamp
    getLastUpdated()
    latest timestamp when a robot part was updated
    String
    getLocalFqdn()
    string local_fqdn = 11 [json_name = "localFqdn"];
    com.google.protobuf.ByteString
    getLocalFqdnBytes()
    string local_fqdn = 11 [json_name = "localFqdn"];
    String
    getLocationId()
    Store the location_id to allow for unique indexes across parts and locations.
    com.google.protobuf.ByteString
    getLocationIdBytes()
    Store the location_id to allow for unique indexes across parts and locations.
    boolean
    getMainPart()
    bool main_part = 8 [json_name = "mainPart", (.tagger.v1.tags) = "bson:\"main_part\" json:\"main_part\""];
    String
    getName()
    string name = 2 [json_name = "name", (.tagger.v1.tags) = "bson:\"name\" json:\"name\""];
    com.google.protobuf.ByteString
    getNameBytes()
    string name = 2 [json_name = "name", (.tagger.v1.tags) = "bson:\"name\" json:\"name\""];
    String
    getRobot()
    string robot = 4 [json_name = "robot", (.tagger.v1.tags) = "bson:\"robot\" json:\"robot\""];
    com.google.protobuf.ByteString
    getRobotBytes()
    string robot = 4 [json_name = "robot", (.tagger.v1.tags) = "bson:\"robot\" json:\"robot\""];
    com.google.protobuf.Struct
    getRobotConfig()
    .google.protobuf.Struct robot_config = 5 [json_name = "robotConfig", (.tagger.v1.tags) = "bson:\"config\" json:\"robot_config\""];
    String
    getSecret()
    string secret = 3 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\" json:\"secret,omitempty\""];
    com.google.protobuf.ByteString
    getSecretBytes()
    string secret = 3 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\" json:\"secret,omitempty\""];
    AppOuterClass.SharedSecret
    getSecrets(int index)
    List of secrets allowed for authentication.
    int
    getSecretsCount()
    List of secrets allowed for authentication.
    List<AppOuterClass.SharedSecret>
    getSecretsList()
    List of secrets allowed for authentication.
    com.google.protobuf.Struct
    getUserSuppliedInfo()
    .google.protobuf.Struct user_supplied_info = 7 [json_name = "userSuppliedInfo", (.tagger.v1.tags) = "bson:\"user_supplied_info\" json:\"user_supplied_info\""];
    boolean
    hasCreatedOn()
    .google.protobuf.Timestamp created_on = 13 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\""];
    boolean
    hasLastAccess()
    .google.protobuf.Timestamp last_access = 6 [json_name = "lastAccess", (.tagger.v1.tags) = "bson:\"last_access\" json:\"last_access\""];
    boolean
    hasLastUpdated()
    latest timestamp when a robot part was updated
    boolean
    hasRobotConfig()
    .google.protobuf.Struct robot_config = 5 [json_name = "robotConfig", (.tagger.v1.tags) = "bson:\"config\" json:\"robot_config\""];
    boolean
    hasUserSuppliedInfo()
    .google.protobuf.Struct user_supplied_info = 7 [json_name = "userSuppliedInfo", (.tagger.v1.tags) = "bson:\"user_supplied_info\" json:\"user_supplied_info\""];

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getId

      String getId()
      string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"_id\" json:\"id,omitempty\""];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"_id\" json:\"id,omitempty\""];
      Returns:
      The bytes for id.

    • getName

      String getName()
      string name = 2 [json_name = "name", (.tagger.v1.tags) = "bson:\"name\" json:\"name\""];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
      string name = 2 [json_name = "name", (.tagger.v1.tags) = "bson:\"name\" json:\"name\""];
      Returns:
      The bytes for name.

    • getDnsName

      String getDnsName()
       dns_name part name used for fqdn and local fqdn. Anytime the Name is updated this should be sanitized and updated as well.
      string dns_name = 10 [json_name = "dnsName", (.tagger.v1.tags) = "bson:\"dns_name\" json:\"dns_name\""];
      Returns:
      The dnsName.

    • getDnsNameBytes

      com.google.protobuf.ByteString getDnsNameBytes()
       dns_name part name used for fqdn and local fqdn. Anytime the Name is updated this should be sanitized and updated as well.
      string dns_name = 10 [json_name = "dnsName", (.tagger.v1.tags) = "bson:\"dns_name\" json:\"dns_name\""];
      Returns:
      The bytes for dnsName.

    • getSecret

      String getSecret()
      string secret = 3 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\" json:\"secret,omitempty\""];
      Returns:
      The secret.

    • getSecretBytes

      com.google.protobuf.ByteString getSecretBytes()
      string secret = 3 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\" json:\"secret,omitempty\""];
      Returns:
      The bytes for secret.

    • getRobot

      String getRobot()
      string robot = 4 [json_name = "robot", (.tagger.v1.tags) = "bson:\"robot\" json:\"robot\""];
      Returns:
      The robot.

    • getRobotBytes

      com.google.protobuf.ByteString getRobotBytes()
      string robot = 4 [json_name = "robot", (.tagger.v1.tags) = "bson:\"robot\" json:\"robot\""];
      Returns:
      The bytes for robot.

    • getLocationId

      String getLocationId()
       Store the location_id to allow for unique indexes across parts and locations. This filed MUST be updated each time the robots location
 changes.
      string location_id = 12 [json_name = "locationId", (.tagger.v1.tags) = "bson:\"location_id\" json:\"-\""];
      Returns:
      The locationId.

    • getLocationIdBytes

      com.google.protobuf.ByteString getLocationIdBytes()
       Store the location_id to allow for unique indexes across parts and locations. This filed MUST be updated each time the robots location
 changes.
      string location_id = 12 [json_name = "locationId", (.tagger.v1.tags) = "bson:\"location_id\" json:\"-\""];
      Returns:
      The bytes for locationId.

    • hasRobotConfig

      boolean hasRobotConfig()
      .google.protobuf.Struct robot_config = 5 [json_name = "robotConfig", (.tagger.v1.tags) = "bson:\"config\" json:\"robot_config\""];
      Returns:
      Whether the robotConfig field is set.

    • getRobotConfig

      com.google.protobuf.Struct getRobotConfig()
      .google.protobuf.Struct robot_config = 5 [json_name = "robotConfig", (.tagger.v1.tags) = "bson:\"config\" json:\"robot_config\""];
      Returns:
      The robotConfig.

    • hasLastAccess

      boolean hasLastAccess()
      .google.protobuf.Timestamp last_access = 6 [json_name = "lastAccess", (.tagger.v1.tags) = "bson:\"last_access\" json:\"last_access\""];
      Returns:
      Whether the lastAccess field is set.

    • getLastAccess

      com.google.protobuf.Timestamp getLastAccess()
      .google.protobuf.Timestamp last_access = 6 [json_name = "lastAccess", (.tagger.v1.tags) = "bson:\"last_access\" json:\"last_access\""];
      Returns:
      The lastAccess.

    • hasUserSuppliedInfo

      boolean hasUserSuppliedInfo()
      .google.protobuf.Struct user_supplied_info = 7 [json_name = "userSuppliedInfo", (.tagger.v1.tags) = "bson:\"user_supplied_info\" json:\"user_supplied_info\""];
      Returns:
      Whether the userSuppliedInfo field is set.

    • getUserSuppliedInfo

      com.google.protobuf.Struct getUserSuppliedInfo()
      .google.protobuf.Struct user_supplied_info = 7 [json_name = "userSuppliedInfo", (.tagger.v1.tags) = "bson:\"user_supplied_info\" json:\"user_supplied_info\""];
      Returns:
      The userSuppliedInfo.

    • getMainPart

      boolean getMainPart()
      bool main_part = 8 [json_name = "mainPart", (.tagger.v1.tags) = "bson:\"main_part\" json:\"main_part\""];
      Returns:
      The mainPart.

    • getFqdn

      String getFqdn()
      string fqdn = 9 [json_name = "fqdn"];
      Returns:
      The fqdn.

    • getFqdnBytes

      com.google.protobuf.ByteString getFqdnBytes()
      string fqdn = 9 [json_name = "fqdn"];
      Returns:
      The bytes for fqdn.

    • getLocalFqdn

      String getLocalFqdn()
      string local_fqdn = 11 [json_name = "localFqdn"];
      Returns:
      The localFqdn.

    • getLocalFqdnBytes

      com.google.protobuf.ByteString getLocalFqdnBytes()
      string local_fqdn = 11 [json_name = "localFqdn"];
      Returns:
      The bytes for localFqdn.

    • hasCreatedOn

      boolean hasCreatedOn()
      .google.protobuf.Timestamp created_on = 13 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\""];
      Returns:
      Whether the createdOn field is set.

    • getCreatedOn

      com.google.protobuf.Timestamp getCreatedOn()
      .google.protobuf.Timestamp created_on = 13 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\""];
      Returns:
      The createdOn.

    • getSecretsList

      List<AppOuterClass.SharedSecret> getSecretsList()
       List of secrets allowed for authentication.
      repeated .viam.app.v1.SharedSecret secrets = 14 [json_name = "secrets", (.tagger.v1.tags) = "bson:\"secrets\""];

    • getSecrets

      AppOuterClass.SharedSecret getSecrets(int index)
       List of secrets allowed for authentication.
      repeated .viam.app.v1.SharedSecret secrets = 14 [json_name = "secrets", (.tagger.v1.tags) = "bson:\"secrets\""];

    • getSecretsCount

      int getSecretsCount()
       List of secrets allowed for authentication.
      repeated .viam.app.v1.SharedSecret secrets = 14 [json_name = "secrets", (.tagger.v1.tags) = "bson:\"secrets\""];

    • hasLastUpdated

      boolean hasLastUpdated()
       latest timestamp when a robot part was updated
      .google.protobuf.Timestamp last_updated = 15 [json_name = "lastUpdated", (.tagger.v1.tags) = "bson:\"last_updated_at\""];
      Returns:
      Whether the lastUpdated field is set.

    • getLastUpdated

      com.google.protobuf.Timestamp getLastUpdated()
       latest timestamp when a robot part was updated
      .google.protobuf.Timestamp last_updated = 15 [json_name = "lastUpdated", (.tagger.v1.tags) = "bson:\"last_updated_at\""];
      Returns:
      The lastUpdated.