Package org.jclouds.openstack.nova.v2_0.domain

Class Server

java.lang.Object

org.jclouds.openstack.v2_0.domain.Resource

org.jclouds.openstack.nova.v2_0.domain.Server

All Implemented Interfaces:

Comparable<Resource>

Direct Known Subclasses:

ServerWithSecurityGroups

public class Server
extends Resource

A server is a virtual machine instance in the compute system. Flavor and image are requisite elements when creating a server.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Server.Builder<T extends Server.Builder<T>>
static class	Server.Status	Servers contain a status attribute that can be used as an indication of the current server state.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DISK_CONFIG_AUTO
static String	DISK_CONFIG_MANUAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Server(String id, String name, Set<Link> links, String uuid, String tenantId, String userId, Date updated, Date created, String hostId, String accessIPv4, String accessIPv6, Server.Status status, Resource image, Resource flavor, String keyName, String configDrive, com.google.common.collect.Multimap<String,Address> addresses, Map<String,String> metadata, ServerExtendedStatus extendedStatus, ServerExtendedAttributes extendedAttributes, String diskConfig, String availabilityZone)

Method Summary

Modifier and Type	Method	Description
static Server.Builder<?>	builder()
String	getAccessIPv4()
String	getAccessIPv6()
com.google.common.collect.Multimap<String,Address>	getAddresses()
com.google.common.base.Optional<String>	getAvailabilityZone()	return the Availability Zone of a server
String	getConfigDrive()
Date	getCreated()
com.google.common.base.Optional<String>	getDiskConfig()	Disk config attribute from the Disk Config Extension (alias "OS-DCF").
com.google.common.base.Optional<ServerExtendedAttributes>	getExtendedAttributes()	Retrieves the extended server attributes fields (alias "OS-EXT-SRV-ATTR")
com.google.common.base.Optional<ServerExtendedStatus>	getExtendedStatus()	Retrieves the extended server status fields (alias "OS-EXT-STS")
Resource	getFlavor()
String	getHostId()
Resource	getImage()
String	getKeyName()
Map<String,String>	getMetadata()
Server.Status	getStatus()
String	getTenantId()
Date	getUpdated()
String	getUserId()
String	getUuid()	only present until the id is in uuid form
protected com.google.common.base.MoreObjects.ToStringHelper	string()
Server.Builder<?>	toBuilder()

Methods inherited from class org.jclouds.openstack.v2_0.domain.Resource

compareTo, equals, getId, getLinks, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DISK_CONFIG_MANUAL

public static final String DISK_CONFIG_MANUAL

See Also:

Constant Field Values

DISK_CONFIG_AUTO

public static final String DISK_CONFIG_AUTO

See Also:

Constant Field Values

Constructor Detail

Server

@ConstructorProperties({"id","name","links","uuid","tenant_id","user_id","updated","created","hostId","accessIPv4","accessIPv6","status","image","flavor","key_name","config_drive","addresses","metadata","extendedStatus","extendedAttributes","OS-DCF:diskConfig","OS-EXT-AZ:availability_zone"})
protected Server(String id,
                 @Nullable
                 String name,
                 Set<Link> links,
                 @Nullable
                 String uuid,
                 String tenantId,
                 String userId,
                 @Nullable
                 Date updated,
                 Date created,
                 @Nullable
                 String hostId,
                 @Nullable
                 String accessIPv4,
                 @Nullable
                 String accessIPv6,
                 Server.Status status,
                 @Nullable
                 Resource image,
                 Resource flavor,
                 @Nullable
                 String keyName,
                 @Nullable
                 String configDrive,
                 com.google.common.collect.Multimap<String,Address> addresses,
                 Map<String,String> metadata,
                 @Nullable
                 ServerExtendedStatus extendedStatus,
                 @Nullable
                 ServerExtendedAttributes extendedAttributes,
                 @Nullable
                 String diskConfig,
                 @Nullable
                 String availabilityZone)

Method Detail

builder

public static Server.Builder<?> builder()

toBuilder

public Server.Builder<?> toBuilder()

Overrides:

toBuilder in class Resource

getUuid

@Nullable
public String getUuid()

only present until the id is in uuid form

Returns:

uuid, if id is an integer val

getTenantId

public String getTenantId()

getUserId

public String getUserId()

getUpdated

@Nullable
public Date getUpdated()

getCreated

public Date getCreated()

getHostId

@Nullable
public String getHostId()

Returns:

host identifier, or null if in Server.Status.BUILD

getAccessIPv4

@Nullable
public String getAccessIPv4()

getAccessIPv6

@Nullable
public String getAccessIPv6()

getStatus

public Server.Status getStatus()

getConfigDrive

@Nullable
public String getConfigDrive()

getImage

public Resource getImage()

getFlavor

public Resource getFlavor()

getMetadata

public Map<String,String> getMetadata()

getAddresses

public com.google.common.collect.Multimap<String,Address> getAddresses()

Returns:

the ip addresses assigned to the server

getKeyName

@Nullable
public String getKeyName()

Returns:

keyName if extension is present and there is a value for this server

See Also:

KeyPairApi

getExtendedStatus

public com.google.common.base.Optional<ServerExtendedStatus> getExtendedStatus()

Retrieves the extended server status fields (alias "OS-EXT-STS")

NOTE: This field is only present if the Extended Status extension is installed.

See Also:

org.jclouds.openstack.nova.v2_0.features.ExtensionApi#getExtensionByAlias, ExtensionNamespaces.EXTENDED_STATUS

getExtendedAttributes

public com.google.common.base.Optional<ServerExtendedAttributes> getExtendedAttributes()

Retrieves the extended server attributes fields (alias "OS-EXT-SRV-ATTR")

NOTE: This field is only present if the The Extended Server Attributes API extension is installed.

See Also:

org.jclouds.openstack.nova.v2_0.features.ExtensionApi#getExtensionByAlias, ExtensionNamespaces.EXTENDED_STATUS

getDiskConfig

public com.google.common.base.Optional<String> getDiskConfig()

Disk config attribute from the Disk Config Extension (alias "OS-DCF"). One of DISK_CONFIG_AUTO or DISK_CONFIG_MANUAL. This field is only present if the Disk Config extension is installed.

NOTE: Typically a field like this would be implemented as an enum but this field was originally implmented as a String and DISK_CONFIG_AUTO and DISK_CONFIG_MANUAL were added later as Strings to preserve backwards compatibility.

See Also:

org.jclouds.openstack.nova.v2_0.features.ExtensionApi#getExtensionByAlias, ExtensionNamespaces.DISK_CONFIG, CreateServerOptions#getDiskConfig()

getAvailabilityZone

@Nullable
public com.google.common.base.Optional<String> getAvailabilityZone()

return the Availability Zone of a server

See Also:

ExtensionNamespaces.AVAILABILITY_ZONE

string

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

Overrides:

string in class Resource