Package com.adobe.aio.cloudmanager

Interface ContentSetApi

public interface ContentSetApi

Content Set API.

See theContent Set/Flow API documentation.

Method Summary

Modifier and Type	Method	Description
@NotNull ContentFlow	cancelFlow(@NotNull String programId, @NotNull String id)	Cancel the content flow.
@NotNull ContentSet	create(@NotNull String programId, @NotNull String name, String description, @NotNull Collection<ContentSet.PathDefinition> definitions)	Create a new ContentSet in the specified program.
void	delete(@NotNull String programId, @NotNull String id)	Delete the content set.
@NotNull ContentSet	get(@NotNull String programId, @NotNull String id)	Get the content set.
@NotNull ContentFlow	getFlow(@NotNull String programId, @NotNull String id)	Retrieve the content flow.
@NotNull Collection<ContentSet>	list(@NotNull String programId)	List content sets within the specified program.
@NotNull Collection<ContentSet>	list(@NotNull String programId, int limit)	List content sets within the specified program, using the specified limit and starting at 0.
@NotNull Collection<ContentSet>	list(@NotNull String programId, int start, int limit)	List content sets within the specified program, using the specified limit and starting at the specified position.
@NotNull Collection<ContentFlow>	listFlows(@NotNull String programId)	List the content flows which exist in the specified program.
@NotNull Collection<ContentFlow>	listFlows(@NotNull String programId, int limit)	List the content flows which exist in the specified program, using the specified limit and starting at 0.
@NotNull Collection<ContentFlow>	listFlows(@NotNull String programId, int start, int limit)	List the content flows which exist in the specified program, using the specified limit and starting at the specified position.
@NotNull ContentFlow	startFlow(@NotNull String programId, @NotNull String id, @NotNull String srcEnvironmentId, @NotNull String destEnvironmentId, boolean includeAcl)	Start a content flow between the specified environments, using the specified content set.
@NotNull ContentSet	update(@NotNull String programId, @NotNull String id, String name, String description, Collection<ContentSet.PathDefinition> definitions)	Update the content set with the provided details.

Method Detail

list

@NotNull
@NotNull Collection<ContentSet> list(@NotNull
                                     @NotNull String programId)
                              throws CloudManagerApiException

List content sets within the specified program.

Parameters:

programId - the id of the program context

Returns:

list of content sets

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<ContentSet> list(@NotNull
                                     @NotNull String programId,
                                     int limit)
                              throws CloudManagerApiException

List content sets within the specified program, using the specified limit and starting at 0.

Parameters:

programId - the id of the program context

limit - the number of flows to return

Returns:

list of content sets

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<ContentSet> list(@NotNull
                                     @NotNull String programId,
                                     int start,
                                     int limit)
                              throws CloudManagerApiException

List content sets within the specified program, using the specified limit and starting at the specified position.

Parameters:

programId - the id of the program context

start - the starting position of the results

limit - the number of flows to return

Returns:

list of content sets

Throws:

CloudManagerApiException - when any error occurs

create

@NotNull
@NotNull ContentSet create(@NotNull
                           @NotNull String programId,
                           @NotNull
                           @NotNull String name,
                           String description,
                           @NotNull
                           @NotNull Collection<ContentSet.PathDefinition> definitions)
                    throws CloudManagerApiException

Create a new ContentSet in the specified program.

Parameters:

programId - the id of the program context

name - name of the content set

description - optional description

definitions - path definitions for the content set

Returns:

the created content set

Throws:

CloudManagerApiException - when any error occurs

get

@NotNull
@NotNull ContentSet get(@NotNull
                        @NotNull String programId,
                        @NotNull
                        @NotNull String id)
                 throws CloudManagerApiException

Get the content set.

Parameters:

programId - the id of the program context

id - the content set id

Returns:

the content set

Throws:

CloudManagerApiException - when any error occurs

update

@NotNull
@NotNull ContentSet update(@NotNull
                           @NotNull String programId,
                           @NotNull
                           @NotNull String id,
                           String name,
                           String description,
                           Collection<ContentSet.PathDefinition> definitions)
                    throws CloudManagerApiException

Update the content set with the provided details.

Parameters:

programId - the id of the program context

id - the content set id

name - the new name, or null to leave unchanged

description - the new description, or null to leave unchanged

definitions - the new definitions, or null to leave unchanged

Returns:

the updated content set

Throws:

CloudManagerApiException - when any error occurs

delete

void delete(@NotNull
            @NotNull String programId,
            @NotNull
            @NotNull String id)
     throws CloudManagerApiException

Delete the content set.

Parameters:

programId - the id of the program context

id - the content set id

Throws:

CloudManagerApiException - when any error occurs

listFlows

@NotNull
@NotNull Collection<ContentFlow> listFlows(@NotNull
                                           @NotNull String programId)
                                    throws CloudManagerApiException

List the content flows which exist in the specified program.

Parameters:

programId - the id of the program context

Returns:

a list of content flows

Throws:

CloudManagerApiException - when any error occurs

listFlows

@NotNull
@NotNull Collection<ContentFlow> listFlows(@NotNull
                                           @NotNull String programId,
                                           int limit)
                                    throws CloudManagerApiException

List the content flows which exist in the specified program, using the specified limit and starting at 0.

Parameters:

programId - the id of the program context

limit - the number of flows to return

Returns:

a list of content flows

Throws:

CloudManagerApiException - when any error occurs

listFlows

@NotNull
@NotNull Collection<ContentFlow> listFlows(@NotNull
                                           @NotNull String programId,
                                           int start,
                                           int limit)
                                    throws CloudManagerApiException

List the content flows which exist in the specified program, using the specified limit and starting at the specified position.

Parameters:

programId - the id of the program context

start - the starting position of the results

limit - the number of flows to return

Returns:

a list of content flows

Throws:

CloudManagerApiException - when any error occurs

startFlow

@NotNull
@NotNull ContentFlow startFlow(@NotNull
                               @NotNull String programId,
                               @NotNull
                               @NotNull String id,
                               @NotNull
                               @NotNull String srcEnvironmentId,
                               @NotNull
                               @NotNull String destEnvironmentId,
                               boolean includeAcl)
                        throws CloudManagerApiException

Start a content flow between the specified environments, using the specified content set.

Parameters:

programId - the id of the program context

id - the id of the content set to use

srcEnvironmentId - the id of the source environment

destEnvironmentId - the id of the destination environment

includeAcl - whether to include the content's ACL definitions

Returns:

the content flow

Throws:

CloudManagerApiException - when any error occurs

getFlow

@NotNull
@NotNull ContentFlow getFlow(@NotNull
                             @NotNull String programId,
                             @NotNull
                             @NotNull String id)
                      throws CloudManagerApiException

Retrieve the content flow.

Parameters:

programId - the id of the program context

id - the id of the content flow

Returns:

the content flow

Throws:

CloudManagerApiException - when any error occurs

cancelFlow

@NotNull
@NotNull ContentFlow cancelFlow(@NotNull
                                @NotNull String programId,
                                @NotNull
                                @NotNull String id)
                         throws CloudManagerApiException

Cancel the content flow.

Parameters:

programId - the id of the program context

id - the id of the content flow

Returns:

the content flow

Throws:

CloudManagerApiException - when any error occurs