Package com.buildless.projects

Class Credentials.ProjectApiKey

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.buildless.projects.Credentials.ProjectApiKey
All Implemented Interfaces:
Credentials.ProjectApiKeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Credentials
public static final class Credentials.ProjectApiKey extends com.google.protobuf.GeneratedMessageV3 implements Credentials.ProjectApiKeyOrBuilder
 ### Project API Key

 Describes an API key provisioned under the scope of a Buildless project. When a project is created, an API key is
 issued which identifies the project and enables certain access or permissions based on project settings. Such keys
 *only* grant access to objects accessible through the project.
Protobuf type buildless.projects.Credentials.ProjectApiKey
See Also:

  • 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

    • hasApikey

      public boolean hasApikey()
       Describes information for the primary API key in this project API key bundle. The "primary" API key is used to
 authorize regular operations performed against Buildless APIs, and the main Buildless service.
      .buildless.authz.ApiKeyInfo apikey = 1 [json_name = "apikey", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasApikey in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the apikey field is set.

    • getApikey

      public ApiKeyInfo getApikey()
       Describes information for the primary API key in this project API key bundle. The "primary" API key is used to
 authorize regular operations performed against Buildless APIs, and the main Buildless service.
      .buildless.authz.ApiKeyInfo apikey = 1 [json_name = "apikey", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getApikey in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The apikey.

    • getApikeyOrBuilder

      public ApiKeyInfoOrBuilder getApikeyOrBuilder()
       Describes information for the primary API key in this project API key bundle. The "primary" API key is used to
 authorize regular operations performed against Buildless APIs, and the main Buildless service.
      .buildless.authz.ApiKeyInfo apikey = 1 [json_name = "apikey", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getApikeyOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasEvents

      public boolean hasEvents()
       Describes information for the events API key in this project API key bundle. The "events" key is a special API
 key with write-only privileges, which can be used to safely write telemetry (only), even from anonymous users.
      .buildless.authz.ApiKeyInfo events = 2 [json_name = "events", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasEvents in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the events field is set.

    • getEvents

      public ApiKeyInfo getEvents()
       Describes information for the events API key in this project API key bundle. The "events" key is a special API
 key with write-only privileges, which can be used to safely write telemetry (only), even from anonymous users.
      .buildless.authz.ApiKeyInfo events = 2 [json_name = "events", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEvents in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The events.

    • getEventsOrBuilder

      public ApiKeyInfoOrBuilder getEventsOrBuilder()
       Describes information for the events API key in this project API key bundle. The "events" key is a special API
 key with write-only privileges, which can be used to safely write telemetry (only), even from anonymous users.
      .buildless.authz.ApiKeyInfo events = 2 [json_name = "events", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getEventsOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasHooks

      public boolean hasHooks()
       Describes information for the hooks key in this project API key bundle; the "hooks" key is used as a shared
 secret which can authenticate webhook payloads delivered within the scope of the applicable project.
      .buildless.authz.ApiKeyInfo hooks = 3 [json_name = "hooks", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasHooks in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the hooks field is set.

    • getHooks

      public ApiKeyInfo getHooks()
       Describes information for the hooks key in this project API key bundle; the "hooks" key is used as a shared
 secret which can authenticate webhook payloads delivered within the scope of the applicable project.
      .buildless.authz.ApiKeyInfo hooks = 3 [json_name = "hooks", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHooks in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The hooks.

    • getHooksOrBuilder

      public ApiKeyInfoOrBuilder getHooksOrBuilder()
       Describes information for the hooks key in this project API key bundle; the "hooks" key is used as a shared
 secret which can authenticate webhook payloads delivered within the scope of the applicable project.
      .buildless.authz.ApiKeyInfo hooks = 3 [json_name = "hooks", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHooksOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • getDescription

      public String getDescription()
       Display description which is listed along with this key; this is a user-provided value which may be updated
 after the key has been provisioned.
      string description = 4 [json_name = "description", (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Display description which is listed along with this key; this is a user-provided value which may be updated
 after the key has been provisioned.
      string description = 4 [json_name = "description", (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The bytes for description.

    • getRevoked

      public boolean getRevoked()
       Specifies whether this key has been revoked. Revoked keys cannot be used to authenticate requests. Keys can be
 revoked at any time by any authorized user with requisite permissions.
      bool revoked = 5 [json_name = "revoked", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRevoked in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The revoked.

    • hasRevokedBy

      public boolean hasRevokedBy()
       Specifies information about the user who revoked this key. This field is only filled in if `revoked` is set to
 `true`, and only if the key was revoked by a user, rather than the system itself.
      .buildless.accounts.UserReference revoked_by = 6 [json_name = "revokedBy", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRevokedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the revokedBy field is set.

    • getRevokedBy

      public UserReference getRevokedBy()
       Specifies information about the user who revoked this key. This field is only filled in if `revoked` is set to
 `true`, and only if the key was revoked by a user, rather than the system itself.
      .buildless.accounts.UserReference revoked_by = 6 [json_name = "revokedBy", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRevokedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The revokedBy.

    • getRevokedByOrBuilder

      public UserReferenceOrBuilder getRevokedByOrBuilder()
       Specifies information about the user who revoked this key. This field is only filled in if `revoked` is set to
 `true`, and only if the key was revoked by a user, rather than the system itself.
      .buildless.accounts.UserReference revoked_by = 6 [json_name = "revokedBy", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRevokedByOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasRevokedAt

      public boolean hasRevokedAt()
       Specifies the moment at which this key was revoked. This field is only filled in if `revoked` is set to `true`.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRevokedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the revokedAt field is set.

    • getRevokedAt

      public com.google.protobuf.Timestamp getRevokedAt()
       Specifies the moment at which this key was revoked. This field is only filled in if `revoked` is set to `true`.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRevokedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The revokedAt.

    • getRevokedAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getRevokedAtOrBuilder()
       Specifies the moment at which this key was revoked. This field is only filled in if `revoked` is set to `true`.
      .google.protobuf.Timestamp revoked_at = 7 [json_name = "revokedAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRevokedAtOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasExpiresAt

      public boolean hasExpiresAt()
       Specifies the moment at which this key expires. This field is only filled in if the key has an expiration time.
 If a key expires due to system activity (a normal expiration period elapses), the `revoked` flag is set with no
 `revoked_by` value, indicating that the Buildless service retired the key.
      .google.protobuf.Timestamp expires_at = 8 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExpiresAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the expiresAt field is set.

    • getExpiresAt

      public com.google.protobuf.Timestamp getExpiresAt()
       Specifies the moment at which this key expires. This field is only filled in if the key has an expiration time.
 If a key expires due to system activity (a normal expiration period elapses), the `revoked` flag is set with no
 `revoked_by` value, indicating that the Buildless service retired the key.
      .google.protobuf.Timestamp expires_at = 8 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpiresAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The expiresAt.

    • getExpiresAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getExpiresAtOrBuilder()
       Specifies the moment at which this key expires. This field is only filled in if the key has an expiration time.
 If a key expires due to system activity (a normal expiration period elapses), the `revoked` flag is set with no
 `revoked_by` value, indicating that the Buildless service retired the key.
      .google.protobuf.Timestamp expires_at = 8 [json_name = "expiresAt", (.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpiresAtOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasUpdatedBy

      public boolean hasUpdatedBy()
       Specifies information about the user who last updated this key.
      .buildless.accounts.UserReference updated_by = 96 [json_name = "updatedBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdatedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the updatedBy field is set.

    • getUpdatedBy

      public UserReference getUpdatedBy()
       Specifies information about the user who last updated this key.
      .buildless.accounts.UserReference updated_by = 96 [json_name = "updatedBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdatedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The updatedBy.

    • getUpdatedByOrBuilder

      public UserReferenceOrBuilder getUpdatedByOrBuilder()
       Specifies information about the user who last updated this key.
      .buildless.accounts.UserReference updated_by = 96 [json_name = "updatedBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdatedByOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasUpdatedAt

      public boolean hasUpdatedAt()
       Specifies the last time this key was updated. Changes with each update to the key record.
      .google.protobuf.Timestamp updated_at = 97 [json_name = "updatedAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdatedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      public com.google.protobuf.Timestamp getUpdatedAt()
       Specifies the last time this key was updated. Changes with each update to the key record.
      .google.protobuf.Timestamp updated_at = 97 [json_name = "updatedAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdatedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The updatedAt.

    • getUpdatedAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdatedAtOrBuilder()
       Specifies the last time this key was updated. Changes with each update to the key record.
      .google.protobuf.Timestamp updated_at = 97 [json_name = "updatedAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdatedAtOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasCreatedBy

      public boolean hasCreatedBy()
       Specifies information about the user who created this key. If the key was created by the system, this field is
 not filled in. The initial key for a project is created by the system.
      .buildless.accounts.UserReference created_by = 98 [json_name = "createdBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreatedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the createdBy field is set.

    • getCreatedBy

      public UserReference getCreatedBy()
       Specifies information about the user who created this key. If the key was created by the system, this field is
 not filled in. The initial key for a project is created by the system.
      .buildless.accounts.UserReference created_by = 98 [json_name = "createdBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreatedBy in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The createdBy.

    • getCreatedByOrBuilder

      public UserReferenceOrBuilder getCreatedByOrBuilder()
       Specifies information about the user who created this key. If the key was created by the system, this field is
 not filled in. The initial key for a project is created by the system.
      .buildless.accounts.UserReference created_by = 98 [json_name = "createdBy", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreatedByOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • hasCreatedAt

      public boolean hasCreatedAt()
       Specifies the moment at which this key was originally created. Does not change over the lifecycle of the key.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreatedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      Whether the createdAt field is set.

    • getCreatedAt

      public com.google.protobuf.Timestamp getCreatedAt()
       Specifies the moment at which this key was originally created. Does not change over the lifecycle of the key.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreatedAt in interface Credentials.ProjectApiKeyOrBuilder
      Returns:
      The createdAt.

    • getCreatedAtOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder()
       Specifies the moment at which this key was originally created. Does not change over the lifecycle of the key.
      .google.protobuf.Timestamp created_at = 99 [json_name = "createdAt", (.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreatedAtOrBuilder in interface Credentials.ProjectApiKeyOrBuilder

    • 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 Credentials.ProjectApiKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Credentials.ProjectApiKey parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Credentials.ProjectApiKey parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Credentials.ProjectApiKey.Builder newBuilder()

    • newBuilder

      public static Credentials.ProjectApiKey.Builder newBuilder(Credentials.ProjectApiKey prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Credentials.ProjectApiKey getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Credentials.ProjectApiKey> 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 Credentials.ProjectApiKey getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder