Package com.buildless.authz

Class ApiKeyInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.buildless.authz.ApiKeyInfo
All Implemented Interfaces:
ApiKeyInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ApiKeyInfo extends com.google.protobuf.GeneratedMessageV3 implements ApiKeyInfoOrBuilder
 ## API Key Info

 Specifies information about a single API key record.
Protobuf type buildless.authz.ApiKeyInfo
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApiKeyInfo.Builder
    ## API Key Info Specifies information about a single API key record.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTIVE_FIELD_NUMBER
     
    static final int
    EXPIRES_AT_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    KEY_FIELD_NUMBER
     
    static final int
    LABEL_FIELD_NUMBER
     
    static final int
    PRIVILEGE_FIELD_NUMBER
     
    static final int
    REVOKED_AT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    boolean
    getActive()
    Whether this key is currently active.
    static ApiKeyInfo
    getDefaultInstance()
     
    ApiKeyInfo
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<ApiKeyInfo>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    boolean
    hasExpiresAt()
    Expiration of this key, if applicable.
    int
    hashCode()
     
    boolean
    hasRevokedAt()
    Revocation time of this key, if applicable.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ApiKeyInfo.Builder
    newBuilder()
     
    static ApiKeyInfo.Builder
    newBuilder(ApiKeyInfo prototype)
     
    ApiKeyInfo.Builder
    newBuilderForType()
     
    protected ApiKeyInfo.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ApiKeyInfo
    parseDelimitedFrom(InputStream input)
     
    static ApiKeyInfo
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyInfo
    parseFrom(byte[] data)
     
    static ApiKeyInfo
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyInfo
    parseFrom(com.google.protobuf.ByteString data)
     
    static ApiKeyInfo
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyInfo
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ApiKeyInfo
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyInfo
    parseFrom(InputStream input)
     
    static ApiKeyInfo
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyInfo
    parseFrom(ByteBuffer data)
     
    static ApiKeyInfo
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ApiKeyInfo>
    parser()
     
    ApiKeyInfo.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getId

      public 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];
      Specified by:
      getId in interface ApiKeyInfoOrBuilder
      Returns:
      The id.

    • getIdBytes

      public 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];
      Specified by:
      getIdBytes in interface ApiKeyInfoOrBuilder
      Returns:
      The bytes for id.

    • getKey

      public 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];
      Specified by:
      getKey in interface ApiKeyInfoOrBuilder
      Returns:
      The key.

    • getKeyBytes

      public 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];
      Specified by:
      getKeyBytes in interface ApiKeyInfoOrBuilder
      Returns:
      The bytes for key.

    • getLabel

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

    • getLabelBytes

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

    • getPrivilegeValue

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

    • getPrivilege

      public PrivilegeLevel getPrivilege()
       Privilege level for this key.
      .buildless.authz.PrivilegeLevel privilege = 4 [json_name = "privilege"];
      Specified by:
      getPrivilege in interface ApiKeyInfoOrBuilder
      Returns:
      The privilege.

    • getActive

      public boolean getActive()
       Whether this key is currently active.
      bool active = 5 [json_name = "active"];
      Specified by:
      getActive in interface ApiKeyInfoOrBuilder
      Returns:
      The active.

    • hasExpiresAt

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

    • getExpiresAt

      public 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];
      Specified by:
      getExpiresAt in interface ApiKeyInfoOrBuilder
      Returns:
      The expiresAt.

    • getExpiresAtOrBuilder

      public 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];
      Specified by:
      getExpiresAtOrBuilder in interface ApiKeyInfoOrBuilder

    • hasRevokedAt

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

    • getRevokedAt

      public 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];
      Specified by:
      getRevokedAt in interface ApiKeyInfoOrBuilder
      Returns:
      The revokedAt.

    • getRevokedAtOrBuilder

      public 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];
      Specified by:
      getRevokedAtOrBuilder in interface ApiKeyInfoOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ApiKeyInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ApiKeyInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ApiKeyInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ApiKeyInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ApiKeyInfo.Builder newBuilder()

    • newBuilder

      public static ApiKeyInfo.Builder newBuilder(ApiKeyInfo prototype)

    • toBuilder

      public ApiKeyInfo.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ApiKeyInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ApiKeyInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ApiKeyInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<ApiKeyInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ApiKeyInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder