Package org.openstack4j.api.compute
Interface HostAggregateService
-
- All Superinterfaces:
RestService
- All Known Implementing Classes:
HostAggregateServiceImpl
public interface HostAggregateService extends RestService
Host aggregate Operations API- Author:
- liujunpeng
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HostAggregate
addHost(String hostAggregateId, String host)
Add host to aggregateHostAggregate
create(String name, String availabilityZone)
Create a hostAggregateActionResponse
delete(String aggregateId)
Delete of the aggregateHostAggregate
get(String aggregateId)
Get the specified HostAggregate by IDList<? extends HostAggregate>
list()
List all aggregates (detailed) that the current tenant has access toList<? extends HostAggregate>
list(Map<String,String> filteringParams)
Returns list of Aggregates filtered by parameters.HostAggregate
removeHost(String hostAggregateId, String host)
remove host from aggregateHostAggregate
setMetadata(String hostAggregateId, Map<String,String> metadata)
Sets metadata for an aggregate.HostAggregate
update(String hostAggregateId, String name, String availabilityZone)
Updates the name, and optionally the availability zone, for a specified aggregate.
-
-
-
Method Detail
-
list
List<? extends HostAggregate> list()
List all aggregates (detailed) that the current tenant has access to- Returns:
- list of all aggregates
-
list
List<? extends HostAggregate> list(Map<String,String> filteringParams)
Returns list of Aggregates filtered by parameters.- Parameters:
filteringParams
- map (name, value) of filtering parameters
-
get
HostAggregate get(String aggregateId)
Get the specified HostAggregate by ID- Parameters:
hostAggregateId
- the aggregate identifier- Returns:
- the Aggregate or null if not found
-
delete
ActionResponse delete(String aggregateId)
Delete of the aggregate- Parameters:
aggregateId
- the aggregate identifier- Returns:
- the action response
-
create
HostAggregate create(String name, String availabilityZone)
Create a hostAggregate- Returns:
- HostAggregate
-
update
HostAggregate update(String hostAggregateId, String name, String availabilityZone)
Updates the name, and optionally the availability zone, for a specified aggregate.- Parameters:
hostAggregateId
- the aggregate identifier- Returns:
- HostAggregate
-
setMetadata
HostAggregate setMetadata(String hostAggregateId, Map<String,String> metadata)
Sets metadata for an aggregate.- Parameters:
hostAggregateId
- the aggregate identifier- Returns:
- HostAggregate
-
addHost
HostAggregate addHost(String hostAggregateId, String host)
Add host to aggregate- Parameters:
hostAggregateId
- The ID associated with an aggregate.host
- Host ID to add to an aggregate, which is a collection of multiple groups of hosts that share common resources like storage and network.- Returns:
- HostAggregate
-
removeHost
HostAggregate removeHost(String hostAggregateId, String host)
remove host from aggregate- Parameters:
hostAggregateId
- The ID associated with an aggregate.host
- Host ID to add to an aggregate, which is a collection of multiple groups of hosts that share common resources like storage and network.- Returns:
- HostAggregate
-
-