BYONComputeServiceAdapter (Apache jclouds 2.0.0 API)

java.lang.Object
- org.jclouds.byon.internal.BYONComputeServiceAdapter

All Implemented Interfaces:

ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>, JCloudsNativeComputeServiceAdapter
```
@Singleton
public class BYONComputeServiceAdapter
extends Object
implements JCloudsNativeComputeServiceAdapter
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.jclouds.compute.JCloudsNativeComputeServiceAdapter
  JCloudsNativeComputeServiceAdapter.NodeWithInitialCredentials
- Nested classes/interfaces inherited from interface org.jclouds.compute.ComputeServiceAdapter
  ComputeServiceAdapter.NodeAndInitialCredentials<N>

Constructor Summary

Constructors
Constructor and Description
`BYONComputeServiceAdapter(com.google.common.base.Supplier<com.google.common.cache.LoadingCache<String,Node>> nodes, NodeToNodeMetadata converter, JustProvider locationSupplier)`

Method Summary

Methods
Modifier and Type	Method and Description
`JCloudsNativeComputeServiceAdapter.NodeWithInitialCredentials`	`createNodeWithGroupEncodedIntoName(String group, String name, Template template)` `ComputeService.createNodesInGroup(String, int, Template)` generates the parameters passed into this method such that each node in the set has a unique name.
`void`	`destroyNode(String id)`
`Image`	`getImage(String id)` get a specific image by id
`NodeMetadata`	`getNode(String id)`
`Iterable<Hardware>`	`listHardwareProfiles()` Hardware profiles describe available cpu, memory, and disk configurations that can be used to run a node.
`Iterable<Image>`	`listImages()` Images are the available configured operating systems that someone can run a node with.
`Iterable<Location>`	`listLocations()`
`Iterable<NodeMetadata>`	`listNodes()`
`Iterable<NodeMetadata>`	`listNodesByIds(Iterable<String> ids)`
`void`	`rebootNode(String id)`
`void`	`resumeNode(String id)`
`void`	`suspendNode(String id)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BYONComputeServiceAdapter
```
@Inject
public BYONComputeServiceAdapter(com.google.common.base.Supplier<com.google.common.cache.LoadingCache<String,Node>> nodes,
                                NodeToNodeMetadata converter,
                                JustProvider locationSupplier)
```
- Method Detail
  - createNodeWithGroupEncodedIntoName
```
public JCloudsNativeComputeServiceAdapter.NodeWithInitialCredentials createNodeWithGroupEncodedIntoName(String group,
                                                                                               String name,
                                                                                               Template template)
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    ComputeService.createNodesInGroup(String, int, Template) generates the parameters passed into this method such that each node in the set has a unique name.
    note
    It is intentional to return the library native node object, as generic type N. If you are not using library-native objects (such as libvirt Domain) use JCloudsNativeComputeServiceAdapter instead.
    note
    Your responsibility is to create a node with the underlying library and return after storing its credentials in the supplied map corresponding to credentialStore
    
    Specified by:
    
    createNodeWithGroupEncodedIntoName in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    createNodeWithGroupEncodedIntoName in interface JCloudsNativeComputeServiceAdapter
    
    Parameters:
    group - used to aggregate nodes with identical configuration
    name - unique supplied name for the node, which has the group encoded into it.
    template - includes imageId, locationId, and hardwareId used to resume the instance.
    
    Returns:
    library-native representation of a node. TODO: return typed exception on createNodeFailure
    See Also:
    ComputeService.createNodesInGroup(String, int, Template)
  - listHardwareProfiles
```
public Iterable<Hardware> listHardwareProfiles()
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Hardware profiles describe available cpu, memory, and disk configurations that can be used to run a node.
    To implement this method, return the library native hardware profiles available to the user. These will be used to launch nodes as a part of the template.
    
    Specified by:
    
    listHardwareProfiles in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    listHardwareProfiles in interface JCloudsNativeComputeServiceAdapter
    
    Returns:
    a non-null iterable of available hardware profiles.
    See Also:
    ComputeService.listHardwareProfiles()
  - listImages
```
public Iterable<Image> listImages()
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Images are the available configured operating systems that someone can run a node with.
    To implement this method, return the library native images available to the user. These will be used to launch nodes as a part of the template.
    
    Specified by:
    
    listImages in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    listImages in interface JCloudsNativeComputeServiceAdapter
    
    Returns:
    a non-null iterable of available images.
    See Also:
    ComputeService.listImages()
  - listNodes
```
public Iterable<NodeMetadata> listNodes()
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Specified by:
    
    listNodes in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    listNodes in interface JCloudsNativeComputeServiceAdapter
  - listNodesByIds
```
public Iterable<NodeMetadata> listNodesByIds(Iterable<String> ids)
```
    Specified by:
    
    listNodesByIds in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
  - listLocations
```
public Iterable<Location> listLocations()
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Specified by:
    
    listLocations in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    listLocations in interface JCloudsNativeComputeServiceAdapter
  - getNode
```
public NodeMetadata getNode(String id)
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Specified by:
    
    getNode in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    getNode in interface JCloudsNativeComputeServiceAdapter
  - getImage
```
public Image getImage(String id)
```
    Description copied from interface: ComputeServiceAdapter
    
    get a specific image by id
    
    Specified by:
    
    getImage in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Parameters:
    id - Image#getId, which is not necessarily Image#getProviderId
    
    Returns:
    image or null if not exists.
  - destroyNode
```
public void destroyNode(String id)
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Specified by:
    
    destroyNode in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    destroyNode in interface JCloudsNativeComputeServiceAdapter
  - rebootNode
```
public void rebootNode(String id)
```
    Description copied from interface: JCloudsNativeComputeServiceAdapter
    
    Specified by:
    
    rebootNode in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
    
    Specified by:
    
    rebootNode in interface JCloudsNativeComputeServiceAdapter
  - resumeNode
```
public void resumeNode(String id)
```
    Specified by:
    
    resumeNode in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>
  - suspendNode
```
public void suspendNode(String id)
```
    Specified by:
    
    suspendNode in interface ComputeServiceAdapter<NodeMetadata,Hardware,Image,Location>

Class BYONComputeServiceAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface org.jclouds.compute.JCloudsNativeComputeServiceAdapter

Nested classes/interfaces inherited from interface org.jclouds.compute.ComputeServiceAdapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BYONComputeServiceAdapter

Method Detail

createNodeWithGroupEncodedIntoName

note

note

listHardwareProfiles

listImages

listNodes

listNodesByIds

listLocations

getNode

getImage

destroyNode

rebootNode

resumeNode

suspendNode