RestKey (Atlassian Bamboo 9.6.2 API)

java.lang.Object
- com.atlassian.bamboo.rest.model.RestKey

All Implemented Interfaces:

DeploymentKey, Key, Serializable
```
public class RestKey
extends Object
implements Key, DeploymentKey
```
Used to represent a Key object in rest. For soy etc we need to mimic the object structure of the actual Key e.g. the get the string from a key object in freemarker it would look like this: "myObject.key.key". So we cannot convert it directly to a string. For Deployments you can use this object directly, for PlanKeys you can use the PlanKeyRestKeyAdapter.

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  RestKey()
  
  RestKey(Key key)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  @NotNull String getKey()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestKey
```
public RestKey(Key key)
```

RestKey
```
public RestKey()
```

Method Detail
- getKey
```
@NotNull
public @NotNull String getKey()
```
  Specified by:
  
  getKey in interface Key