blob: 72579b44d11eb9080630916658d201b5f2b3f1ba [file] [log] [blame]
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>helix-front documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">helix-front documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
<li >Resource</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="active">
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
</li>
<li >
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="c-info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/app/resource/shared/resource.model.ts</code>
</p>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Readonly</span>
<a href="#alive" >alive</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#cluster" >cluster</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#externalView" >externalView</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#idealState" >idealState</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#idealStateMode" >idealStateMode</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#name" >name</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#partitionCount" >partitionCount</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#partitions" >partitions</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#rebalanceMode" >rebalanceMode</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#replicaCount" >replicaCount</a>
</li>
<li>
<span class="modifier">Readonly</span>
<a href="#stateModel" >stateModel</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Accessors</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#enabled" >enabled</a>
</li>
<li>
<a href="#online" >online</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(cluster: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, config: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, idealState: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>, externalView: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">any</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="55" class="link-to-prism">src/app/resource/shared/resource.model.ts:55</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>cluster</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>name</td>
<td>
<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>config</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>idealState</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
<tr>
<td>externalView</td>
<td>
<code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="alive"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>alive</b></span>
<a href="#alive"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="31" class="link-to-prism">src/app/resource/shared/resource.model.ts:31</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="cluster"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>cluster</b></span>
<a href="#cluster"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="33" class="link-to-prism">src/app/resource/shared/resource.model.ts:33</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="externalView"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>externalView</b></span>
<a href="#externalView"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="43" class="link-to-prism">src/app/resource/shared/resource.model.ts:43</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="idealState"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>idealState</b></span>
<a href="#idealState"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="42" class="link-to-prism">src/app/resource/shared/resource.model.ts:42</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="idealStateMode"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>idealStateMode</b></span>
<a href="#idealStateMode"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="36" class="link-to-prism">src/app/resource/shared/resource.model.ts:36</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="name"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>name</b></span>
<a href="#name"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">src/app/resource/shared/resource.model.ts:28</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="partitionCount"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>partitionCount</b></span>
<a href="#partitionCount"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="39" class="link-to-prism">src/app/resource/shared/resource.model.ts:39</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="partitions"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>partitions</b></span>
<a href="#partitions"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../classes/Partition.html" target="_self" >Partition[]</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="45" class="link-to-prism">src/app/resource/shared/resource.model.ts:45</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="rebalanceMode"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>rebalanceMode</b></span>
<a href="#rebalanceMode"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="37" class="link-to-prism">src/app/resource/shared/resource.model.ts:37</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="replicaCount"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>replicaCount</b></span>
<a href="#replicaCount"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="40" class="link-to-prism">src/app/resource/shared/resource.model.ts:40</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="stateModel"></a>
<span class="name">
<span class="modifier">Readonly</span>
<span ><b>stateModel</b></span>
<a href="#stateModel"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="38" class="link-to-prism">src/app/resource/shared/resource.model.ts:38</a></div>
</td>
</tr>
</tbody>
</table>
</section>
<section>
<h3 id="accessors">
Accessors
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="enabled"></a>
<span class="name"><b>enabled</b><a href="#enabled"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>enabled()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="47" class="link-to-prism">src/app/resource/shared/resource.model.ts:47</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="online"></a>
<span class="name"><b>online</b><a href="#online"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="accessor"><b>get</b><code>online()</code></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="53" class="link-to-prism">src/app/resource/shared/resource.model.ts:53</a></div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="c-source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import * as _ from &#x27;lodash&#x27;;
export interface IReplica {
instanceName: string;
externalView: string;
idealState: string;
}
export class Partition {
name: string;
replicas: IReplica[];
get isReady() {
return !_.some(
this.replicas,
(replica) &#x3D;&gt;
!replica.externalView || replica.externalView !&#x3D; replica.idealState
);
}
constructor(name: string) {
this.name &#x3D; name;
this.replicas &#x3D; [];
}
}
export class Resource {
readonly name: string;
// TODO vxu: convert it to an enum in future if necessary
readonly alive: boolean;
readonly cluster: string;
// meta data
readonly idealStateMode: string;
readonly rebalanceMode: string;
readonly stateModel: string;
readonly partitionCount: number;
readonly replicaCount: number;
readonly idealState: any;
readonly externalView: any;
readonly partitions: Partition[];
get enabled(): boolean {
// there are two cases meaning enabled both:
// HELIX_ENABLED: true or no such item in idealState
return _.get(this.idealState, &#x27;simpleFields.HELIX_ENABLED&#x27;) !&#x3D; &#x27;false&#x27;;
}
get online(): boolean {
return !_.isEmpty(this.externalView);
}
constructor(
cluster: string,
name: string,
config: any,
idealState: any,
externalView: any
) {
this.cluster &#x3D; cluster;
this.name &#x3D; name;
externalView &#x3D; externalView || {};
// ignore config for now since config component will fetch itself
this.idealStateMode &#x3D; idealState.simpleFields.IDEAL_STATE_MODE;
this.rebalanceMode &#x3D; idealState.simpleFields.REBALANCE_MODE;
this.stateModel &#x3D; idealState.simpleFields.STATE_MODEL_DEF_REF;
this.partitionCount &#x3D; +idealState.simpleFields.NUM_PARTITIONS;
this.replicaCount &#x3D; +idealState.simpleFields.REPLICAS;
// fetch partition names from externalView.mapFields is (relatively) more stable
this.partitions &#x3D; [];
for (const partitionName in externalView.mapFields) {
const partition &#x3D; new Partition(partitionName);
// in FULL_AUTO mode, externalView is more important
// if preferences list exists, fetch instances from it, else whatever
if (
this.rebalanceMode !&#x3D; &#x27;FULL_AUTO&#x27; &amp;&amp;
idealState.listFields[partitionName]
) {
for (const replicaName of idealState.listFields[partitionName]) {
partition.replicas.push(&lt;IReplica&gt;{
instanceName: replicaName,
externalView: _.get(externalView, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
idealState: _.get(idealState, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
});
}
} else if (
this.rebalanceMode !&#x3D; &#x27;FULL_AUTO&#x27; &amp;&amp;
idealState.mapFields[partitionName]
) {
for (const replicaName in idealState.mapFields[partitionName]) {
partition.replicas.push(&lt;IReplica&gt;{
instanceName: replicaName,
externalView: _.get(externalView, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
idealState: _.get(idealState, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
});
}
} else {
for (const replicaName in externalView.mapFields[partitionName]) {
partition.replicas.push(&lt;IReplica&gt;{
instanceName: replicaName,
externalView: _.get(externalView, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
idealState: _.get(idealState, [
&#x27;mapFields&#x27;,
partitionName,
replicaName,
]),
});
}
}
// sort replicas by states
partition.replicas &#x3D; _.sortBy(partition.replicas, &#x27;externalView&#x27;);
this.partitions.push(partition);
}
this.idealState &#x3D; idealState;
this.externalView &#x3D; externalView;
}
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'Resource.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>