Package org.openstack4j.openstack.heat.internal

Class ResourcesServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.heat.internal.BaseHeatServices

org.openstack4j.openstack.heat.internal.ResourcesServiceImpl

All Implemented Interfaces:

ResourcesService

public class ResourcesServiceImpl
extends BaseHeatServices
implements ResourcesService

This class implements some methods for manipulation of HeatResource objects. The non-exhaustive list of methods is oriented along http://developer.openstack.org/api-ref-orchestration-v1.html

Author:

Octopus Zhang

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor	Description
ResourcesServiceImpl()

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

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getWithResponse, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, putWithResponse, request, toList, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourcesServiceImpl

public ResourcesServiceImpl()

Method Detail

list

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

Description copied from interface: ResourcesService

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

Specified by:

list in interface ResourcesService

Parameters:

stackName - The name of a stack

stackId - The unique identifier for a stack

Returns:

the list of Resources

list

public List<? extends Resource> list(String stackNameOrId)

Description copied from interface: ResourcesService

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

Specified by:

list in interface ResourcesService

Parameters:

stackNameOrId - Stack name or stack id

Returns:

the list of Resources

list

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

Description copied from interface: ResourcesService

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

Specified by:

list in interface ResourcesService

Parameters:

stackNameOrId - Stack name or stack id

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

Returns:

the list of Resources

show

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

Description copied from interface: ResourcesService

Gets the detail of the specified resource

Specified by:

show in interface ResourcesService

Parameters:

stackName - The name of a stack

stackId - The unique identifier for a stack

resourceName - The name of a resource

Returns:

the detail of the specified resource

getMetadata

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

Description copied from interface: ResourcesService

Gets the stack resource metadata

Specified by:

getMetadata in interface ResourcesService

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

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

Description copied from interface: ResourcesService

Signals a resource

Specified by:

signal in interface ResourcesService

markUnhealthy

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

Description copied from interface: ResourcesService

Marks a resource unhealthy

Specified by:

markUnhealthy in interface ResourcesService