ElasticStackApi (Apache jclouds 2.1.0 API)

Methods
Modifier and Type	Method and Description
`ServerInfo`	`createAndStartServer(Server createServer)` create and start a new server
`DriveInfo`	`createDrive(Drive createDrive)` create a new drive
`ServerInfo`	`createServer(Server createServer)` create a new server
`void`	`destroyDrive(String uuid)` Destroy a drive
`void`	`destroyServer(String uuid)` Destroy a server
`DriveInfo`	`getDriveInfo(String uuid)`
`ServerInfo`	`getServerInfo(String uuid)`
`void`	`imageDrive(String source, String destination)` Image a drive from another drive.
`void`	`imageDrive(String source, String destination, ImageConversionType conversionType)`
`Set<DriveInfo>`	`listDriveInfo()` Get all drives info
`Set<String>`	`listDrives()` list of drive uuids in your account
`Set<ServerInfo>`	`listServerInfo()` Get all servers info
`Set<String>`	`listServers()` list of server uuids in your account
`Set<StandardDrive>`	`listStandardDriveInfo()` Gets information about all standard drives
`Set<String>`	`listStandardDrives()` Lists standard drive UUIDs in your account
`Payload`	`readDrive(String uuid, long offset, long size)` Read binary data from a drive
`void`	`resetServer(String uuid)` Reset a server
`DriveInfo`	`setDriveData(String uuid, DriveData setDrive)` set extra drive data
`ServerInfo`	`setServerConfiguration(String uuid, Server setServer)` set server configuration
`void`	`shutdownServer(String uuid)` Shutdown a server Sends the server an ACPI power-down event.
`void`	`startServer(String uuid)` Start a server
`void`	`stopServer(String uuid)` Stop a server Kills the server immediately, equivalent to a power failure.
`void`	`writeDrive(String uuid, Payload content)` Write binary data to a drive
`void`	`writeDrive(String uuid, Payload content, long offset)`

All Superinterfaces:

AutoCloseable, Closeable
```
@Consumes(value="text/plain")
public interface ElasticStackApi
extends Closeable
```
Provides synchronous access to elasticstack via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

ServerInfo createAndStartServer(Server createServer)
create and start a new server

DriveInfo createDrive(Drive createDrive)
create a new drive

ServerInfo createServer(Server createServer)
create a new server

void destroyDrive(String uuid)
Destroy a drive

void destroyServer(String uuid)
Destroy a server

DriveInfo getDriveInfo(String uuid)

ServerInfo getServerInfo(String uuid)

void imageDrive(String source, String destination)
Image a drive from another drive.

void imageDrive(String source, String destination, ImageConversionType conversionType)

Set<DriveInfo> listDriveInfo()
Get all drives info

Set<String> listDrives()
list of drive uuids in your account

Set<ServerInfo> listServerInfo()
Get all servers info

Set<String> listServers()
list of server uuids in your account

Set<StandardDrive> listStandardDriveInfo()
Gets information about all standard drives

Set<String> listStandardDrives()
Lists standard drive UUIDs in your account

Payload readDrive(String uuid, long offset, long size)
Read binary data from a drive

void resetServer(String uuid)
Reset a server

DriveInfo setDriveData(String uuid, DriveData setDrive)
set extra drive data

ServerInfo setServerConfiguration(String uuid, Server setServer)
set server configuration

void shutdownServer(String uuid)
Shutdown a server
Sends the server an ACPI power-down event.

void startServer(String uuid)
Start a server

void stopServer(String uuid)
Stop a server
Kills the server immediately, equivalent to a power failure.

void writeDrive(String uuid, Payload content)
Write binary data to a drive

void writeDrive(String uuid, Payload content, long offset)

Methods inherited from interface java.io.Closeable
close

Method Detail

listServers
```
@GET
@Path(value="/servers/list")
Set<String> listServers()
```
list of server uuids in your account

Returns:
or empty set if no servers are found

listServerInfo
```
@GET
@Path(value="/servers/info")
Set<ServerInfo> listServerInfo()
```
Get all servers info

Returns:
or empty set if no servers are found

getServerInfo

@GET
@Path(value="/servers/{uuid}/info")
ServerInfo getServerInfo(@PathParam(value="uuid")
                                String uuid)

Parameters:: uuid - what to get
Returns:: null, if not found

createServer

@POST
@Path(value="/servers/create/stopped")
ServerInfo createServer(Server createServer)

create a new server

Parameters:: createServer -
Returns:: newly created server

setServerConfiguration

@POST
@Path(value="/servers/{uuid}/set")
ServerInfo setServerConfiguration(@PathParam(value="uuid")
                                          String uuid,
                                          Server setServer)

set server configuration

Parameters:: uuid - what server to change; setServer - what values to change
Returns:: new data

destroyServer

@POST
@Path(value="/servers/{uuid}/destroy")
void destroyServer(@PathParam(value="uuid")
                           String uuid)

Destroy a server

Parameters:: uuid - what to destroy

startServer

@POST
@Path(value="/servers/{uuid}/start")
void startServer(@PathParam(value="uuid")
                         String uuid)

Start a server

Parameters:: uuid - what to start

stopServer
```
@POST
@Path(value="/servers/{uuid}/stop")
void stopServer(@PathParam(value="uuid")
                        String uuid)
```
Stop a server
Kills the server immediately, equivalent to a power failure. Server reverts to a stopped status if it is persistent and is automatically destroyed otherwise.

Parameters:
uuid - what to stop

shutdownServer
```
@POST
@Path(value="/servers/{uuid}/shutdown")
void shutdownServer(@PathParam(value="uuid")
                            String uuid)
```
Shutdown a server
Sends the server an ACPI power-down event. Server reverts to a stopped status if it is persistent and is automatically destroyed otherwise.
note
behaviour on shutdown depends on how your server OS is set up to respond to an ACPI power button signal.

Parameters:
uuid - what to shutdown

resetServer

@POST
@Path(value="/servers/{uuid}/reset")
void resetServer(@PathParam(value="uuid")
                         String uuid)

Reset a server

Parameters:: uuid - what to reset

listDrives
```
@GET
@Path(value="/drives/list")
Set<String> listDrives()
```
list of drive uuids in your account

Returns:
or empty set if no drives are found

listDriveInfo
```
@GET
@Path(value="/drives/info")
Set<DriveInfo> listDriveInfo()
```
Get all drives info

Returns:
or empty set if no drives are found

listStandardDrives
```
@GET
@Path(value="/drives/list/standard")
Set<String> listStandardDrives()
```
Lists standard drive UUIDs in your account

Returns:
or empty set if no standard drives are found

listStandardDriveInfo
```
@GET
@Path(value="/drives/info/standard")
Set<StandardDrive> listStandardDriveInfo()
```
Gets information about all standard drives

Returns:
or empty set if no standard drives are found

getDriveInfo

@GET
@Path(value="/drives/{uuid}/info")
DriveInfo getDriveInfo(@PathParam(value="uuid")
                              String uuid)

Parameters:: uuid - what to get
Returns:: null, if not found

createDrive
```
@POST
@Path(value="/drives/create")
DriveInfo createDrive(Drive createDrive)
```
create a new drive

Parameters:
createDrive - required parameters: name, size

Returns:
newly created drive

setDriveData

@POST
@Path(value="/drives/{uuid}/set")
DriveInfo setDriveData(@PathParam(value="uuid")
                               String uuid,
                               DriveData setDrive)

set extra drive data

Parameters:: uuid - what drive to change; setDrive - what values to change
Returns:: new data

destroyDrive

@POST
@Path(value="/drives/{uuid}/destroy")
void destroyDrive(@PathParam(value="uuid")
                          String uuid)

Destroy a drive

Parameters:: uuid - what to delete

createAndStartServer
```
@POST
@Path(value="/servers/create")
ServerInfo createAndStartServer(Server createServer)
```
create and start a new server

Parameters:
createServer -

Returns:
newly created server

imageDrive

@POST
@Path(value="/drives/{destination}/image/{source}")
void imageDrive(@PathParam(value="source")
                        String source,
                        @PathParam(value="destination")
                        String destination)

Image a drive from another drive. The actual imaging process is asynchronous, with progress reported via drive info.

Parameters:: source - drive to copy from; destination - drive to copy to

imageDrive

@POST
@Path(value="/drives/{destination}/image/{source}/{conversion}")
void imageDrive(@PathParam(value="source")
                        String source,
                        @PathParam(value="destination")
                        String destination,
                        @PathParam(value="conversion")
                        ImageConversionType conversionType)

Parameters:: conversionType - Supports 'gzip' or 'gunzip' conversions.
See Also:: imageDrive(String, String)

readDrive

@POST
@Consumes(value="application/octet-stream")
@Path(value="/drives/{uuid}/read/{offset}/{size}")
Payload readDrive(@PathParam(value="uuid")
                                   String uuid,
                                   @PathParam(value="offset")
                                   long offset,
                                   @PathParam(value="size")
                                   long size)

Read binary data from a drive

Parameters:: uuid - drive to read; offset - start at the specified offset in bytes; size - the specified size in bytes; must be <=4096k
Returns:: binary content of the drive.

writeDrive

@POST
@Produces(value="application/octet-stream")
@Path(value="/drives/{uuid}/write")
void writeDrive(@PathParam(value="uuid")
                                 String uuid,
                                 Payload content)

Write binary data to a drive

Parameters:

uuid - drive to write

content - what to write.

Binary data (Content-Type: application/octet-stream)
Supports raw data or Content-Encoding: gzip
Does not support Transfer-Encoding: chunked

writeDrive

@POST
@Produces(value="application/octet-stream")
@Path(value="/drives/{uuid}/write/{offset}")
void writeDrive(@PathParam(value="uuid")
                                 String uuid,
                                 Payload content,
                                 @PathParam(value="offset")
                                 long offset)

Parameters:: offset - the byte offset in the target drive at which to start writing, not an offset in the input stream.
See Also:: writeDrive(String, Payload)

Interface ElasticStackApi

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

listServers

listServerInfo

getServerInfo

createServer

setServerConfiguration

destroyServer

startServer

stopServer

shutdownServer

note

resetServer

listDrives

listDriveInfo

listStandardDrives

listStandardDriveInfo

getDriveInfo

createDrive

setDriveData

destroyDrive

createAndStartServer

imageDrive

imageDrive

readDrive

writeDrive

writeDrive