Package org.jclouds.cloudstack.features

Interface DomainDomainApi

All Known Subinterfaces:

GlobalDomainApi

public interface DomainDomainApi

Provides synchronous access to CloudStack Domain features available to Domain Admin users.

See Also:

Method Summary

Modifier and Type	Method	Description
Domain	getDomainById(String domainId)	Get a domain by ID
Set<Domain>	listDomainChildren(ListDomainChildrenOptions... options)	Lists all children domains belonging to a specified domain
Set<Domain>	listDomains(ListDomainsOptions... options)	List domains with detailed information

Method Detail

listDomains

@Named("listDomains")
@GET
@Consumes("application/json")
Set<Domain> listDomains(ListDomainsOptions... options)

List domains with detailed information

Parameters:

options - list filtering optional arguments

Returns:

set of domain instances or empty

getDomainById

@Named("listDomains")
@GET
@Consumes("application/json")
Domain getDomainById(@QueryParam("id")
                     String domainId)

Get a domain by ID

Parameters:

domainId - domain ID

Returns:

domain instance or null

listDomainChildren

@Named("listDomainChildren")
@GET
@Consumes("application/json")
Set<Domain> listDomainChildren(ListDomainChildrenOptions... options)

Lists all children domains belonging to a specified domain

Parameters:

options - list filtering optional arguments

Returns:

set of domain instances or empty