CoreService

<back to all web services

ValidateDeploymentName

Deployment - CRUD

Validate deployment name with the user defined part

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
PATCH/api/deployments/validation/nameValidate deployment name with the user defined part
PATCH/deployments/validation/nameValidate deployment name with the user defined part
"use strict";
/** @typedef {'Error'|'Warning'|'Info'} */
export var Severity;
(function (Severity) {
    Severity["Error"] = "Error"
    Severity["Warning"] = "Warning"
    Severity["Info"] = "Info"
})(Severity || (Severity = {}));
export class ValidationFailure {
    /** @param {{propertyName?:string,errorMessage?:string,attemptedValue?:Object,customState?:Object,severity?:Severity,formattedMessageArguments?:Object[],formattedMessagePlaceholderValues?:{ [index:string]: Object; },errorCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    propertyName;
    /** @type {?string} */
    errorMessage;
    /** @type {?Object} */
    attemptedValue;
    /** @type {?Object} */
    customState;
    /** @type {Severity} */
    severity;
    /** @type {?Object[]} */
    formattedMessageArguments;
    /** @type {?{ [index:string]: Object; }} */
    formattedMessagePlaceholderValues;
    /** @type {?string} */
    errorCode;
}
/** @typedef {number} */
export var RequestAttributes;
(function (RequestAttributes) {
    RequestAttributes[RequestAttributes["None"] = 0] = "None"
    RequestAttributes[RequestAttributes["Localhost"] = 1] = "Localhost"
    RequestAttributes[RequestAttributes["LocalSubnet"] = 2] = "LocalSubnet"
    RequestAttributes[RequestAttributes["External"] = 4] = "External"
    RequestAttributes[RequestAttributes["Secure"] = 8] = "Secure"
    RequestAttributes[RequestAttributes["InSecure"] = 16] = "InSecure"
    RequestAttributes[RequestAttributes["AnySecurityMode"] = 24] = "AnySecurityMode"
    RequestAttributes[RequestAttributes["HttpHead"] = 32] = "HttpHead"
    RequestAttributes[RequestAttributes["HttpGet"] = 64] = "HttpGet"
    RequestAttributes[RequestAttributes["HttpPost"] = 128] = "HttpPost"
    RequestAttributes[RequestAttributes["HttpPut"] = 256] = "HttpPut"
    RequestAttributes[RequestAttributes["HttpDelete"] = 512] = "HttpDelete"
    RequestAttributes[RequestAttributes["HttpPatch"] = 1024] = "HttpPatch"
    RequestAttributes[RequestAttributes["HttpOptions"] = 2048] = "HttpOptions"
    RequestAttributes[RequestAttributes["HttpOther"] = 4096] = "HttpOther"
    RequestAttributes[RequestAttributes["AnyHttpMethod"] = 8160] = "AnyHttpMethod"
    RequestAttributes[RequestAttributes["OneWay"] = 8192] = "OneWay"
    RequestAttributes[RequestAttributes["Reply"] = 16384] = "Reply"
    RequestAttributes[RequestAttributes["AnyCallStyle"] = 24576] = "AnyCallStyle"
    RequestAttributes[RequestAttributes["Soap11"] = 32768] = "Soap11"
    RequestAttributes[RequestAttributes["Soap12"] = 65536] = "Soap12"
    RequestAttributes[RequestAttributes["Xml"] = 131072] = "Xml"
    RequestAttributes[RequestAttributes["Json"] = 262144] = "Json"
    RequestAttributes[RequestAttributes["Jsv"] = 524288] = "Jsv"
    RequestAttributes[RequestAttributes["ProtoBuf"] = 1048576] = "ProtoBuf"
    RequestAttributes[RequestAttributes["Csv"] = 2097152] = "Csv"
    RequestAttributes[RequestAttributes["Html"] = 4194304] = "Html"
    RequestAttributes[RequestAttributes["Jsonl"] = 8388608] = "Jsonl"
    RequestAttributes[RequestAttributes["MsgPack"] = 16777216] = "MsgPack"
    RequestAttributes[RequestAttributes["FormatOther"] = 33554432] = "FormatOther"
    RequestAttributes[RequestAttributes["AnyFormat"] = 67076096] = "AnyFormat"
    RequestAttributes[RequestAttributes["Http"] = 67108864] = "Http"
    RequestAttributes[RequestAttributes["MessageQueue"] = 134217728] = "MessageQueue"
    RequestAttributes[RequestAttributes["Tcp"] = 268435456] = "Tcp"
    RequestAttributes[RequestAttributes["Grpc"] = 536870912] = "Grpc"
    RequestAttributes[RequestAttributes["EndpointOther"] = 1073741824] = "EndpointOther"
    RequestAttributes[RequestAttributes["AnyEndpoint"] = 2080374784] = "AnyEndpoint"
    RequestAttributes[RequestAttributes["InProcess"] = -2147483648] = "InProcess"
    RequestAttributes[RequestAttributes["InternalNetworkAccess"] = -2147483645] = "InternalNetworkAccess"
    RequestAttributes[RequestAttributes["AnyNetworkAccessType"] = -2147483641] = "AnyNetworkAccessType"
    RequestAttributes[RequestAttributes["Any"] = -1] = "Any"
})(RequestAttributes || (RequestAttributes = {}));
export class ValidationResult {
    /** @param {{isValid?:boolean,errors?:IList<ValidationFailure>,ruleSetsExecuted?:string[],request?:IRequest}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isValid;
    /** @type {?IList<ValidationFailure>} */
    errors;
    /** @type {?string[]} */
    ruleSetsExecuted;
    /** @type {?IRequest} */
    request;
}
/** @typedef {'Lab'|'Poc'|'Dev'|'Test'|'Int'|'Uat'|'Prod'} */
export var Environments;
(function (Environments) {
    Environments["Lab"] = "Lab"
    Environments["Poc"] = "Poc"
    Environments["Dev"] = "Dev"
    Environments["Test"] = "Test"
    Environments["Int"] = "Int"
    Environments["Uat"] = "Uat"
    Environments["Prod"] = "Prod"
})(Environments || (Environments = {}));
export class ValidateDeploymentName {
    /** @param {{tenantName?:string,name?:string,environment?:Environments}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    tenantName;
    /**
     * @type {string}
     * @description The full name in the form of '{userdefined}_{environment}' */
    name;
    /**
     * @type {Environments}
     * @description What kind of environment is this deployment */
    environment;
}

JavaScript ValidateDeploymentName 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/validation/name HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"isValid":true,"errors":[],"ruleSetsExecuted":["String"],"request":null}