Package viam.app.v1

Interface App.SharedSecretOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
App.SharedSecret, App.SharedSecret.Builder
Enclosing class:
App
public static interface App.SharedSecretOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCreatedOn()
    Date/time the secret was first created.
    String
    getId()
    string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"id\""];
    com.google.protobuf.ByteString
    getIdBytes()
    string id = 1 [json_name = "id", (.tagger.v1.tags) = "bson:\"id\""];
    String
    getSecret()
    The payload of the secret.
    com.google.protobuf.ByteString
    getSecretBytes()
    The payload of the secret.
    App.SharedSecret.State
    getState()
    State of the shared secret.
    int
    getStateValue()
    State of the shared secret.
    boolean
    hasCreatedOn()
    Date/time the secret was first created.

    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\""];
      Returns:
      The id.

    • getIdBytes

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

    • getSecret

      String getSecret()
       The payload of the secret. Used during authentication to the rpc framework.
      string secret = 2 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\""];
      Returns:
      The secret.

    • getSecretBytes

      com.google.protobuf.ByteString getSecretBytes()
       The payload of the secret. Used during authentication to the rpc framework.
      string secret = 2 [json_name = "secret", (.tagger.v1.tags) = "bson:\"secret\""];
      Returns:
      The bytes for secret.

    • hasCreatedOn

      boolean hasCreatedOn()
       Date/time the secret was first created.
      .google.protobuf.Timestamp created_on = 3 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\" json:\"created_on\""];
      Returns:
      Whether the createdOn field is set.

    • getCreatedOn

      com.google.protobuf.Timestamp getCreatedOn()
       Date/time the secret was first created.
      .google.protobuf.Timestamp created_on = 3 [json_name = "createdOn", (.tagger.v1.tags) = "bson:\"created_on\" json:\"created_on\""];
      Returns:
      The createdOn.

    • getStateValue

      int getStateValue()
       State of the shared secret. In most cases it should be enabled. We may support
 disabling a specific secret while keeping it in the database.
      .viam.app.v1.SharedSecret.State state = 4 [json_name = "state", (.tagger.v1.tags) = "bson:\"state\""];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      App.SharedSecret.State getState()
       State of the shared secret. In most cases it should be enabled. We may support
 disabling a specific secret while keeping it in the database.
      .viam.app.v1.SharedSecret.State state = 4 [json_name = "state", (.tagger.v1.tags) = "bson:\"state\""];
      Returns:
      The state.