CoreService

<back to all web services

GetDeployment

Deployment - CRUD

Returns a deployment by its ID

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
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.*;

public class dtos
{

    /**
    * Returns a deployment by its ID
    */
    @Api(Description="Returns a deployment by its ID")
    @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=DeploymentDto.class, StatusCode=200)
    public static class GetDeployment implements IGetSingleRequest, IHasTenantName, IGet
    {
        @ApiMember(DataType="string", Format="guid", IsRequired=true, ParameterType="path")
        public UUID id = null;

        @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        @Validate(Validator="NotEmpty")
        public String tenantName = null;

        @ApiMember(ParameterType="query", Verb="GET")
        public Boolean includeReferencedObjects = null;

        /**
        * If true, also soft deleted items will be returned
        */
        @ApiMember(Description="If true, also soft deleted items will be returned", ParameterType="query")
        public Boolean includeDeleted = null;
        
        public UUID getId() { return id; }
        public GetDeployment setId(UUID value) { this.id = value; return this; }
        public String getTenantName() { return tenantName; }
        public GetDeployment setTenantName(String value) { this.tenantName = value; return this; }
        public Boolean isIncludeReferencedObjects() { return includeReferencedObjects; }
        public GetDeployment setIncludeReferencedObjects(Boolean value) { this.includeReferencedObjects = value; return this; }
        public Boolean isIncludeDeleted() { return includeDeleted; }
        public GetDeployment setIncludeDeleted(Boolean value) { this.includeDeleted = value; return this; }
    }

    public static class DeploymentDto extends ConfigItemDto implements IHasParentDto, IHasTenantId, IEnvironmentSpecific
    {
        /**
        * The operational state of the deployment (Running, Stopped, None, Unknown)
        */
        public OperationalStates operationalState = null;
        /**
        * How many start/stop-capable resources are currently running
        */
        public Integer resourcesRunning = null;
        /**
        * Total number of start/stop-capable resources in this deployment
        */
        public Integer resourcesTotal = null;
        /**
        * Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3
        */
        public String shortId = null;
        /**
        * The user defined part of the name property {userDefined}_{environment}
        */
        public String nameUserDefinedPart = null;
        /**
        * The id of the tenant
        */
        public UUID tenantId = null;
        /**
        * The state of the deployment
        */
        public LifecycleStates state = null;
        /**
        * The environment the deployment is deployed in
        */
        public Environments environment = null;
        /**
        * The id of the template which was used to create the deployment
        */
        public UUID templateId = null;
        /**
        * Shows if a deployment was rolled out through a dune template or not
        */
        public Boolean isTemplateBased = null;
        /**
        * The parameters which were used to create this deployment
        */
        public IList<ParameterDto> parameters = null;
        /**
        * A deployment scoped list of variables used for deployment of resources
        */
        public IList<VariableDto> variables = null;
        /**
        * A snapshot of the varialbs used to create the deployment
        */
        public IList<VariableDto> variablesSnapshot = null;
        /**
        * The id of the parent (collection) of the deployment
        */
        public UUID parentId = null;
        /**
        * The parent (collection) of the deployment
        */
        public ConfigItemDto parent = null;
        /**
        * The Date when the resources got deployed
        */
        public Date validFrom = null;
        /**
        * The Date when the deployment expires and has to be reevaluated
        */
        public Date validUntil = null;
        /**
        * The deployment will never expire
        */
        public Boolean isNeverExpiring = null;
        /**
        * The date, when the deployments resources will receive updates
        */
        public Date nextPatchDate = null;
        /**
        * The default resource provider where the resources are deployed
        */
        public UUID defaultResourceProviderId = null;
        /**
        * Deployments which have issues in Jobs are marked with NeedsAttention
        */
        public Boolean needsAttention = null;
        /**
        * Composition show if all resources in the deployment are dune native, dune foreign or a mix of both
        */
        public ResourceCompositions composition = null;
        /**
        * The monthly cost budget for the whole collection
        */
        public BigDecimal monthlyBudget = null;
        /**
        * Whether to send budget information mails to the collection owners
        */
        public Boolean sendBudgetNotificationMails = null;
        /**
        * A threshold, when to send the first budget warning mail
        */
        public Integer budgetWarningThresholdPercent = null;
        public IList<LinkDto> links = null;
        
        public OperationalStates getOperationalState() { return operationalState; }
        public DeploymentDto setOperationalState(OperationalStates value) { this.operationalState = value; return this; }
        public Integer getResourcesRunning() { return resourcesRunning; }
        public DeploymentDto setResourcesRunning(Integer value) { this.resourcesRunning = value; return this; }
        public Integer getResourcesTotal() { return resourcesTotal; }
        public DeploymentDto setResourcesTotal(Integer value) { this.resourcesTotal = value; return this; }
        public String getShortId() { return shortId; }
        public DeploymentDto setShortId(String value) { this.shortId = value; return this; }
        public String getNameUserDefinedPart() { return nameUserDefinedPart; }
        public DeploymentDto setNameUserDefinedPart(String value) { this.nameUserDefinedPart = value; return this; }
        public UUID getTenantId() { return tenantId; }
        public DeploymentDto setTenantId(UUID value) { this.tenantId = value; return this; }
        public LifecycleStates getState() { return state; }
        public DeploymentDto setState(LifecycleStates value) { this.state = value; return this; }
        public Environments getEnvironment() { return environment; }
        public DeploymentDto setEnvironment(Environments value) { this.environment = value; return this; }
        public UUID getTemplateId() { return templateId; }
        public DeploymentDto setTemplateId(UUID value) { this.templateId = value; return this; }
        public Boolean getIsTemplateBased() { return isTemplateBased; }
        public DeploymentDto setIsTemplateBased(Boolean value) { this.isTemplateBased = value; return this; }
        public IList<ParameterDto> getParameters() { return parameters; }
        public DeploymentDto setParameters(IList<ParameterDto> value) { this.parameters = value; return this; }
        public IList<VariableDto> getVariables() { return variables; }
        public DeploymentDto setVariables(IList<VariableDto> value) { this.variables = value; return this; }
        public IList<VariableDto> getVariablesSnapshot() { return variablesSnapshot; }
        public DeploymentDto setVariablesSnapshot(IList<VariableDto> value) { this.variablesSnapshot = value; return this; }
        public UUID getParentId() { return parentId; }
        public DeploymentDto setParentId(UUID value) { this.parentId = value; return this; }
        public ConfigItemDto getParent() { return parent; }
        public DeploymentDto setParent(ConfigItemDto value) { this.parent = value; return this; }
        public Date getValidFrom() { return validFrom; }
        public DeploymentDto setValidFrom(Date value) { this.validFrom = value; return this; }
        public Date getValidUntil() { return validUntil; }
        public DeploymentDto setValidUntil(Date value) { this.validUntil = value; return this; }
        public Boolean getIsNeverExpiring() { return isNeverExpiring; }
        public DeploymentDto setIsNeverExpiring(Boolean value) { this.isNeverExpiring = value; return this; }
        public Date getNextPatchDate() { return nextPatchDate; }
        public DeploymentDto setNextPatchDate(Date value) { this.nextPatchDate = value; return this; }
        public UUID getDefaultResourceProviderId() { return defaultResourceProviderId; }
        public DeploymentDto setDefaultResourceProviderId(UUID value) { this.defaultResourceProviderId = value; return this; }
        public Boolean isNeedsAttention() { return needsAttention; }
        public DeploymentDto setNeedsAttention(Boolean value) { this.needsAttention = value; return this; }
        public ResourceCompositions getComposition() { return composition; }
        public DeploymentDto setComposition(ResourceCompositions value) { this.composition = value; return this; }
        public BigDecimal getMonthlyBudget() { return monthlyBudget; }
        public DeploymentDto setMonthlyBudget(BigDecimal value) { this.monthlyBudget = value; return this; }
        public Boolean isSendBudgetNotificationMails() { return sendBudgetNotificationMails; }
        public DeploymentDto setSendBudgetNotificationMails(Boolean value) { this.sendBudgetNotificationMails = value; return this; }
        public Integer getBudgetWarningThresholdPercent() { return budgetWarningThresholdPercent; }
        public DeploymentDto setBudgetWarningThresholdPercent(Integer value) { this.budgetWarningThresholdPercent = value; return this; }
        public IList<LinkDto> getLinks() { return links; }
        public DeploymentDto setLinks(IList<LinkDto> value) { this.links = value; return this; }
    }

    public static class ConfigItemDto implements IConfigItem
    {
        public UUID id = null;
        public String name = null;
        public String displayName = null;
        public String description = null;
        public ObjectTypes objectType = null;
        public String selfLink = null;
        public IList<TagDto> tags = null;
        public IList<PathItemDto> path = null;
        public Date created = null;
        public String createUser = null;
        public String createUserId = null;
        public Date modified = null;
        public String modifyUser = null;
        public String modifyUserId = null;
        public Boolean isDeleted = null;
        public Date deleted = null;
        public String deleteUser = null;
        public String deleteUserId = null;
        public IList<LinkDto> links = null;
        
        public UUID getId() { return id; }
        public ConfigItemDto setId(UUID value) { this.id = value; return this; }
        public String getName() { return name; }
        public ConfigItemDto setName(String value) { this.name = value; return this; }
        public String getDisplayName() { return displayName; }
        public ConfigItemDto setDisplayName(String value) { this.displayName = value; return this; }
        public String getDescription() { return description; }
        public ConfigItemDto setDescription(String value) { this.description = value; return this; }
        public ObjectTypes getObjectType() { return objectType; }
        public ConfigItemDto setObjectType(ObjectTypes value) { this.objectType = value; return this; }
        public String getSelfLink() { return selfLink; }
        public ConfigItemDto setSelfLink(String value) { this.selfLink = value; return this; }
        public IList<TagDto> getTags() { return tags; }
        public ConfigItemDto setTags(IList<TagDto> value) { this.tags = value; return this; }
        public IList<PathItemDto> getPath() { return path; }
        public ConfigItemDto setPath(IList<PathItemDto> value) { this.path = value; return this; }
        public Date getCreated() { return created; }
        public ConfigItemDto setCreated(Date value) { this.created = value; return this; }
        public String getCreateUser() { return createUser; }
        public ConfigItemDto setCreateUser(String value) { this.createUser = value; return this; }
        public String getCreateUserId() { return createUserId; }
        public ConfigItemDto setCreateUserId(String value) { this.createUserId = value; return this; }
        public Date getModified() { return modified; }
        public ConfigItemDto setModified(Date value) { this.modified = value; return this; }
        public String getModifyUser() { return modifyUser; }
        public ConfigItemDto setModifyUser(String value) { this.modifyUser = value; return this; }
        public String getModifyUserId() { return modifyUserId; }
        public ConfigItemDto setModifyUserId(String value) { this.modifyUserId = value; return this; }
        public Boolean getIsDeleted() { return isDeleted; }
        public ConfigItemDto setIsDeleted(Boolean value) { this.isDeleted = value; return this; }
        public Date getDeleted() { return deleted; }
        public ConfigItemDto setDeleted(Date value) { this.deleted = value; return this; }
        public String getDeleteUser() { return deleteUser; }
        public ConfigItemDto setDeleteUser(String value) { this.deleteUser = value; return this; }
        public String getDeleteUserId() { return deleteUserId; }
        public ConfigItemDto setDeleteUserId(String value) { this.deleteUserId = value; return this; }
        public IList<LinkDto> getLinks() { return links; }
        public ConfigItemDto setLinks(IList<LinkDto> value) { this.links = value; return this; }
    }

    public static enum 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;
    }

    public static class TagDto
    {
        public String name = null;
        public String value = null;
        public Boolean isProtected = null;
        
        public String getName() { return name; }
        public TagDto setName(String value) { this.name = value; return this; }
        public String getValue() { return value; }
        public TagDto setValue(String value) { this.value = value; return this; }
        public Boolean getIsProtected() { return isProtected; }
        public TagDto setIsProtected(Boolean value) { this.isProtected = value; return this; }
    }

    public static class PathItemDto
    {
        public String label = null;
        public String link = null;
        public ObjectTypes objectType = null;
        public UUID objectId = null;
        
        public String getLabel() { return label; }
        public PathItemDto setLabel(String value) { this.label = value; return this; }
        public String getLink() { return link; }
        public PathItemDto setLink(String value) { this.link = value; return this; }
        public ObjectTypes getObjectType() { return objectType; }
        public PathItemDto setObjectType(ObjectTypes value) { this.objectType = value; return this; }
        public UUID getObjectId() { return objectId; }
        public PathItemDto setObjectId(UUID value) { this.objectId = value; return this; }
    }

    public static class LinkDto
    {
        public String caption = null;
        public String rel = null;
        public String hRef = null;
        public String method = null;
        
        public String getCaption() { return caption; }
        public LinkDto setCaption(String value) { this.caption = value; return this; }
        public String getRel() { return rel; }
        public LinkDto setRel(String value) { this.rel = value; return this; }
        public String getHRef() { return hRef; }
        public LinkDto setHRef(String value) { this.hRef = value; return this; }
        public String getMethod() { return method; }
        public LinkDto setMethod(String value) { this.method = value; return this; }
    }

    public static enum OperationalStates
    {
        None,
        Starting,
        Running,
        Stopping,
        Stopped,
        Restarting,
        Deleting,
        Unknown;
    }

    public static enum LifecycleStates
    {
        New,
        Deploying,
        Deployed,
        Removing,
        Removed,
        Failure,
        Imported;
    }

    public static enum Environments
    {
        Lab,
        Poc,
        Dev,
        Test,
        Int,
        Uat,
        Prod;
    }

    public static class ParameterDto
    {
        public String name = null;
        public String description = null;
        /**
        * Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes
        */
        public String value = null;
        /**
        * Optional default value for the frontend. Needs to be in the same format as the value
        */
        @SerializedName("default") public String Default = null;
        /**
        * Optional parameters do not need to have a value. Default -> Optional=false
        */
        public Boolean optional = null;
        /**
        * The data type of the value and default property
        */
        public ParameterValueType type = null;
        public String validation = null;
        
        public String getName() { return name; }
        public ParameterDto setName(String value) { this.name = value; return this; }
        public String getDescription() { return description; }
        public ParameterDto setDescription(String value) { this.description = value; return this; }
        public String getValue() { return value; }
        public ParameterDto setValue(String value) { this.value = value; return this; }
        public String getDefault() { return Default; }
        public ParameterDto setDefault(String value) { this.Default = value; return this; }
        public Boolean isOptional() { return optional; }
        public ParameterDto setOptional(Boolean value) { this.optional = value; return this; }
        public ParameterValueType getType() { return type; }
        public ParameterDto setType(ParameterValueType value) { this.type = value; return this; }
        public String getValidation() { return validation; }
        public ParameterDto setValidation(String value) { this.validation = value; return this; }
    }

    public static enum ParameterValueType
    {
        String,
        Number,
        Boolean,
        SecureString;
    }

    public static class VariableDto
    {
        public String name = 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
        */
        public String value = null;
        /**
        * The data type of the value property
        */
        public ValueDataType type = null;
        public String description = null;
        public Boolean isInherited = null;
        public Environments environment = null;
        
        public String getName() { return name; }
        public VariableDto setName(String value) { this.name = value; return this; }
        public String getValue() { return value; }
        public VariableDto setValue(String value) { this.value = value; return this; }
        public ValueDataType getType() { return type; }
        public VariableDto setType(ValueDataType value) { this.type = value; return this; }
        public String getDescription() { return description; }
        public VariableDto setDescription(String value) { this.description = value; return this; }
        public Boolean getIsInherited() { return isInherited; }
        public VariableDto setIsInherited(Boolean value) { this.isInherited = value; return this; }
        public Environments getEnvironment() { return environment; }
        public VariableDto setEnvironment(Environments value) { this.environment = value; return this; }
    }

    public static enum ValueDataType
    {
        String,
        Number,
        Boolean,
        List;
    }

    public static enum ResourceCompositions
    {
        Native,
        Foreign,
        Mixed;
    }

}

Java GetDeployment DTOs

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

HTTP + JSON

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"}