InstanceApi (Apache jclouds 2.1.0 API)

@Path(value="/instances")
@Consumes(value="application/json")
public interface InstanceApi

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class InstanceApi.InstancePages

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InstanceApi.InstancePages`

Method Summary

Methods
Modifier and Type	Method and Description
`Operation`	`addAccessConfigToNic(String instance, Instance.NetworkInterface.AccessConfig accessConfig, String networkInterfaceName)` Adds an access config to an instance's network interface.
`Operation`	`attachDisk(String instance, AttachDisk attachDiskOptions)` Attaches a disk to an instance
`Operation`	`create(NewInstance template)` Creates a instance resource in the specified project using the data included in the request.
`Operation`	`delete(String instance)` Deletes an instance by name and returns the operation in progress, or null if not found.
`Operation`	`deleteAccessConfigFromNic(String instance, String accessConfigName, String networkInterfaceName)` Deletes an access config from an instance's network interface.
`Operation`	`detachDisk(String instance, String deviceName)` Detaches an attached disk from an instance
`Instance`	`get(String instance)` Returns an instance by name or null if not found.
`Instance.SerialPortOutput`	`getSerialPortOutput(String instance)` Returns the specified instance's serial port output.
`Instance.SerialPortOutput`	`getSerialPortOutput(String instance, int port)` Returns the specified instance's serial port output.
`Iterator<ListPage<Instance>>`	`list()`
`Iterator<ListPage<Instance>>`	`list(ListOptions options)`
`ListPage<Instance>`	`listPage(String pageToken, ListOptions listOptions)` Retrieves the list of instance resources available to the specified project.
`Operation`	`reset(String instance)` Hard-resets the instance.
`Operation`	`setDiskAutoDelete(String instanceName, String deviceName, boolean autoDelete)` Sets the auto-delete flag for a disk attached to an instance
`Operation`	`setMetadata(String instance, Metadata metadata)` Sets metadata for an instance using the data included in the request.
`Operation`	`setScheduling(String instanceName, Instance.Scheduling.OnHostMaintenance onHostMaintenance, boolean automaticRestart, boolean preemptible)` Sets an instance's scheduling options.
`Operation`	`setTags(String instance, Iterable<String> items, String fingerprint)` Lists items for an instance
`Operation`	`start(String instance)` This method starts an instance that was stopped using the using the `stop(String)` method.
`Operation`	`stop(String instance)` This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.

Method Detail

get

@Named(value="Instances:get")
@GET
@Path(value="/{instance}")
@Nullable
Instance get(@PathParam(value="instance")
                                   String instance)

Returns an instance by name or null if not found.

create
```
@Named(value="Instances:insert")
@POST
@Produces(value="application/json")
Operation create(NewInstance template)
```
Creates a instance resource in the specified project using the data included in the request.

Parameters:
template - the instance template

Returns:
an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

delete

@Named(value="Instances:delete")
@DELETE
@Path(value="/{instance}")
@Nullable
Operation delete(@PathParam(value="instance")
                                          String instance)

Deletes an instance by name and returns the operation in progress, or null if not found.

addAccessConfigToNic

@Named(value="Instances:addAccessConfig")
@POST
@Produces(value="application/json")
@Path(value="/{instance}/addAccessConfig")
Operation addAccessConfigToNic(@PathParam(value="instance")
                                                      String instance,
                                                      Instance.NetworkInterface.AccessConfig accessConfig,
                                                      @QueryParam(value="networkInterface")
                                                      String networkInterfaceName)

Adds an access config to an instance's network interface.

Parameters:: instance - the instance name.; accessConfig - the AccessConfig to add.; networkInterfaceName - network interface name.
Returns:: an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

deleteAccessConfigFromNic

@Named(value="Instances:deleteAccessConfig")
@POST
@Path(value="/{instance}/deleteAccessConfig")
Operation deleteAccessConfigFromNic(@PathParam(value="instance")
                                                  String instance,
                                                  @QueryParam(value="accessConfig")
                                                  String accessConfigName,
                                                  @QueryParam(value="networkInterface")
                                                  String networkInterfaceName)

Deletes an access config from an instance's network interface.

Parameters:: instance - the instance name.; accessConfigName - the name of the access config to delete; networkInterfaceName - network interface name.
Returns:: an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

getSerialPortOutput

@Named(value="Instances:getSerialPortOutput")
@GET
@Path(value="/{instance}/serialPort")
Instance.SerialPortOutput getSerialPortOutput(@PathParam(value="instance")
                                                           String instance)

Returns the specified instance's serial port output.

Parameters:: instance - the instance name.
Returns:: if successful, this method returns a SerialPortOutput containing the instance's serial output.

getSerialPortOutput

@Named(value="Instances:getSerialPortOutput")
@GET
@Path(value="/{instance}/serialPort")
Instance.SerialPortOutput getSerialPortOutput(@PathParam(value="instance")
                                                           String instance,
                                                           @QueryParam(value="port")
                                                           int port)

Returns the specified instance's serial port output.

Parameters:: instance - the instance name.
Returns:: if successful, this method returns a SerialPortOutput containing the instance's serial output.

reset
```
@Named(value="Instances:reset")
@POST
@Path(value="/{instance}/reset")
Operation reset(@PathParam(value="instance")
                              String instance)
```
Hard-resets the instance.

Parameters:
instance - the instance name

Returns:
an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

attachDisk

@Named(value="Instances:attachDisk")
@POST
@Produces(value="application/json")
@Path(value="/{instance}/attachDisk")
Operation attachDisk(@PathParam(value="instance")
                                            String instance,
                                            AttachDisk attachDiskOptions)

Attaches a disk to an instance

Parameters:: instance - The instance name to attach to; attachDiskOptions - The options for attaching the disk.
Returns:: an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

detachDisk

@Named(value="Instances:detachDisk")
@POST
@Path(value="/{instance}/detachDisk")
Operation detachDisk(@PathParam(value="instance")
                                   String instance,
                                   @QueryParam(value="deviceName")
                                   String deviceName)

Detaches an attached disk from an instance

Parameters:: instance - The instance name to attach to; deviceName - The device name of the disk to detach.
Returns:: an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

setMetadata

@Named(value="Instances:setMetadata")
@POST
@Path(value="/{instance}/setMetadata")
Operation setMetadata(@PathParam(value="instance")
                                    String instance,
                                    Metadata metadata)

Sets metadata for an instance using the data included in the request.

NOTE: This *sets* metadata items on the project (vs *adding* items to metadata), if there are existing metadata that must be kept these must be fetched first and then re-sent on update.


    Metadata update = instanceApi.get("myInstance").metadata().clone();
    update.put("newItem","newItemValue");
    instanceApi.setMetadata("myInstance", update);

Parameters:: instance - The name of the instance; metadata - the metadata to set
Returns:: an Operations resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

setTags

@Named(value="Instances:setTags")
@POST
@Path(value="/{instance}/setTags")
@Produces(value="application/json")
Operation setTags(@PathParam(value="instance")
                                         String instance,
                                         Iterable<String> items,
                                         String fingerprint)

Lists items for an instance

Parameters:: instance - the name of the instance; items - A set of items; fingerprint - The current fingerprint for the items
Returns:: an Operations resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

setDiskAutoDelete

@Named(value="Instances:setDiskAutoDelete")
@POST
@Path(value="/{instance}/setDiskAutoDelete")
Operation setDiskAutoDelete(@PathParam(value="instance")
                                          String instanceName,
                                          @QueryParam(value="deviceName")
                                          String deviceName,
                                          @QueryParam(value="autoDelete")
                                          boolean autoDelete)

Sets the auto-delete flag for a disk attached to an instance

Parameters:: instanceName - The name of the instance; deviceName - Disk device name to modify.; autoDelete - Whether to auto-delete the disk when the instance is deleted

setScheduling

@Named(value="Instances:setScheduling")
@POST
@Path(value="/{instance}/setScheduling")
Operation setScheduling(@PathParam(value="instance")
                                      String instanceName,
                                      Instance.Scheduling.OnHostMaintenance onHostMaintenance,
                                      boolean automaticRestart,
                                      boolean preemptible)

Sets an instance's scheduling options.

Parameters:: instanceName - The name of the instance; onHostMaintenance - either MIGRATE or TERMINATE the default is MIGRATE (Live Migration).; automaticRestart - Defines whether the Instance should be automatically restarted when it is terminated by Compute Engine (not terminated by user). Used when onHostMaintenance is set to TERMINATE.; preemptible - Defines whether the Instance should be launched as spot instance
Returns:
See Also:

start

@Named(value="Instances:start")
@POST
@Path(value="/{instance}/start")
@Produces(value="application/json")
Operation start(@PathParam(value="instance")
                                       String instance)

This method starts an instance that was stopped using the using the stop(String) method.

Parameters:: instance - - name of the instance to be started

stop
```
@Named(value="Instances:stop")
@POST
@Path(value="/{instance}/stop")
@Produces(value="application/json")
Operation stop(@PathParam(value="instance")
                                      String instance)
```
This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted.

Parameters:
instance -

Returns:

listPage
```
@Named(value="Instances:list")
@GET
ListPage<Instance> listPage(@Nullable@QueryParam(value="pageToken")
                                    String pageToken,
                                    ListOptions listOptions)
```
Retrieves the list of instance resources available to the specified project. By default the list as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:
pageToken - marks the beginning of the next list page
listOptions - listing options

Returns:
a page of the list

list

@Named(value="Instances:list")
@GET
Iterator<ListPage<Instance>> list()

See Also:: listPage(String, ListOptions)

list

@Named(value="Instances:list")
@GET
Iterator<ListPage<Instance>> list(ListOptions options)

See Also:: listPage(String, ListOptions)

Interface InstanceApi

Nested Class Summary

Method Summary

Method Detail

get

create

delete

addAccessConfigToNic

deleteAccessConfigFromNic

getSerialPortOutput

getSerialPortOutput

reset

attachDisk

detachDisk

setMetadata

setTags

setDiskAutoDelete

setScheduling

start

stop

listPage

list

list