VmMetaData (Cloudex-core Library 1.0.0 API)

java.lang.Object
- io.cloudex.framework.cloud.entities.VmMetaData

```
public class VmMetaData
extends Object
```
A collection of cloud instance metadata used by cloudex.

Author:

Omer Dawelbeit (omerio)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLOUDEX_EXCEPTION`
`static String`	`CLOUDEX_MESSAGE`
`static String`	`CLOUDEX_PREFIX`
`static String`	`CLOUDEX_STATUS`
`static String`	`CLOUDEX_TASK_CLASS`
`static String`	`CLOUDEX_TASK_CODE_TYPE`
`static String`	`CLOUDEX_TASK_CODE_URL`
`static String`	`CLOUDEX_VM_PREFIX`
`static String`	`LONG_METADATA_FILE_Suffix`
`static String`	`USER_PREFIX`

Constructor Summary

Constructors
Constructor and Description

VmMetaData()

VmMetaData(Map<String,Object> attributes)

VmMetaData(Map<String,Object> attributes, String fingerprint)

Constructors
Constructor and Description
`VmMetaData()`
`VmMetaData(Map<String,Object> attributes)`
`VmMetaData(Map<String,Object> attributes, String fingerprint)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VmMetaData`	`addUserValue(String key, String value)` add a user value to the metadata, return this instance for chaining
`VmMetaData`	`addUserValues(Map<String,String> values)` Add a map of user values to the metadata, return this instance for chaining
`VmMetaData`	`addValue(String key, String value)` add a value to the metadata, return this instance for chaining
`void`	`clearValues()`
`void`	`exceptionToCloudExError(Exception exception)` From an exception populate a cloudex metadata error
`Map<String,Object>`	`getAttributes()`
`String`	`getException()` Get the exception if any
`String`	`getFingerprint()`
`VmMetaData`	`getFollowUp(VmMetaData followUp)` Some cloud providers require that a follow up metadata to contain a fingerprint signature
`String`	`getMessage()` Get the message if any
`ProcessorStatus`	`getProcessorStatus()` Get the processor status enum value
`String`	`getStatus()` Get the status
`String`	`getTaskClass()` Get the processor status
`CodeLocation`	`getTaskCodeType()` Get the task code type
`String`	`getTaskCodeUrl()` Get the url of the the task code, only if status is set to remote
`Map<String,String>`	`getUserMetaData()` Return a map of all the user meta data
`String`	`getValue(String key)`
`void`	`setException(Exception exp)` Sets the exception class name
`void`	`setFingerprint(String fingerprint)`
`void`	`setMessage(String message)` Sets the processor error message
`void`	`setProcessorStatus(ProcessorStatus status)` Set the processor status in this metadata
`void`	`setTaskClass(String taskClass)` Set the processor task class
`void`	`setTaskCodeType(CodeLocation codeType)` Set the processor code location type
`String`	`toString()`

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

- Field Detail
  - LONG_METADATA_FILE_Suffix
```
public static final String LONG_METADATA_FILE_Suffix
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_PREFIX
```
public static final String CLOUDEX_PREFIX
```
    See Also:
    
    Constant Field Values
  - USER_PREFIX
```
public static final String USER_PREFIX
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_VM_PREFIX
```
public static final String CLOUDEX_VM_PREFIX
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_TASK_CLASS
```
public static final String CLOUDEX_TASK_CLASS
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_TASK_CODE_TYPE
```
public static final String CLOUDEX_TASK_CODE_TYPE
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_TASK_CODE_URL
```
public static final String CLOUDEX_TASK_CODE_URL
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_STATUS
```
public static final String CLOUDEX_STATUS
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_EXCEPTION
```
public static final String CLOUDEX_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - CLOUDEX_MESSAGE
```
public static final String CLOUDEX_MESSAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VmMetaData
```
public VmMetaData()
```
  - VmMetaData
```
public VmMetaData(Map<String,Object> attributes)
```
    Parameters:
    
    attributes -
  - VmMetaData
```
public VmMetaData(Map<String,Object> attributes,
                  String fingerprint)
```
    Parameters:
    
    attributes -
- Method Detail
  - getStatus
```
public String getStatus()
```
    Get the status
    
    Returns:
  - getProcessorStatus
```
public ProcessorStatus getProcessorStatus()
```
    Get the processor status enum value
    
    Returns:
  - setProcessorStatus
```
public void setProcessorStatus(ProcessorStatus status)
```
    Set the processor status in this metadata
    
    Parameters:
    
    status - - the process status ProcessorStatus
  - getTaskCodeType
```
public CodeLocation getTaskCodeType()
```
    Get the task code type
    
    Returns:
  - setTaskCodeType
```
public void setTaskCodeType(CodeLocation codeType)
```
    Set the processor code location type
    
    Parameters:
    
    codeType - - the code location CodeLocation
  - getTaskClass
```
public String getTaskClass()
```
    Get the processor status
    
    Returns:
  - setTaskClass
```
public void setTaskClass(String taskClass)
```
    Set the processor task class
    
    Parameters:
    
    taskClass - - the class name to set
  - getTaskCodeUrl
```
public String getTaskCodeUrl()
```
    Get the url of the the task code, only if status is set to remote
    
    Returns:
  - getException
```
public String getException()
```
    Get the exception if any
    
    Returns:
  - setException
```
public void setException(Exception exp)
```
    Sets the exception class name
    
    Parameters:
    
    exp - - the exception
  - getMessage
```
public String getMessage()
```
    Get the message if any
    
    Returns:
  - setMessage
```
public void setMessage(String message)
```
    Sets the processor error message
    
    Parameters:
    
    message - - the error message
  - exceptionToCloudExError
```
public void exceptionToCloudExError(Exception exception)
```
    From an exception populate a cloudex metadata error
    
    Parameters:
    
    exception - - the exception
  - getUserMetaData
```
public Map<String,String> getUserMetaData()
```
    Return a map of all the user meta data
    
    Returns:
    
    the user provided attributes
  - getValue
```
public String getValue(String key)
```
    Parameters:
    
    key -
    
    Returns:
  - addValue
```
public VmMetaData addValue(String key,
                           String value)
```
    add a value to the metadata, return this instance for chaining
    
    Parameters:
    
    key -
    
    value -
  - addUserValue
```
public VmMetaData addUserValue(String key,
                               String value)
```
    add a user value to the metadata, return this instance for chaining
    
    Parameters:
    
    key -
    
    value -
  - addUserValues
```
public VmMetaData addUserValues(Map<String,String> values)
```
    Add a map of user values to the metadata, return this instance for chaining
    
    Parameters:
    
    values - - the values map
    
    Returns:
    
    this instance VmMetaData
  - clearValues
```
public void clearValues()
```
    See Also:
    
    Map.clear()
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Returns:
    
    the attributes
  - getFingerprint
```
public String getFingerprint()
```
    Returns:
    
    the fingerprint
  - setFingerprint
```
public void setFingerprint(String fingerprint)
```
    Parameters:
    
    fingerprint - the fingerprint to set
  - getFollowUp
```
public VmMetaData getFollowUp(VmMetaData followUp)
```
    Some cloud providers require that a follow up metadata to contain a fingerprint signature
    
    Parameters:
    
    followUp - - the metadata to update
    
    Returns:
    
    metadata with fingerprint populated
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class VmMetaData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LONG_METADATA_FILE_Suffix

CLOUDEX_PREFIX

USER_PREFIX

CLOUDEX_VM_PREFIX

CLOUDEX_TASK_CLASS

CLOUDEX_TASK_CODE_TYPE

CLOUDEX_TASK_CODE_URL

CLOUDEX_STATUS

CLOUDEX_EXCEPTION

CLOUDEX_MESSAGE

Constructor Detail

VmMetaData

VmMetaData

VmMetaData

Method Detail

getStatus

getProcessorStatus

setProcessorStatus

getTaskCodeType

setTaskCodeType

getTaskClass

setTaskClass

getTaskCodeUrl

getException

setException

getMessage

setMessage

exceptionToCloudExError

getUserMetaData

getValue

addValue

addUserValue

addUserValues

clearValues

getAttributes

getFingerprint

setFingerprint

getFollowUp

toString