Package org.openstack4j.api.heat

Interface StackService

All Known Implementing Classes:

StackServiceImpl

public interface StackService

This interface defines all methods for the manipulation of stacks

Author:

Matthias Reisser

Method Summary

Modifier and Type	Method	Description
AdoptStackData	abandon(String stackName, String stackId)	Deletes a stack but leaves its resources intact, and returns data that describes the stack and its resources.
Stack	adopt(AdoptStackData adoptStackData, Map<String,String> parameters, boolean disableRollback, Long timeOutMins, String template)	Creates a stack from existing resources.
Stack	create(String name, String template, Map<String,String> parameters, boolean disableRollback, Long timeOutMins)	POST /v1/{tenant_id}/stacks Creates a new StackCreate Object and returns a new Stack as sent from the server.
Stack	create(StackCreate newStack)	POST /v1/{tenant_id}/stacks
ActionResponse	delete(String stackName, String stackId)	Deletes the specified Stack from the server.
Stack	getDetails(String stackName, String stackId)	returns details of a Stack.
Stack	getStackByName(String name)	returns details of a Stack.
List<? extends Stack>	list()	Gets a list of currently existing Stacks.
List<? extends Stack>	list(Map<String,String> filteringParams)	Gets a list of currently existing Stack objects, filtered by parameters.
ActionResponse	update(String stackName, String stackId, StackUpdate stackUpdate)	Updates an existing Stack

Method Detail

create

Stack create(StackCreate newStack)

POST /v1/{tenant_id}/stacks

Creates a new Stack out of a StackCreate object

Parameters:

newStack - StackCreate object out of which stack is to be created

Returns:

new Stack as returned from the server

update

ActionResponse update(String stackName,
                      String stackId,
                      StackUpdate stackUpdate)

Updates an existing Stack

Parameters:

stackName - the stack name

stackId - the specific stack identifier

stackUpdate - the stack update options

Returns:

the action response

create

Stack create(String name,
             String template,
             Map<String,String> parameters,
             boolean disableRollback,
             Long timeOutMins)

POST /v1/{tenant_id}/stacks Creates a new StackCreate Object and returns a new Stack as sent from the server.

Parameters:

name - Name of Stack

template - Template in Json-Format or YAML format

parameters - Map of parameters

disableRollback - boolean to enable or disable rollback

timeOutMins - timeout in minutes

Returns:

new Stack as returned from the server

getStackByName

Stack getStackByName(String name)

returns details of a Stack.

Parameters:

stackName - Name of Stack

Returns:

Stack

list

List<? extends Stack> list()

Gets a list of currently existing Stacks.

Returns:

the list of Stacks

list

List<? extends Stack> list(Map<String,String> filteringParams)

Gets a list of currently existing Stack objects, filtered by parameters.

Parameters:

filteringParams - The parameters used to filter the stacks returned.

Returns:

the list of Stack objects.

getDetails

Stack getDetails(String stackName,
                 String stackId)

returns details of a Stack.

Parameters:

stackName - Name of Stack

stackId - Id of Stack

delete

ActionResponse delete(String stackName,
                      String stackId)

Deletes the specified Stack from the server.

Parameters:

stackName - Name of Stack

stackId - Id of Stack

Returns:

the action response

abandon

AdoptStackData abandon(String stackName,
                       String stackId)

Deletes a stack but leaves its resources intact, and returns data that describes the stack and its resources.

Parameters:

stackName - Name of Stack

stackId - Id of Stack

Returns:

adopt_stack_data element representing by AdoptStackData

adopt

Stack adopt(AdoptStackData adoptStackData,
            Map<String,String> parameters,
            boolean disableRollback,
            Long timeOutMins,
            String template)

Creates a stack from existing resources.

Parameters:

adoptStackData - Structure AdoptStackData, representing existing resources

parameters - Map of parameters

disableRollback - Enable or disable rollback

timeOutMins - Timeout in minutes

template - Template in Json-Format or YAML format. It is optional, used just in case there will be new resources (not included in adoptStackData)