Class AdminApiKey
-
- All Implemented Interfaces:
public final class AdminApiKeyRepresents an individual Admin API key in an org.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classAdminApiKey.BuilderA builder for AdminApiKey.
public final classAdminApiKey.Owner
-
Method Summary
Modifier and Type Method Description final Stringid()The identifier, which can be referenced in API endpoints final LongcreatedAt()The Unix timestamp (in seconds) of when the API key was created final JsonValue_object_()The object type, which is always organization.admin_api_keyExpected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("organization.admin_api_key")final AdminApiKey.Ownerowner()final StringredactedValue()The redacted value of the API key final Optional<Long>lastUsedAt()The Unix timestamp (in seconds) of when the API key was last used final Optional<String>name()The name of the API key final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_createdAt()Returns the raw JSON value of createdAt. final JsonField<AdminApiKey.Owner>_owner()Returns the raw JSON value of owner. final JsonField<String>_redactedValue()Returns the raw JSON value of redactedValue. final JsonField<Long>_lastUsedAt()Returns the raw JSON value of lastUsedAt. final JsonField<String>_name()Returns the raw JSON value of name. final Map<String, JsonValue>_additionalProperties()final AdminApiKey.BuildertoBuilder()final AdminApiKeyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AdminApiKey.Builderbuilder()Returns a mutable builder for constructing an instance of AdminApiKey. -
-
Method Detail
-
_object_
final JsonValue _object_()
The object type, which is always
organization.admin_api_keyExpected to always return the following:
JsonValue.from("organization.admin_api_key")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
owner
final AdminApiKey.Owner owner()
-
redactedValue
final String redactedValue()
The redacted value of the API key
-
lastUsedAt
final Optional<Long> lastUsedAt()
The Unix timestamp (in seconds) of when the API key was last used
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_owner
final JsonField<AdminApiKey.Owner> _owner()
Returns the raw JSON value of owner.
Unlike owner, this method doesn't throw if the JSON field has an unexpected type.
-
_redactedValue
final JsonField<String> _redactedValue()
Returns the raw JSON value of redactedValue.
Unlike redactedValue, this method doesn't throw if the JSON field has an unexpected type.
-
_lastUsedAt
final JsonField<Long> _lastUsedAt()
Returns the raw JSON value of lastUsedAt.
Unlike lastUsedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final AdminApiKey.Builder toBuilder()
-
validate
final AdminApiKey validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static AdminApiKey.Builder builder()
Returns a mutable builder for constructing an instance of AdminApiKey.
The following fields are required:
.id() .createdAt() .owner() .redactedValue()
-
-
-
-