Package org.openstack4j.api.heat

Interface ResourcesService

public interface ResourcesService

This interface defines all methods for the manipulation of resources

Author:

Octopus Zhang

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getMetadata(String stackName, String stackId, String resourceName)	Gets the stack resource metadata
List<? extends Resource>	list(String stackNameOrId)	Gets a list of currently existing Resources for a specified stack.
List<? extends Resource>	list(String stackNameOrId, int depth)	Gets a list of currently existing Resources for a specified stack with filtern parameters.
List<? extends Resource>	list(String stackName, String stackId)	Gets a list of currently existing Resources for a specified stack.
ActionResponse	markUnhealthy(String stackName, String stackId, String resourceName, ResourceHealth resourceHealth)	Marks a resource unhealthy
Resource	show(String stackName, String stackId, String resourceName)	Gets the detail of the specified resource
ActionResponse	signal(String stackName, String stackId, String resourceName)	Signals a resource

Method Detail

list

List<? extends Resource> list(String stackName,
                              String stackId)

Gets a list of currently existing Resources for a specified stack.

Parameters:

stackId - The unique identifier for a stack

stackName - The name of a stack

Returns:

the list of Resources

list

List<? extends Resource> list(String stackNameOrId)

Gets a list of currently existing Resources for a specified stack.

Parameters:

stackNameOrId - Stack name or stack id

Returns:

the list of Resources

list

List<? extends Resource> list(String stackNameOrId,
                              int depth)

Gets a list of currently existing Resources for a specified stack with filtern parameters.

Parameters:

stackNameOrId - Stack name or stack id

depth - The recursion level for which resources will be listed.

Returns:

the list of Resources

show

Resource show(String stackName,
              String stackId,
              String resourceName)

Gets the detail of the specified resource

Parameters:

stackId - The unique identifier for a stack

stackName - The name of a stack

resourceName - The name of a resource

Returns:

the detail of the specified resource

getMetadata

Map<String,Object> getMetadata(String stackName,
                                     String stackId,
                                     String resourceName)

Gets the stack resource metadata

Parameters:

stackName - The name of a stack

stackId - The unique identifier for a stack

resourceName - The name of a resource

Returns:

the metadata of the specified resource

signal

ActionResponse signal(String stackName,
                      String stackId,
                      String resourceName)

Signals a resource

markUnhealthy

ActionResponse markUnhealthy(String stackName,
                             String stackId,
                             String resourceName,
                             ResourceHealth resourceHealth)

Marks a resource unhealthy