org.openstack4j.api.heat

Interface TemplateService

All Known Implementing Classes:

TemplateServiceImpl

public interface TemplateService

This Interface contains a non-exhaustive list of methods for the manipulation of Heat Templates

Author:

Matthias Reisser

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getTemplateAsMap(String stackNameOrId) Retrieves the original template as Map when you know only the stack name or stack id
Map<String,Object>	getTemplateAsMap(String stackName, String stackId) Retrieves the original template as Map
String	getTemplateAsString(String stackName, String stackId) Retrieves the original template in original String form JSON or YAML
TemplateResponse	validateTemplate(String template) Validates the template
TemplateResponse	validateTemplate(Template template) Validates the template
TemplateResponse	validateTemplateByURL(String templateURL) Validates the template

Method Detail

validateTemplate

TemplateResponse validateTemplate(Template template)

Validates the template

Parameters:

template - to validate, passed as a Template

Returns:

TemplateResponse indicating valid or the error condition if not valid

validateTemplate

TemplateResponse validateTemplate(String template)

Validates the template

Parameters:

template - to validate, passed as String in JSON Format

Returns:

TemplateResponse indicating valid or the error condition if not valid

validateTemplateByURL

TemplateResponse validateTemplateByURL(String templateURL)

Validates the template

Parameters:

templateURL - the remote template via URL to validate

Returns:

TemplateResponse indicating valid or the error condition if not valid

getTemplateAsString

String getTemplateAsString(String stackName,
                           String stackId)

Retrieves the original template in original String form JSON or YAML

Parameters:

stackName - the stack name

stackId - the stack identifier

Returns:

the template

Throws:

ResponseException - if an error occurs

getTemplateAsMap

Map<String,Object> getTemplateAsMap(String stackName,
                                    String stackId)

Retrieves the original template as Map

Parameters:

stackName - the stack name

stackId - the stack identifier

Returns:

the template

Throws:

ResponseException - if an error occurs

getTemplateAsMap

Map<String,Object> getTemplateAsMap(String stackNameOrId)

Retrieves the original template as Map when you know only the stack name or stack id

Parameters:

stackNameOrId - the stack name or stackId

Returns:

the template

Throws:

ResponseException - if an error occurs