Package ai.vectros.types

Class AccessProfileRequest.Builder

java.lang.Object

ai.vectros.types.AccessProfileRequest.Builder

All Implemented Interfaces:

AccessProfileRequest._FinalStage, AccessProfileRequest.PrincipalIdStage

Enclosing class:

AccessProfileRequest

public static final class AccessProfileRequest.Builder
extends Object
implements AccessProfileRequest.PrincipalIdStage, AccessProfileRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
AccessProfileRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
AccessProfileRequest.Builder	additionalProperty(String key, Object value)
AccessProfileRequest	build()
AccessProfileRequest.Builder	from(AccessProfileRequest other)
AccessProfileRequest._FinalStage	identityOverrides(Map<String,Object> identityOverrides)	Optional per-context identity overrides.
AccessProfileRequest._FinalStage	identityOverrides(Optional<Map<String,Object>> identityOverrides)	Optional per-context identity overrides.
AccessProfileRequest._FinalStage	principalId(@NotNull String principalId)	Principal this profile applies to.
AccessProfileRequest._FinalStage	roleId(String roleId)	Reference to a role within the same context that supplies this principal's scopes.
AccessProfileRequest._FinalStage	roleId(Optional<String> roleId)	Reference to a role within the same context that supplies this principal's scopes.
AccessProfileRequest._FinalStage	scopes(List<ScopeClause> scopes)	Inline scope clauses to grant the principal.
AccessProfileRequest._FinalStage	scopes(Optional<List<ScopeClause>> scopes)	Inline scope clauses to grant the principal.
AccessProfileRequest._FinalStage	status(AccessProfileRequestStatus status)	Profile lifecycle status.
AccessProfileRequest._FinalStage	status(Optional<AccessProfileRequestStatus> status)	Profile lifecycle status.

Methods inherited from class java.lang.Object

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

Method Details

from

public AccessProfileRequest.Builder from(AccessProfileRequest other)

Specified by:

from in interface AccessProfileRequest.PrincipalIdStage

principalId

public AccessProfileRequest._FinalStage principalId(@NotNull
 @NotNull String principalId)

Principal this profile applies to. Must start with usr_ (an authenticated user — the suffix is the user id) or key_ (a scoped API key acting as its own principal — the suffix is the key id). The suffix may contain only letters, digits, underscores, and hyphens. Required when creating (POST); ignored when updating (PUT), where it is taken from the path.

Principal this profile applies to. Must start with usr_ (an authenticated user — the suffix is the user id) or key_ (a scoped API key acting as its own principal — the suffix is the key id). The suffix may contain only letters, digits, underscores, and hyphens. Required when creating (POST); ignored when updating (PUT), where it is taken from the path.

Specified by:

principalId in interface AccessProfileRequest.PrincipalIdStage

Returns:

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

status

public AccessProfileRequest._FinalStage status(AccessProfileRequestStatus status)

Profile lifecycle status. active permits token minting; suspended denies it (minting returns a uniform 403). Defaults to active when omitted.

Specified by:

status in interface AccessProfileRequest._FinalStage

Returns:

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

status

public AccessProfileRequest._FinalStage status(Optional<AccessProfileRequestStatus> status)

Profile lifecycle status. active permits token minting; suspended denies it (minting returns a uniform 403). Defaults to active when omitted.

Specified by:

status in interface AccessProfileRequest._FinalStage

identityOverrides

public AccessProfileRequest._FinalStage identityOverrides(Map<String,Object> identityOverrides)

Optional per-context identity overrides. Only orgId and clientId may be overridden; any other key is rejected. An empty or omitted map applies no overrides — the base identity from the user or key record is used as-is.

Specified by:

identityOverrides in interface AccessProfileRequest._FinalStage

Returns:

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

identityOverrides

public AccessProfileRequest._FinalStage identityOverrides(Optional<Map<String,Object>> identityOverrides)

Optional per-context identity overrides. Only orgId and clientId may be overridden; any other key is rejected. An empty or omitted map applies no overrides — the base identity from the user or key record is used as-is.

Specified by:

identityOverrides in interface AccessProfileRequest._FinalStage

roleId

public AccessProfileRequest._FinalStage roleId(String roleId)

Reference to a role within the same context that supplies this principal's scopes. Provide exactly one of scopes or roleId — setting both, or neither, returns a 400. Changes to the role's scopes take effect for all referencing profiles.

Specified by:

roleId in interface AccessProfileRequest._FinalStage

Returns:

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

roleId

public AccessProfileRequest._FinalStage roleId(Optional<String> roleId)

Reference to a role within the same context that supplies this principal's scopes. Provide exactly one of scopes or roleId — setting both, or neither, returns a 400. Changes to the role's scopes take effect for all referencing profiles.

Specified by:

roleId in interface AccessProfileRequest._FinalStage

scopes

public AccessProfileRequest._FinalStage scopes(List<ScopeClause> scopes)

Inline scope clauses to grant the principal. Provide exactly one of scopes or roleId — setting both, or neither, returns a 400.

Specified by:

scopes in interface AccessProfileRequest._FinalStage

Returns:

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

scopes

public AccessProfileRequest._FinalStage scopes(Optional<List<ScopeClause>> scopes)

Inline scope clauses to grant the principal. Provide exactly one of scopes or roleId — setting both, or neither, returns a 400.

Specified by:

scopes in interface AccessProfileRequest._FinalStage

build

public AccessProfileRequest build()

Specified by:

build in interface AccessProfileRequest._FinalStage

additionalProperty

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

Specified by:

additionalProperty in interface AccessProfileRequest._FinalStage

additionalProperties

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

Specified by:

additionalProperties in interface AccessProfileRequest._FinalStage