Package com.atlan.model.admin

Class ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder

java.lang.Object

com.atlan.model.admin.ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder

Enclosing class:

ApiToken.ApiTokenAttributes

public static class ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	accessToken(String accessToken)	The actual API token that can be used as a bearer token.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	accessTokenLifespan(Long accessTokenLifespan)	Time, in seconds, from createdAt after which the token will expire.
ApiToken.ApiTokenAttributes	build()
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	clearPersonas()
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	clearWorkspacePermissions()
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	clientId(String clientId)	Unique client identifier (GUID) of the API token.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	createdAt(Long createdAt)	Epoch time, in milliseconds, at which the API token was created.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	createdBy(String createdBy)	User who created the API token.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	description(String description)	Explanation of the API token.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	displayName(String displayName)	Human-readable name provided when creating the token.
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	persona(ApiToken.ApiTokenPersona persona)
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	personas(Collection<? extends ApiToken.ApiTokenPersona> personas)
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	purposes(String purposes)	Deprecated.
String	toString()
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	workspacePermission(String workspacePermission)
ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder	workspacePermissions(Collection<? extends String> workspacePermissions)

Methods inherited from class java.lang.Object

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

Method Details

accessTokenLifespan

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder accessTokenLifespan(Long accessTokenLifespan)

Time, in seconds, from createdAt after which the token will expire.

Returns:

this.

accessToken

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder accessToken(String accessToken)

The actual API token that can be used as a bearer token.

Returns:

this.

clientId

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder clientId(String clientId)

Unique client identifier (GUID) of the API token.

Returns:

this.

createdAt

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder createdAt(Long createdAt)

Epoch time, in milliseconds, at which the API token was created.

Returns:

this.

createdBy

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder createdBy(String createdBy)

User who created the API token.

Returns:

this.

description

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder description(String description)

Explanation of the API token.

Returns:

this.

displayName

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder displayName(String displayName)

Human-readable name provided when creating the token.

Returns:

this.

persona

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder persona(ApiToken.ApiTokenPersona persona)

personas

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder personas(Collection<? extends ApiToken.ApiTokenPersona> personas)

clearPersonas

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder clearPersonas()

purposes

@Deprecated
public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder purposes(String purposes)

Deprecated.

This was a possible future placeholder for purposes associated with the token, but no longer exists on payloads. It is left here purely for any existing code that may have referenced it, but should be removed from that code as it will be removed in the next major release from this object.

Returns:

this.

workspacePermission

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder workspacePermission(String workspacePermission)

workspacePermissions

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder workspacePermissions(Collection<? extends String> workspacePermissions)

clearWorkspacePermissions

public ApiToken.ApiTokenAttributes.ApiTokenAttributesBuilder clearWorkspacePermissions()

build

public ApiToken.ApiTokenAttributes build()

toString

public String toString()

Overrides:

toString in class Object