RunningInstance (Apache jclouds 1.7.3 API)

Nested Classes
Modifier and Type	Class and Description
`static class`	`RunningInstance.Builder<T extends RunningInstance.Builder<T>>`

Fields
Modifier and Type	Field and Description
`protected String`	`amiLaunchIndex`
`protected String`	`availabilityZone`
`protected String`	`dnsName`
`protected Map<String,BlockDevice>`	`ebsBlockDevices`
`protected Set<String>`	`groupNames`
`protected String`	`imageId`
`protected String`	`instanceId`
`protected InstanceState`	`instanceState`
`protected String`	`instanceType`
`protected String`	`ipAddress`
`protected String`	`kernelId`
`protected String`	`keyName`
`protected Date`	`launchTime`
`protected String`	`platform`
`protected String`	`privateDnsName`
`protected String`	`privateIpAddress`
`protected String`	`ramdiskId`
`protected String`	`rawState`
`protected String`	`reason`
`protected String`	`region`
`protected String`	`rootDeviceName`
`protected RootDeviceType`	`rootDeviceType`
`protected Map<String,String>`	`tags`
`protected String`	`virtualizationType`

Constructors
Modifier	Constructor and Description
`protected`	RunningInstance(String region, Iterable<String> groupNames, String amiLaunchIndex, String dnsName, String imageId, String instanceId, InstanceState instanceState, String rawState, String instanceType, String ipAddress, String kernelId, String keyName, Date launchTime, String availabilityZone, String virtualizationType, String platform, String privateDnsName, String privateIpAddress, String ramdiskId, String reason, RootDeviceType rootDeviceType, String rootDeviceName, Map<String,BlockDevice> ebsBlockDevices, Map<String,String> tags)

Methods
Modifier and Type	Method and Description
`static RunningInstance.Builder<?>`	`builder()`
`int`	`compareTo(RunningInstance other)`
`boolean`	`equals(Object obj)`
`String`	`getAmiLaunchIndex()` The AMI launch index, which can be used to find this instance within the launch group.
`String`	`getAvailabilityZone()` The location where the instance launched.
`String`	`getDnsName()` The public DNS name assigned to the instance.
`Map<String,BlockDevice>`	`getEbsBlockDevices()` EBS volumes associated with the instance.
`Set<String>`	`getGroupNames()` Names of the security groups.
`String`	`getId()` Unique ID of the instance launched.
`String`	`getImageId()` Image ID of the AMI used to launch the instance.
`InstanceState`	`getInstanceState()` The current state of the instance.
`String`	`getInstanceType()` The instance type.
`String`	`getIpAddress()` Specifies the IP address of the instance.
`String`	`getKernelId()` Optional.
`String`	`getKeyName()` If this instance was launched with an associated key pair, this displays the key pair name.
`Date`	`getLaunchTime()` The time the instance launched.
`String`	`getPlatform()` Platform of the instance (e.g., Windows).
`String`	`getPrivateDnsName()` The private DNS name assigned to the instance.
`String`	`getPrivateIpAddress()` Specifies the private IP address that is assigned to the instance (Amazon VPC).
`String`	`getRamdiskId()` Optional.
`String`	`getRawState()` The current state of the instance, as returned literally from the input XML
`String`	`getReason()` Reason for the most recent state transition.
`String`	`getRegion()` Deprecated.
`String`	`getRootDeviceName()`
`RootDeviceType`	`getRootDeviceType()`
`Map<String,String>`	`getTags()` tags that are present in the instance
`String`	`getVirtualizationType()` Specifies the instance's virtualization type.
`int`	`hashCode()`
`protected com.google.common.base.Objects.ToStringHelper`	`string()`
`RunningInstance.Builder<?>`	`toBuilder()`
`String`	`toString()`

java.lang.Object
- org.jclouds.ec2.domain.RunningInstance

All Implemented Interfaces:

Comparable<RunningInstance>

Direct Known Subclasses:

AWSRunningInstance
```
public class RunningInstance
extends Object
implements Comparable<RunningInstance>
```
Author:

Adrian Cole

See Also:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RunningInstance.Builder<T extends RunningInstance.Builder<T>>

Field Summary

Fields
Modifier and Type Field and Description

protected String amiLaunchIndex

protected String availabilityZone

protected String dnsName

protected Map<String,BlockDevice> ebsBlockDevices

protected Set<String> groupNames

protected String imageId

protected String instanceId

protected InstanceState instanceState

protected String instanceType

protected String ipAddress

protected String kernelId

protected String keyName

protected Date launchTime

protected String platform

protected String privateDnsName

protected String privateIpAddress

protected String ramdiskId

protected String rawState

protected String reason

protected String region

protected String rootDeviceName

protected RootDeviceType rootDeviceType

protected Map<String,String> tags

protected String virtualizationType

Constructor Summary

Constructors
Modifier Constructor and Description

protected RunningInstance(String region, Iterable<String> groupNames, String amiLaunchIndex, String dnsName, String imageId, String instanceId, InstanceState instanceState, String rawState, String instanceType, String ipAddress, String kernelId, String keyName, Date launchTime, String availabilityZone, String virtualizationType, String platform, String privateDnsName, String privateIpAddress, String ramdiskId, String reason, RootDeviceType rootDeviceType, String rootDeviceName, Map<String,BlockDevice> ebsBlockDevices, Map<String,String> tags)

Method Summary

Methods
Modifier and Type Method and Description

static RunningInstance.Builder<?> builder()

int compareTo(RunningInstance other)

boolean equals(Object obj)

String getAmiLaunchIndex()
The AMI launch index, which can be used to find this instance within the launch group.

String getAvailabilityZone()
The location where the instance launched.

String getDnsName()
The public DNS name assigned to the instance.

Map<String,BlockDevice> getEbsBlockDevices()
EBS volumes associated with the instance.

Set<String> getGroupNames()
Names of the security groups.

String getId()
Unique ID of the instance launched.

String getImageId()
Image ID of the AMI used to launch the instance.

InstanceState getInstanceState()
The current state of the instance.

String getInstanceType()
The instance type.

String getIpAddress()
Specifies the IP address of the instance.

String getKernelId()
Optional.

String getKeyName()
If this instance was launched with an associated key pair, this displays the key pair name.

Date getLaunchTime()
The time the instance launched.

String getPlatform()
Platform of the instance (e.g., Windows).

String getPrivateDnsName()
The private DNS name assigned to the instance.

String getPrivateIpAddress()
Specifies the private IP address that is assigned to the instance (Amazon VPC).

String getRamdiskId()
Optional.

String getRawState()
The current state of the instance, as returned literally from the input XML

String getReason()
Reason for the most recent state transition.

String getRegion()
Deprecated.

String getRootDeviceName()

RootDeviceType getRootDeviceType()

Map<String,String> getTags()
tags that are present in the instance

String getVirtualizationType()
Specifies the instance's virtualization type.

int hashCode()

protected com.google.common.base.Objects.ToStringHelper string()

RunningInstance.Builder<?> toBuilder()

String toString()

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

Field Detail

region
```
protected final String region
```

groupNames
```
protected final Set<String> groupNames
```

amiLaunchIndex
```
protected final String amiLaunchIndex
```

dnsName

@Nullable
protected final String dnsName

imageId
```
protected final String imageId
```

instanceId
```
protected final String instanceId
```

instanceState

protected final InstanceState instanceState

rawState
```
protected final String rawState
```

instanceType
```
protected final String instanceType
```

ipAddress

@Nullable
protected final String ipAddress

kernelId

@Nullable
protected final String kernelId

keyName

@Nullable
protected final String keyName

launchTime
```
protected final Date launchTime
```

availabilityZone

protected final String availabilityZone

virtualizationType

protected final String virtualizationType

platform

@Nullable
protected final String platform

privateDnsName

@Nullable
protected final String privateDnsName

privateIpAddress

@Nullable
protected final String privateIpAddress

ramdiskId

@Nullable
protected final String ramdiskId

reason

@Nullable
protected final String reason

rootDeviceType

protected final RootDeviceType rootDeviceType

rootDeviceName

@Nullable
protected final String rootDeviceName

ebsBlockDevices

protected final Map<String,BlockDevice> ebsBlockDevices

Constructor Detail

RunningInstance

protected RunningInstance(String region,
               Iterable<String> groupNames,
               @Nullable
               String amiLaunchIndex,
               @Nullable
               String dnsName,
               String imageId,
               String instanceId,
               InstanceState instanceState,
               String rawState,
               String instanceType,
               @Nullable
               String ipAddress,
               @Nullable
               String kernelId,
               @Nullable
               String keyName,
               Date launchTime,
               String availabilityZone,
               String virtualizationType,
               @Nullable
               String platform,
               @Nullable
               String privateDnsName,
               @Nullable
               String privateIpAddress,
               @Nullable
               String ramdiskId,
               @Nullable
               String reason,
               RootDeviceType rootDeviceType,
               @Nullable
               String rootDeviceName,
               Map<String,BlockDevice> ebsBlockDevices,
               Map<String,String> tags)

Method Detail
- builder
```
public static RunningInstance.Builder<?> builder()
```
- toBuilder
```
public RunningInstance.Builder<?> toBuilder()
```
- getRegion
```
@Deprecated
public String getRegion()
```
  Deprecated.
  
  To be removed in jclouds 1.6
  Warning
  Especially on EC2 clones that may not support regions, this value is fragile. Consider alternate means to determine context.
- getAmiLaunchIndex
```
public String getAmiLaunchIndex()
```
  The AMI launch index, which can be used to find this instance within the launch group. For more information, go to the Metadata section of the Amazon Elastic Compute Cloud Developer Guide.
  
  See Also:
- getDnsName
```
public String getDnsName()
```
  The public DNS name assigned to the instance. This DNS name is contactable from outside the Amazon EC2 network. This element remains empty until the instance enters a running state.
- getImageId
```
public String getImageId()
```
  Image ID of the AMI used to launch the instance.
- getId
```
public String getId()
```
  Unique ID of the instance launched.
- getInstanceState
```
public InstanceState getInstanceState()
```
  The current state of the instance.
- getRawState
```
public String getRawState()
```
  The current state of the instance, as returned literally from the input XML
- getInstanceType
```
public String getInstanceType()
```
  The instance type.
- getIpAddress
```
public String getIpAddress()
```
  Specifies the IP address of the instance.
- getKernelId
```
public String getKernelId()
```
  Optional. Kernel associated with this instance.
- getKeyName
```
public String getKeyName()
```
  If this instance was launched with an associated key pair, this displays the key pair name.
- getLaunchTime
```
public Date getLaunchTime()
```
  The time the instance launched.
- getAvailabilityZone
```
public String getAvailabilityZone()
```
  The location where the instance launched.
- getVirtualizationType
```
public String getVirtualizationType()
```
  Specifies the instance's virtualization type. Valid values are paravirtual or hvm.
- getPlatform
```
public String getPlatform()
```
  Platform of the instance (e.g., Windows).
- getPrivateDnsName
```
public String getPrivateDnsName()
```
  The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This element remains empty until the instance enters a running state.
- getPrivateIpAddress
```
public String getPrivateIpAddress()
```
  Specifies the private IP address that is assigned to the instance (Amazon VPC).
- getRamdiskId
```
public String getRamdiskId()
```
  Optional. RAM disk associated with this instance.
- getReason
```
public String getReason()
```
  Reason for the most recent state transition. This might be an empty string.
- getRootDeviceType
```
public RootDeviceType getRootDeviceType()
```
- getRootDeviceName
```
public String getRootDeviceName()
```
- getEbsBlockDevices
```
public Map<String,BlockDevice> getEbsBlockDevices()
```
  EBS volumes associated with the instance.
- getGroupNames
```
public Set<String> getGroupNames()
```
  Names of the security groups.
- getTags
```
public Map<String,String> getTags()
```
  tags that are present in the instance
- compareTo
```
public int compareTo(RunningInstance other)
```
  Specified by:
  
  compareTo in interface Comparable<RunningInstance>
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- string
```
protected com.google.common.base.Objects.ToStringHelper string()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class RunningInstance

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

region

groupNames

amiLaunchIndex

dnsName

imageId

instanceId

instanceState

rawState

instanceType

ipAddress

kernelId

keyName

launchTime

availabilityZone

virtualizationType

platform

privateDnsName

privateIpAddress

ramdiskId

reason

rootDeviceType

rootDeviceName

ebsBlockDevices

tags

Constructor Detail

RunningInstance

Method Detail

builder

toBuilder

getRegion

Warning

getAmiLaunchIndex

getDnsName

getImageId

getId

getInstanceState

getRawState

getInstanceType

getIpAddress

getKernelId

getKeyName

getLaunchTime

getAvailabilityZone

getVirtualizationType

getPlatform

getPrivateDnsName

getPrivateIpAddress

getRamdiskId

getReason

getRootDeviceType

getRootDeviceName

getEbsBlockDevices

getGroupNames

getTags

compareTo

hashCode

equals

string

toString