CoreService

<back to all web services

GetDeploymentOperationalState

Deployment - CRUD

Get deployment operational state

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/deployments/{Id}/operationalstateGets a deployments operational state
GET/deployments/{Id}/operationalstateGets a deployments operational state
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get deployment operational state
    */
    @Api(Description="Get deployment operational state")
    @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=OperationalStates.class, StatusCode=200)
    public static class GetDeploymentOperationalState implements IBaseRequest, IHasId, 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;
        
        public UUID getId() { return id; }
        public GetDeploymentOperationalState setId(UUID value) { this.id = value; return this; }
        public String getTenantName() { return tenantName; }
        public GetDeploymentOperationalState setTenantName(String value) { this.tenantName = value; return this; }
    }

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

}

Java GetDeploymentOperationalState 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}/operationalstate HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

"None"