| Required role: | TenantReader |
| GET | /api/deployments/{Id} | Returns a deployment | |
|---|---|---|---|
| GET | /deployments/{Id} | Returns a deployment |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Returns a deployment by its ID
*/
@Api(Description="Returns a deployment by its ID")
@ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=DeploymentDto::class, StatusCode=200)
open class GetDeployment : IGetSingleRequest, IHasTenantName, IGet
{
@ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
open var id:UUID? = null
@ApiMember(DataType="string", IsRequired=true, ParameterType="header")
@Validate(Validator="NotEmpty")
override var tenantName:String? = null
@ApiMember(ParameterType="query", Verb="GET")
override var includeReferencedObjects:Boolean? = null
/**
* If true, also soft deleted items will be returned
*/
@ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
override var includeDeleted:Boolean? = null
}
open class DeploymentDto : ConfigItemDto(), IHasParentDto, IHasTenantId, IEnvironmentSpecific
{
/**
* The operational state of the deployment (Running, Stopped, None, Unknown)
*/
open var operationalState:OperationalStates? = null
/**
* How many start/stop-capable resources are currently running
*/
open var resourcesRunning:Int? = null
/**
* Total number of start/stop-capable resources in this deployment
*/
open var resourcesTotal:Int? = null
/**
* Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3
*/
open var shortId:String? = null
/**
* The user defined part of the name property {userDefined}_{environment}
*/
open var nameUserDefinedPart:String? = null
/**
* The id of the tenant
*/
override var tenantId:UUID? = null
/**
* The state of the deployment
*/
open var state:LifecycleStates? = null
/**
* The environment the deployment is deployed in
*/
override var environment:Environments? = null
/**
* The id of the template which was used to create the deployment
*/
open var templateId:UUID? = null
/**
* Shows if a deployment was rolled out through a dune template or not
*/
open var isTemplateBased:Boolean? = null
/**
* The parameters which were used to create this deployment
*/
open var parameters:IList<ParameterDto>? = null
/**
* A deployment scoped list of variables used for deployment of resources
*/
open var variables:IList<VariableDto>? = null
/**
* A snapshot of the varialbs used to create the deployment
*/
open var variablesSnapshot:IList<VariableDto>? = null
/**
* The id of the parent (collection) of the deployment
*/
open var parentId:UUID? = null
/**
* The parent (collection) of the deployment
*/
override var parent:ConfigItemDto? = null
/**
* The Date when the resources got deployed
*/
open var validFrom:Date? = null
/**
* The Date when the deployment expires and has to be reevaluated
*/
open var validUntil:Date? = null
/**
* The deployment will never expire
*/
open var isNeverExpiring:Boolean? = null
/**
* The date, when the deployments resources will receive updates
*/
open var nextPatchDate:Date? = null
/**
* The default resource provider where the resources are deployed
*/
open var defaultResourceProviderId:UUID? = null
/**
* Deployments which have issues in Jobs are marked with NeedsAttention
*/
open var needsAttention:Boolean? = null
/**
* Composition show if all resources in the deployment are dune native, dune foreign or a mix of both
*/
open var composition:ResourceCompositions? = null
/**
* The monthly cost budget for the whole collection
*/
open var monthlyBudget:BigDecimal? = null
/**
* Whether to send budget information mails to the collection owners
*/
open var sendBudgetNotificationMails:Boolean? = null
/**
* A threshold, when to send the first budget warning mail
*/
open var budgetWarningThresholdPercent:Int? = null
override var links:IList<LinkDto>? = null
}
open class ConfigItemDto : IConfigItem
{
open var id:UUID? = null
open var name:String? = null
override var displayName:String? = null
override var description:String? = null
open var objectType:ObjectTypes? = null
override var selfLink:String? = null
override var tags:IList<TagDto>? = null
open var path:IList<PathItemDto>? = null
open var created:Date? = null
open var createUser:String? = null
open var createUserId:String? = null
open var modified:Date? = null
open var modifyUser:String? = null
open var modifyUserId:String? = null
open var isDeleted:Boolean? = null
open var deleted:Date? = null
open var deleteUser:String? = null
open var deleteUserId:String? = null
open var links:IList<LinkDto>? = null
}
enum class ObjectTypes
{
None,
ConfigItem,
Tenant,
Collection,
Resource,
ComputeNode,
VirtualMachine,
PhysicalMachine,
Disk,
Subnet,
IpAddress,
Job,
JobEvent,
FreezePeriod,
ResourceGroup,
Deployment,
ResourceGroupTemplate,
DeploymentTemplate,
ResourceProvider,
GenericResource,
Role,
Permission,
User,
PatchingWindow,
Update,
ReportDefinition,
TimeSeries,
DataPoint,
Action,
ActionAssignment,
UserNote,
}
open class TagDto
{
open var name:String? = null
open var value:String? = null
open var isProtected:Boolean? = null
}
open class PathItemDto
{
open var label:String? = null
open var link:String? = null
open var objectType:ObjectTypes? = null
open var objectId:UUID? = null
}
open class LinkDto
{
open var caption:String? = null
open var rel:String? = null
open var hRef:String? = null
open var method:String? = null
}
enum class OperationalStates
{
None,
Starting,
Running,
Stopping,
Stopped,
Restarting,
Deleting,
Unknown,
}
enum class LifecycleStates
{
New,
Deploying,
Deployed,
Removing,
Removed,
Failure,
Imported,
}
enum class Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
open class ParameterDto
{
open var name:String? = null
open var description:String? = null
/**
* Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
*/
open var value:String? = null
/**
* Optional default value for the frontend. Needs to be in the same format as the value
*/
@SerializedName("default") open var Default:String? = null
/**
* Optional parameters do not need to have a value. Default -> Optional=false
*/
open var optional:Boolean? = null
/**
* The data type of the value and default property
*/
@SerializedName("type") open var Type:ParameterValueType? = null
open var validation:String? = null
}
enum class ParameterValueType
{
String,
Number,
Boolean,
SecureString,
}
open class VariableDto
{
open var name:String? = null
/**
* Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes
*/
open var value:String? = null
/**
* The data type of the value property
*/
@SerializedName("type") open var Type:ValueDataType? = null
open var description:String? = null
open var isInherited:Boolean? = null
open var environment:Environments? = null
}
enum class ValueDataType
{
String,
Number,
Boolean,
List,
}
enum class ResourceCompositions
{
Native,
Foreign,
Mixed,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/deployments/{Id} HTTP/1.1
Host: core.starburst.svc
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"shortId":"String","nameUserDefinedPart":"String","tenantId":"00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","links":null},"validFrom":"0001-01-01T00:00:00.0000000Z","validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","needsAttention":false,"composition":"Native","monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"index","hRef":"/deployments/","method":"GET"},{"caption":"Collection","rel":"up","hRef":"/collections/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resourcegroups","rel":"down","hRef":"/resourcegroups?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"}