Package com.buildless.authz

Interface ApiKeyInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ApiKeyInfo, ApiKeyInfo.Builder
public interface ApiKeyInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getActive()
    Whether this key is currently active.
    com.google.protobuf.Timestamp
    getExpiresAt()
    Expiration of this key, if applicable.
    com.google.protobuf.TimestampOrBuilder
    getExpiresAtOrBuilder()
    Expiration of this key, if applicable.
    String
    getId()
    Unique ID for the API key record being described.
    com.google.protobuf.ByteString
    getIdBytes()
    Unique ID for the API key record being described.
    String
    getKey()
    API key value; note that this value is masked with Base64.
    com.google.protobuf.ByteString
    getKeyBytes()
    API key value; note that this value is masked with Base64.
    String
    getLabel()
    Label to show for this API key.
    com.google.protobuf.ByteString
    getLabelBytes()
    Label to show for this API key.
    PrivilegeLevel
    getPrivilege()
    Privilege level for this key.
    int
    getPrivilegeValue()
    Privilege level for this key.
    com.google.protobuf.Timestamp
    getRevokedAt()
    Revocation time of this key, if applicable.
    com.google.protobuf.TimestampOrBuilder
    getRevokedAtOrBuilder()
    Revocation time of this key, if applicable.
    boolean
    hasExpiresAt()
    Expiration of this key, if applicable.
    boolean
    hasRevokedAt()
    Revocation time of this key, if applicable.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       Unique ID for the API key record being described.
      string id = 1 [json_name = "id", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Unique ID for the API key record being described.
      string id = 1 [json_name = "id", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for id.

    • getKey

      String getKey()
       API key value; note that this value is masked with Base64.
      string key = 2 [json_name = "key", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       API key value; note that this value is masked with Base64.
      string key = 2 [json_name = "key", (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for key.

    • getLabel

      String getLabel()
       Label to show for this API key.
      string label = 3 [json_name = "label", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
       Label to show for this API key.
      string label = 3 [json_name = "label", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for label.

    • getPrivilegeValue

      int getPrivilegeValue()
       Privilege level for this key.
      .buildless.authz.PrivilegeLevel privilege = 4 [json_name = "privilege"];
      Returns:
      The enum numeric value on the wire for privilege.

    • getPrivilege

      PrivilegeLevel getPrivilege()
       Privilege level for this key.
      .buildless.authz.PrivilegeLevel privilege = 4 [json_name = "privilege"];
      Returns:
      The privilege.

    • getActive

      boolean getActive()
       Whether this key is currently active.
      bool active = 5 [json_name = "active"];
      Returns:
      The active.

    • hasExpiresAt

      boolean hasExpiresAt()
       Expiration of this key, if applicable.
      .google.protobuf.Timestamp expires_at = 6 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the expiresAt field is set.

    • getExpiresAt

      com.google.protobuf.Timestamp getExpiresAt()
       Expiration of this key, if applicable.
      .google.protobuf.Timestamp expires_at = 6 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The expiresAt.

    • getExpiresAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpiresAtOrBuilder()
       Expiration of this key, if applicable.
      .google.protobuf.Timestamp expires_at = 6 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY];

    • hasRevokedAt

      boolean hasRevokedAt()
       Revocation time of this key, if applicable.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the revokedAt field is set.

    • getRevokedAt

      com.google.protobuf.Timestamp getRevokedAt()
       Revocation time of this key, if applicable.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The revokedAt.

    • getRevokedAtOrBuilder

      com.google.protobuf.TimestampOrBuilder getRevokedAtOrBuilder()
       Revocation time of this key, if applicable.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY];