Package ai.vectros.types

Class ScopedKeyResponse.Builder

java.lang.Object

ai.vectros.types.ScopedKeyResponse.Builder

Enclosing class:

ScopedKeyResponse

public static final class ScopedKeyResponse.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ScopedKeyResponse.Builder	accessProfileRef(String accessProfileRef)
ScopedKeyResponse.Builder	accessProfileRef(Optional<String> accessProfileRef)	Reference to the bound access profile, in the form tenant#context#usr_user (the user segment carries the usr_ prefix).
ScopedKeyResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
ScopedKeyResponse.Builder	additionalProperty(String key, Object value)
ScopedKeyResponse	build()
ScopedKeyResponse.Builder	contextId(String contextId)
ScopedKeyResponse.Builder	contextId(Optional<String> contextId)	The app context the key is bound to.
ScopedKeyResponse.Builder	createdAt(String createdAt)
ScopedKeyResponse.Builder	createdAt(Optional<String> createdAt)	When the key was created, as an ISO-8601 UTC timestamp.
ScopedKeyResponse.Builder	from(ScopedKeyResponse other)
ScopedKeyResponse.Builder	keyId(String keyId)
ScopedKeyResponse.Builder	keyId(Optional<String> keyId)	Server-generated identifier for the key, stable for its entire lifetime.
ScopedKeyResponse.Builder	keyName(String keyName)
ScopedKeyResponse.Builder	keyName(Optional<String> keyName)	The human-readable name you gave the key when creating it.
ScopedKeyResponse.Builder	keyType(ScopedKeyResponseKeyType keyType)
ScopedKeyResponse.Builder	keyType(Optional<ScopedKeyResponseKeyType> keyType)	Always scoped for keys created through this endpoint.
ScopedKeyResponse.Builder	label(String label)
ScopedKeyResponse.Builder	label(Optional<String> label)	Optional display label for the key, surfaced through /v1/ping as principalLabel.
ScopedKeyResponse.Builder	lastUsedAt(String lastUsedAt)
ScopedKeyResponse.Builder	lastUsedAt(Optional<String> lastUsedAt)	When the key was most recently used, as an ISO-8601 UTC timestamp.
ScopedKeyResponse.Builder	rawKey(String rawKey)
ScopedKeyResponse.Builder	rawKey(Optional<String> rawKey)	The raw secret key.
ScopedKeyResponse.Builder	revokedAt(String revokedAt)
ScopedKeyResponse.Builder	revokedAt(Optional<String> revokedAt)	When the key was revoked, as an ISO-8601 UTC timestamp.
ScopedKeyResponse.Builder	status(ScopedKeyResponseStatus status)
ScopedKeyResponse.Builder	status(Optional<ScopedKeyResponseStatus> status)	The key's lifecycle status: active or revoked.
ScopedKeyResponse.Builder	tenantId(String tenantId)
ScopedKeyResponse.Builder	tenantId(Optional<String> tenantId)	The tenant the key operates on — either your live or your test environment.
ScopedKeyResponse.Builder	userId(String userId)
ScopedKeyResponse.Builder	userId(Optional<String> userId)	The user the key acts as.
ScopedKeyResponse.Builder	userType(ScopedKeyResponseUserType userType)
ScopedKeyResponse.Builder	userType(Optional<ScopedKeyResponseUserType> userType)	The bound user's type: HUMAN or SERVICE.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public ScopedKeyResponse.Builder from(ScopedKeyResponse other)

keyId

public ScopedKeyResponse.Builder keyId(Optional<String> keyId)

Server-generated identifier for the key, stable for its entire lifetime. Pass this in the URL path of the get and revoke endpoints.

keyId

public ScopedKeyResponse.Builder keyId(String keyId)

rawKey

public ScopedKeyResponse.Builder rawKey(Optional<String> rawKey)

The raw secret key. Returned ONLY in the response to creating the key; all subsequent reads omit this field. Treat it as a sensitive credential and store it securely.

rawKey

public ScopedKeyResponse.Builder rawKey(String rawKey)

keyName

public ScopedKeyResponse.Builder keyName(Optional<String> keyName)

The human-readable name you gave the key when creating it.

keyName

public ScopedKeyResponse.Builder keyName(String keyName)

label

public ScopedKeyResponse.Builder label(Optional<String> label)

Optional display label for the key, surfaced through /v1/ping as principalLabel. Omitted when no label was set.

label

public ScopedKeyResponse.Builder label(String label)

tenantId

public ScopedKeyResponse.Builder tenantId(Optional<String> tenantId)

The tenant the key operates on — either your live or your test environment.

tenantId

public ScopedKeyResponse.Builder tenantId(String tenantId)

contextId

public ScopedKeyResponse.Builder contextId(Optional<String> contextId)

The app context the key is bound to.

contextId

public ScopedKeyResponse.Builder contextId(String contextId)

userId

public ScopedKeyResponse.Builder userId(Optional<String> userId)

The user the key acts as. This is the same user ID used by the /v1/users endpoints.

userId

public ScopedKeyResponse.Builder userId(String userId)

userType

public ScopedKeyResponse.Builder userType(Optional<ScopedKeyResponseUserType> userType)

The bound user's type: HUMAN or SERVICE. Included as a convenience for filtering in admin interfaces.

userType

public ScopedKeyResponse.Builder userType(ScopedKeyResponseUserType userType)

status

public ScopedKeyResponse.Builder status(Optional<ScopedKeyResponseStatus> status)

The key's lifecycle status: active or revoked.

status

public ScopedKeyResponse.Builder status(ScopedKeyResponseStatus status)

keyType

public ScopedKeyResponse.Builder keyType(Optional<ScopedKeyResponseKeyType> keyType)

Always scoped for keys created through this endpoint. The field exists so this response shape can also represent unscoped (sk_*) keys.

keyType

public ScopedKeyResponse.Builder keyType(ScopedKeyResponseKeyType keyType)

accessProfileRef

public ScopedKeyResponse.Builder accessProfileRef(Optional<String> accessProfileRef)

Reference to the bound access profile, in the form tenant#context#usr_user (the user segment carries the usr_ prefix). Useful for cross-referencing the profile via /v1/app-contexts/{contextId}/profiles/{principalId}.

accessProfileRef

public ScopedKeyResponse.Builder accessProfileRef(String accessProfileRef)

createdAt

public ScopedKeyResponse.Builder createdAt(Optional<String> createdAt)

When the key was created, as an ISO-8601 UTC timestamp.

createdAt

public ScopedKeyResponse.Builder createdAt(String createdAt)

revokedAt

public ScopedKeyResponse.Builder revokedAt(Optional<String> revokedAt)

When the key was revoked, as an ISO-8601 UTC timestamp. Present only on revoked keys.

revokedAt

public ScopedKeyResponse.Builder revokedAt(String revokedAt)

lastUsedAt

public ScopedKeyResponse.Builder lastUsedAt(Optional<String> lastUsedAt)

When the key was most recently used, as an ISO-8601 UTC timestamp. This value is coarse (updated at most about once an hour) and best-effort. Null if the key has not been used since usage tracking began.

lastUsedAt

public ScopedKeyResponse.Builder lastUsedAt(String lastUsedAt)

build

public ScopedKeyResponse build()

additionalProperty

public ScopedKeyResponse.Builder additionalProperty(String key,
 Object value)

additionalProperties

public ScopedKeyResponse.Builder additionalProperties(Map<String,Object> additionalProperties)