Package com.contentful.java.cma

Class ModuleBulkActions

java.lang.Object

com.contentful.java.cma.ModuleBulkActions

public class ModuleBulkActions
extends java.lang.Object

Bulk actions Module.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ModuleBulkActions(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor, java.lang.String spaceId, java.lang.String environmentId, boolean environmentIdConfigured)	Create bulk actions module.

Method Summary

Modifier and Type	Method	Description
ModuleBulkActions.Async	async()
protected com.contentful.java.cma.ServiceBulkActions	createService(retrofit2.Retrofit retrofit)
CMABulkAction	fetch(java.lang.String spaceId, java.lang.String environmentId, java.lang.String bulkActionId)	Fetch a bulk action using the given bulkActionId.
CMABulkAction	publish(java.lang.String spaceId, java.lang.String environmentId, CMAPayload payload)	Publish a bulk action.
CMABulkAction	unpublish(java.lang.String spaceId, java.lang.String environmentId, CMAPayload payload)	Unpublish a bulk action.
CMABulkAction	validate(java.lang.String spaceId, java.lang.String environmentId, CMAPayload payload)	Validate a bulk action.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleBulkActions

public ModuleBulkActions(retrofit2.Retrofit retrofit,
                         java.util.concurrent.Executor callbackExecutor,
                         java.lang.String spaceId,
                         java.lang.String environmentId,
                         boolean environmentIdConfigured)

Create bulk actions module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

spaceId - the space to be used when not given.

environmentId - the environment to be used when not given.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

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

fetch

public CMABulkAction fetch(java.lang.String spaceId,
                           java.lang.String environmentId,
                           java.lang.String bulkActionId)

Fetch a bulk action using the given bulkActionId.

Returns:

CMABulkAction result instance

Throws:

java.lang.IllegalArgumentException - if space id is null.

publish

public CMABulkAction publish(java.lang.String spaceId,
                             java.lang.String environmentId,
                             CMAPayload payload)

Publish a bulk action.

Returns:

CMABulkAction result instance

Throws:

java.lang.IllegalArgumentException - if spaceId's space id is null.

java.lang.IllegalArgumentException - if payload's id is null.

unpublish

public CMABulkAction unpublish(java.lang.String spaceId,
                               java.lang.String environmentId,
                               CMAPayload payload)

Unpublish a bulk action.

Returns:

CMABulkAction result instance

Throws:

java.lang.IllegalArgumentException - if spaceId's space id is null.

java.lang.IllegalArgumentException - if payload's id is null.

validate

public CMABulkAction validate(java.lang.String spaceId,
                              java.lang.String environmentId,
                              CMAPayload payload)

Validate a bulk action.

Returns:

CMABulkAction result instance

Throws:

java.lang.IllegalArgumentException - if spaceId's space id is null.

java.lang.IllegalArgumentException - if payload's id is null.

async

public ModuleBulkActions.Async async()

Returns:

a module with a set of asynchronous methods.