Package ai.vectros.types

Class PingResponse.Builder

java.lang.Object

ai.vectros.types.PingResponse.Builder

All Implemented Interfaces:

PingResponse._FinalStage, PingResponse.EnvironmentStage, PingResponse.PrincipalKeyIdStage, PingResponse.PrincipalTypeStage, PingResponse.StatusStage, PingResponse.TenantIdStage

Enclosing class:

PingResponse

public static final class PingResponse.Builder
extends Object
implements PingResponse.StatusStage, PingResponse.TenantIdStage, PingResponse.EnvironmentStage, PingResponse.PrincipalTypeStage, PingResponse.PrincipalKeyIdStage, PingResponse._FinalStage

Method Summary

Modifier and Type	Method	Description
PingResponse.Builder	additionalProperties(Map<String,Object> additionalProperties)
PingResponse.Builder	additionalProperty(String key, Object value)
PingResponse._FinalStage	allowedActions(List<String> allowedActions)	The actions this credential is allowed to perform.
PingResponse._FinalStage	allowedActions(Optional<List<String>> allowedActions)	The actions this credential is allowed to perform.
PingResponse	build()
PingResponse._FinalStage	dataScope(DataScope dataScope)
PingResponse._FinalStage	dataScope(Optional<DataScope> dataScope)
PingResponse.PrincipalTypeStage	environment(@NotNull PingResponseEnvironment environment)	The environment that served this response.
PingResponse.Builder	from(PingResponse other)
PingResponse._FinalStage	principalKeyId(@NotNull String principalKeyId)	Stable identifier for your credential.
PingResponse._FinalStage	principalLabel(String principalLabel)	The label you set on the originating sk_* or ssk_* key.
PingResponse._FinalStage	principalLabel(Optional<String> principalLabel)	The label you set on the originating sk_* or ssk_* key.
PingResponse.PrincipalKeyIdStage	principalType(@NotNull PingResponsePrincipalType principalType)	The kind of credential you authenticated with: root_key = an unscoped sk_* API key; scoped_key = an ssk_* API key with a bound access profile; token = a short-lived st_* token (its expiry is in tokenExpiresAt).
PingResponse.TenantIdStage	status(@NotNull String status)	Always "ok" on a successful (2xx) response.
PingResponse.EnvironmentStage	tenantId(@NotNull String tenantId)	Identifier of the account this credential authenticates under.
PingResponse._FinalStage	tokenExpiresAt(Long tokenExpiresAt)	When the token expires, as seconds since the Unix epoch (mirrors the JWT exp claim).
PingResponse._FinalStage	tokenExpiresAt(Optional<Long> tokenExpiresAt)	When the token expires, as seconds since the Unix epoch (mirrors the JWT exp claim).

Methods inherited from class java.lang.Object

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

Method Details

from

public PingResponse.Builder from(PingResponse other)

Specified by:

from in interface PingResponse.StatusStage

status

public PingResponse.TenantIdStage status(@NotNull
 @NotNull String status)

Always "ok" on a successful (2xx) response. Failures are returned as a non-2xx status, so this value is never anything but "ok".

Always "ok" on a successful (2xx) response. Failures are returned as a non-2xx status, so this value is never anything but "ok".

Specified by:

status in interface PingResponse.StatusStage

Returns:

Reference to this so that method calls can be chained together.

tenantId

public PingResponse.EnvironmentStage tenantId(@NotNull
 @NotNull String tenantId)

Identifier of the account this credential authenticates under.

Identifier of the account this credential authenticates under.

Specified by:

tenantId in interface PingResponse.TenantIdStage

Returns:

Reference to this so that method calls can be chained together.

environment

public PingResponse.PrincipalTypeStage environment(@NotNull
 @NotNull PingResponseEnvironment environment)

The environment that served this response.

The environment that served this response.

Specified by:

environment in interface PingResponse.EnvironmentStage

Returns:

Reference to this so that method calls can be chained together.

principalType

public PingResponse.PrincipalKeyIdStage principalType(@NotNull
 @NotNull PingResponsePrincipalType principalType)

The kind of credential you authenticated with: root_key = an unscoped sk_* API key; scoped_key = an ssk_* API key with a bound access profile; token = a short-lived st_* token (its expiry is in tokenExpiresAt).

The kind of credential you authenticated with: root_key = an unscoped sk_* API key; scoped_key = an ssk_* API key with a bound access profile; token = a short-lived st_* token (its expiry is in tokenExpiresAt).

Specified by:

principalType in interface PingResponse.PrincipalTypeStage

Returns:

Reference to this so that method calls can be chained together.

principalKeyId

public PingResponse._FinalStage principalKeyId(@NotNull
 @NotNull String principalKeyId)

Stable identifier for your credential. For sk_* and ssk_* keys this is the key id; for st_* tokens it is the token's JWT id (jti).

Stable identifier for your credential. For sk_* and ssk_* keys this is the key id; for st_* tokens it is the token's JWT id (jti).

Specified by:

principalKeyId in interface PingResponse.PrincipalKeyIdStage

Returns:

Reference to this so that method calls can be chained together.

tokenExpiresAt

public PingResponse._FinalStage tokenExpiresAt(Long tokenExpiresAt)

When the token expires, as seconds since the Unix epoch (mirrors the JWT exp claim). Present only when principalType is token.

Specified by:

tokenExpiresAt in interface PingResponse._FinalStage

Returns:

Reference to this so that method calls can be chained together.

tokenExpiresAt

public PingResponse._FinalStage tokenExpiresAt(Optional<Long> tokenExpiresAt)

When the token expires, as seconds since the Unix epoch (mirrors the JWT exp claim). Present only when principalType is token.

Specified by:

tokenExpiresAt in interface PingResponse._FinalStage

dataScope

public PingResponse._FinalStage dataScope(DataScope dataScope)

Specified by:

dataScope in interface PingResponse._FinalStage

dataScope

public PingResponse._FinalStage dataScope(Optional<DataScope> dataScope)

Specified by:

dataScope in interface PingResponse._FinalStage

allowedActions

public PingResponse._FinalStage allowedActions(List<String> allowedActions)

The actions this credential is allowed to perform. Present only when principalType is scoped_key.

Specified by:

allowedActions in interface PingResponse._FinalStage

Returns:

Reference to this so that method calls can be chained together.

allowedActions

public PingResponse._FinalStage allowedActions(Optional<List<String>> allowedActions)

The actions this credential is allowed to perform. Present only when principalType is scoped_key.

Specified by:

allowedActions in interface PingResponse._FinalStage

principalLabel

public PingResponse._FinalStage principalLabel(String principalLabel)

The label you set on the originating sk_* or ssk_* key. Omitted when no label is set, or when the credential is an st_* token.

Specified by:

principalLabel in interface PingResponse._FinalStage

Returns:

Reference to this so that method calls can be chained together.

principalLabel

public PingResponse._FinalStage principalLabel(Optional<String> principalLabel)

The label you set on the originating sk_* or ssk_* key. Omitted when no label is set, or when the credential is an st_* token.

Specified by:

principalLabel in interface PingResponse._FinalStage

build

public PingResponse build()

Specified by:

build in interface PingResponse._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface PingResponse._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface PingResponse._FinalStage