com.contentful.java.cma.model

Class CMAApiKey

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMAApiKey

public class CMAApiKey
extends CMAResource

Class representing api keys created.

Constructor Summary

Constructors

Constructor and Description
CMAApiKey() Create a new api key.

Method Summary

Modifier and Type	Method and Description
CMAApiKey	addEnvironment(String environment) Add environment ids to the api key.
String	getAccessToken()
String	getDescription()
List<CMALink>	getEnvironments()
String	getName()
CMALink	getPreviewApiKey()
CMAApiKey	setAccessToken(String accessToken)
CMAApiKey	setDescription(String description) Update the description of this key.
CMAApiKey	setName(String name) Update the name of the key.
CMAApiKey	setPreviewApiKey(CMALink previewApiKey)
String	toString()

Methods inherited from class com.contentful.java.cma.model.CMAResource

getEnvironmentId, getId, getSpaceId, getSystem, getVersion, getVisibility, isArchived, isPublished, setEnvironmentId, setId, setSpaceId, setSystem, setVersion, setVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAApiKey

public CMAApiKey()

Create a new api key.

Method Detail

getName

public String getName()

Returns:

What is the name of this key?

setName

public CMAApiKey setName(String name)

Update the name of the key.

Parameters:

name - new name to be used.

Returns:

this instance for ease of chaining.

getDescription

public String getDescription()

Returns:

the description of this key.

setDescription

public CMAApiKey setDescription(String description)

Update the description of this key.

Parameters:

description - to be changed to.

Returns:

this instance for chaining.

getAccessToken

public String getAccessToken()

Returns:

readonly api access token for this key.

setAccessToken

public CMAApiKey setAccessToken(String accessToken)

getPreviewApiKey

public CMALink getPreviewApiKey()

Returns:

readonly preview api key part.

setPreviewApiKey

public CMAApiKey setPreviewApiKey(CMALink previewApiKey)

getEnvironments

public List<CMALink> getEnvironments()

Returns:

list of links to environments this key is active on.

addEnvironment

public CMAApiKey addEnvironment(String environment)

Add environment ids to the api key.

Parameters:

environment - a new environment to be affected by this key. A link for the payload will be created automatically.

Returns:

the api key for easy chaining.

toString

public String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.