| Required role: | TenantReader | Requires the role: | Workflow |
| GET | /api/resourceaddons/hostnames | Returns a list of hostnames for one time use (the pool will never return already obtained hostnames) | |
|---|---|---|---|
| GET | /resourceaddons/hostnames | Returns a list of hostnames for one time use (the pool will never return already obtained hostnames) |
import 'package:servicestack/servicestack.dart';
/**
* Returns a list of hostnames
*/
// @Api(Description="Returns a list of hostnames")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]), StatusCode=200)
class GetHostNames implements IBaseRequest, IHasTenantName, IGet, IConvertible
{
// @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
// @Validate(Validator="NotEmpty")
String tenantName = "";
/**
* If set, hostnames will be created using it
*/
// @ApiMember(DataType="string", Description="If set, hostnames will be created using it", ParameterType="query")
// @Validate(Validator="MaximumLength(2)")
String? prefix;
/**
* Defines how long the hostname will be including the prefix
*/
// @ApiMember(DataType="int", Description="Defines how long the hostname will be including the prefix", ParameterType="query")
// @Validate(Validator="ExclusiveBetween(7,17)")
int? length;
/**
* The number of hostnames to be returned
*/
// @ApiMember(DataType="int", Description="The number of hostnames to be returned", IsRequired=true)
// @Validate(Validator="GreaterThanOrEqual(1)")
int count = 0;
GetHostNames({this.tenantName,this.prefix,this.length,this.count});
GetHostNames.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
tenantName = json['tenantName'];
prefix = json['prefix'];
length = json['length'];
count = json['count'];
return this;
}
Map<String, dynamic> toJson() => {
'tenantName': tenantName,
'prefix': prefix,
'length': length,
'count': count
};
getTypeName() => "GetHostNames";
TypeContext? context = _ctx;
}
enum ValueDataType
{
String,
Number,
Boolean,
List,
}
enum Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
class VariableDto implements IConvertible
{
String name = "";
/**
* 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
*/
String value = "";
/**
* The data type of the value property
*/
ValueDataType type;
String? description;
bool isInherited;
Environments? environment;
VariableDto({this.name,this.value,this.type,this.description,this.isInherited,this.environment});
VariableDto.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
name = json['name'];
value = json['value'];
type = JsonConverters.fromJson(json['type'],'ValueDataType',context!);
description = json['description'];
isInherited = json['isInherited'];
environment = JsonConverters.fromJson(json['environment'],'Environments',context!);
return this;
}
Map<String, dynamic> toJson() => {
'name': name,
'value': value,
'type': JsonConverters.toJson(type,'ValueDataType',context!),
'description': description,
'isInherited': isInherited,
'environment': JsonConverters.toJson(environment,'Environments',context!)
};
getTypeName() => "VariableDto";
TypeContext? context = _ctx;
}
class ItemsResponse<T> implements IConvertible
{
List<VariableDto>? items;
int offset = 0;
int total = 0;
bool isGrouped;
ResponseStatus? responseStatus;
Map<String,String?>? meta;
ItemsResponse({this.items,this.offset,this.total,this.isGrouped,this.responseStatus,this.meta});
ItemsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
items = JsonConverters.fromJson(json['items'],'List<VariableDto>',context!);
offset = json['offset'];
total = json['total'];
isGrouped = json['isGrouped'];
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
meta = JsonConverters.toStringMap(json['meta']);
return this;
}
Map<String, dynamic> toJson() => {
'items': JsonConverters.toJson(items,'List<VariableDto>',context!),
'offset': offset,
'total': total,
'isGrouped': isGrouped,
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'meta': meta
};
getTypeName() => "ItemsResponse<$T>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'duneframework.com', types: <String, TypeInfo> {
'GetHostNames': TypeInfo(TypeOf.Class, create:() => GetHostNames()),
'ValueDataType': TypeInfo(TypeOf.Enum, enumValues:ValueDataType.values),
'Environments': TypeInfo(TypeOf.Enum, enumValues:Environments.values),
'VariableDto': TypeInfo(TypeOf.Class, create:() => VariableDto()),
'ItemsResponse<T>': TypeInfo(TypeOf.Class, create:() => ItemsResponse<T>()),
'List<VariableDto>': TypeInfo(TypeOf.Class, create:() => <VariableDto>[]),
});
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/resourceaddons/hostnames HTTP/1.1 Host: core.starburst.svc Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}