Package com.adobe.aio.cloudmanager

Interface ProgramApi

public interface ProgramApi

Program API

See the Program API documentation. See the Regions API documentation.

Method Summary

Modifier and Type	Method	Description
void	delete(@NotNull Program program)	Delete the program.
void	delete(@NotNull String programId)	Delete the program.
@NotNull Program	get(@NotNull String programId)	Get the program with the specified id.
@NotNull Collection<Program>	list(@NotNull Tenant tenant)	List all programs for the specified tenant.
@NotNull Collection<Program>	list(@NotNull String tenantId)	List all programs for the specified tenant.
@NotNull Collection<Region>	listRegions(@NotNull String programId)	List all regions which can be used to create environments for the specified program.

Method Detail

get

@NotNull
@NotNull Program get(@NotNull
                     @NotNull String programId)
              throws CloudManagerApiException

Get the program with the specified id.

Parameters:

programId - the id of the program

Returns:

the program

Throws:

CloudManagerApiException - when any error occurs

delete

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

Delete the program.

Parameters:

programId - the id of the program to delete.

Throws:

CloudManagerApiException - when any error occurs

delete

void delete(@NotNull
            @NotNull Program program)
     throws CloudManagerApiException

Delete the program.

Parameters:

program - the program to delete

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<Program> list(@NotNull
                                  @NotNull String tenantId)
                           throws CloudManagerApiException

List all programs for the specified tenant.

Parameters:

tenantId - the id tenant

Returns:

a list of Programs

Throws:

CloudManagerApiException - when any error occurs

list

@NotNull
@NotNull Collection<Program> list(@NotNull
                                  @NotNull Tenant tenant)
                           throws CloudManagerApiException

List all programs for the specified tenant.

Parameters:

tenant - the tenant

Returns:

a list of Programs

Throws:

CloudManagerApiException - when any error occurs

listRegions

@NotNull
@NotNull Collection<Region> listRegions(@NotNull
                                        @NotNull String programId)
                                 throws CloudManagerApiException

List all regions which can be used to create environments for the specified program.

Parameters:

programId - the id of the program

Returns:

the list of regions

Throws:

CloudManagerApiException - when any error occurs