Package com.buildless.projects

Interface Credentials.ProjectApiKeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Credentials.ProjectApiKey, Credentials.ProjectApiKey.Builder
Enclosing class:
Credentials
public static interface Credentials.ProjectApiKeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ApiKeyInfo
    getApikey()
    Describes information for the primary API key in this project API key bundle.
    ApiKeyInfoOrBuilder
    getApikeyOrBuilder()
    Describes information for the primary API key in this project API key bundle.
    com.google.protobuf.Timestamp
    getCreatedAt()
    Specifies the moment at which this key was originally created.
    com.google.protobuf.TimestampOrBuilder
    getCreatedAtOrBuilder()
    Specifies the moment at which this key was originally created.
    UserReference
    getCreatedBy()
    Specifies information about the user who created this key.
    UserReferenceOrBuilder
    getCreatedByOrBuilder()
    Specifies information about the user who created this key.
    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.
    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.
    ApiKeyInfo
    getEvents()
    Describes information for the events API key in this project API key bundle.
    ApiKeyInfoOrBuilder
    getEventsOrBuilder()
    Describes information for the events API key in this project API key bundle.
    com.google.protobuf.Timestamp
    getExpiresAt()
    Specifies the moment at which this key expires.
    com.google.protobuf.TimestampOrBuilder
    getExpiresAtOrBuilder()
    Specifies the moment at which this key expires.
    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.
    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.
    boolean
    getRevoked()
    Specifies whether this key has been revoked.
    com.google.protobuf.Timestamp
    getRevokedAt()
    Specifies the moment at which this key was revoked.
    com.google.protobuf.TimestampOrBuilder
    getRevokedAtOrBuilder()
    Specifies the moment at which this key was revoked.
    UserReference
    getRevokedBy()
    Specifies information about the user who revoked this key.
    UserReferenceOrBuilder
    getRevokedByOrBuilder()
    Specifies information about the user who revoked this key.
    com.google.protobuf.Timestamp
    getUpdatedAt()
    Specifies the last time this key was updated.
    com.google.protobuf.TimestampOrBuilder
    getUpdatedAtOrBuilder()
    Specifies the last time this key was updated.
    UserReference
    getUpdatedBy()
    Specifies information about the user who last updated this key.
    UserReferenceOrBuilder
    getUpdatedByOrBuilder()
    Specifies information about the user who last updated this key.
    boolean
    hasApikey()
    Describes information for the primary API key in this project API key bundle.
    boolean
    hasCreatedAt()
    Specifies the moment at which this key was originally created.
    boolean
    hasCreatedBy()
    Specifies information about the user who created this key.
    boolean
    hasEvents()
    Describes information for the events API key in this project API key bundle.
    boolean
    hasExpiresAt()
    Specifies the moment at which this key expires.
    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.
    boolean
    hasRevokedAt()
    Specifies the moment at which this key was revoked.
    boolean
    hasRevokedBy()
    Specifies information about the user who revoked this key.
    boolean
    hasUpdatedAt()
    Specifies the last time this key was updated.
    boolean
    hasUpdatedBy()
    Specifies information about the user who last updated this key.

    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

    • hasApikey

      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];
      Returns:
      Whether the apikey field is set.

    • getApikey

      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];
      Returns:
      The apikey.

    • getApikeyOrBuilder

      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];

    • hasEvents

      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];
      Returns:
      Whether the events field is set.

    • getEvents

      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];
      Returns:
      The events.

    • getEventsOrBuilder

      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];

    • hasHooks

      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];
      Returns:
      Whether the hooks field is set.

    • getHooks

      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];
      Returns:
      The hooks.

    • getHooksOrBuilder

      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];

    • getDescription

      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];
      Returns:
      The description.

    • getDescriptionBytes

      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];
      Returns:
      The bytes for description.

    • getRevoked

      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];
      Returns:
      The revoked.

    • hasRevokedBy

      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];
      Returns:
      Whether the revokedBy field is set.

    • getRevokedBy

      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];
      Returns:
      The revokedBy.

    • getRevokedByOrBuilder

      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];

    • hasRevokedAt

      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];
      Returns:
      Whether the revokedAt field is set.

    • getRevokedAt

      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];
      Returns:
      The revokedAt.

    • getRevokedAtOrBuilder

      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];

    • hasExpiresAt

      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];
      Returns:
      Whether the expiresAt field is set.

    • getExpiresAt

      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];
      Returns:
      The expiresAt.

    • getExpiresAtOrBuilder

      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];

    • hasUpdatedBy

      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];
      Returns:
      Whether the updatedBy field is set.

    • getUpdatedBy

      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];
      Returns:
      The updatedBy.

    • getUpdatedByOrBuilder

      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];

    • hasUpdatedAt

      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];
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      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];
      Returns:
      The updatedAt.

    • getUpdatedAtOrBuilder

      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];

    • hasCreatedBy

      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];
      Returns:
      Whether the createdBy field is set.

    • getCreatedBy

      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];
      Returns:
      The createdBy.

    • getCreatedByOrBuilder

      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];

    • hasCreatedAt

      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];
      Returns:
      Whether the createdAt field is set.

    • getCreatedAt

      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];
      Returns:
      The createdAt.

    • getCreatedAtOrBuilder

      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];