CoreService

<back to all web services

GenerateDeploymentName

Deployment - CRUD

Generate deployment name with the user defined part

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
PATCH/api/deployments/generation/nameGenerate deployment name with the user defined part
PATCH/deployments/generation/nameGenerate deployment name with the user defined part
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Generate deployment name with the user defined part
    */
    @Api(Description="Generate deployment name with the user defined part")
    @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=String.class, StatusCode=200)
    public static class GenerateDeploymentName implements IBaseRequest, IHasTenantName, IPatch
    {
        @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        @Validate(Validator="NotEmpty")
        public String tenantName = null;

        /**
        * User defined/custom part of the name
        */
        @ApiMember(DataType="string", Description="User defined/custom part of the name", IsRequired=true, ParameterType="body")
        @Validate(Validator="NotEmpty")
        // @Validate(Validator="MaximumLength(100)")
        // @Validate(Validator="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")
        public String userDefinedPart = null;

        /**
        * What kind of environment is this deployment
        */
        @ApiMember(Description="What kind of environment is this deployment", IsRequired=true, ParameterType="body")
        public Environments environment = null;
        
        public String getTenantName() { return tenantName; }
        public GenerateDeploymentName setTenantName(String value) { this.tenantName = value; return this; }
        public String getUserDefinedPart() { return userDefinedPart; }
        public GenerateDeploymentName setUserDefinedPart(String value) { this.userDefinedPart = value; return this; }
        public Environments getEnvironment() { return environment; }
        public GenerateDeploymentName setEnvironment(Environments value) { this.environment = value; return this; }
    }

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

}

Java GenerateDeploymentName 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.

PATCH /api/deployments/generation/name HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","userDefinedPart":"String","environment":"Lab","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

(string)