com.contentful.java.cma

Class ModuleApiKeys

java.lang.Object

com.contentful.java.cma.ModuleApiKeys

public final class ModuleApiKeys
extends java.lang.Object

Api Keys Module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleApiKeys.Async Async module.

Constructor Summary

Constructors

Constructor and Description
ModuleApiKeys(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor)

Method Summary

Modifier and Type	Method and Description
ModuleApiKeys.Async	async()
CMAApiKey	create(java.lang.String spaceId, CMAApiKey key) Create a new delivery api key.
protected com.contentful.java.cma.ServiceApiKeys	createService(retrofit2.Retrofit retrofit)
CMAArray<CMAApiKey>	fetchAll(java.lang.String spaceId) Fetch all delivery api keys.
CMAArray<CMAApiKey>	fetchAll(java.lang.String spaceId, java.util.Map<java.lang.String,java.lang.String> query) Query for specific api keys.
CMAApiKey	fetchOne(java.lang.String spaceId, java.lang.String keyId) Fetch only one delivery api key.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleApiKeys

public ModuleApiKeys(retrofit2.Retrofit retrofit,
                     java.util.concurrent.Executor callbackExecutor)

Method Detail

createService

protected com.contentful.java.cma.ServiceApiKeys createService(retrofit2.Retrofit retrofit)

fetchAll

public CMAArray<CMAApiKey> fetchAll(java.lang.String spaceId)

Fetch all delivery api keys.

Parameters:

spaceId - the id of the space to host the api keys.

Returns:

a list of delivery api keys.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMAApiKey> fetchAll(java.lang.String spaceId,
                                    java.util.Map<java.lang.String,java.lang.String> query)

Query for specific api keys.

Parameters:

spaceId - the id of the space to host the api keys.

query - the terms to query for specific keys.

Returns:

a list of delivery api keys.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchOne

public CMAApiKey fetchOne(java.lang.String spaceId,
                          java.lang.String keyId)

Fetch only one delivery api key.

Parameters:

spaceId - the id of the space this is valid on.

keyId - the id of the key itself.

Returns:

one delivery api key.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if keyId is null.

create

public CMAApiKey create(java.lang.String spaceId,
                        CMAApiKey key)

Create a new delivery api key.

Parameters:

spaceId - the id of the space this is valid on.

key - the key to be created.

Returns:

the just created key, containing the delivery token.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if key is null.

async

public ModuleApiKeys.Async async()

Returns:

a module with a set of asynchronous methods.