docs/layouts/shortcodes/config_file.html

{{/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/}}

<table class="configuration file table table-bordered">
    <thead>
    <tr>
        <th class="text-left" style="width: 20%">Config Type</th>
        <th class="text-left" style="width: 80%">Format Reference</th>
    </tr>
    </thead>
    <tbody>
    <tr>
        <td><h5>Integer</h5></td>
        <td>Regular expression: <code>[-+]? [0-9]+</code><br><br>Example: <code>100</code></td>
    </tr>
    <tr>
        <td><h5>Long</h5></td>
        <td>Regular expression: <code>[-+]? [0-9]+</code><br><br>Example: <code>100</code></td>
    </tr>
    <tr>
        <td><h5>Float</h5></td>
        <td>Regular expression: <code>[-+]? ( \. [0-9]+ | [0-9]+ ( \. [0-9]* )? ) ( [eE] [-+]? [0-9]+ )?</code><br><br>Example: <code>100.1</code></td>
    </tr>
    <tr>
        <td><h5>Double</h5></td>
        <td>Regular expression: <code>[-+]? ( \. [0-9]+ | [0-9]+ ( \. [0-9]* )? ) ( [eE] [-+]? [0-9]+ )?</code><br><br>Example: <code>100.1</code></td>
    </tr>
    <tr>
        <td><h5>Boolean</h5></td>
        <td>Regular expression: <code>true | True | TRUE | false | False | FALSE</code><br><br>Example: <code>true</code></td>
    </tr>
    <tr id="config-type-string">
        <td><h5>String</h5></td>
        <td>
            Any character<br><br>
            <strong>Note</strong>: If the value contains special characters used in
            <a href="https://yaml.org/spec/1.2.2/#53-indicator-characters" target="_blank">YAML</a>,
            it is necessary to use single or double quotes to escape these characters.
        </td>
    </tr>
    <tr>
        <td><h5>Map&ltString, String&gt</h5></td>
        <td>
            <ul>
                <li style="line-height: 1.8; margin-bottom: 10px;">Flow Style:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: Enclosed with curly braces "{}" and pairs are separated by a comma ",". Within the mapping, key and value are separated by a colon ":" followed by a space.</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example: <code>{k1: v1, k2: v2}</code></li>
                    </ul>
                </li>
                <li style="line-height: 1.8; margin-bottom: 10px;">Block Style:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: Uses indentation to represent the hierarchical structure of the data, with keys and values separated by a colon ":" and a space.</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example:
                            <pre><code>k1: v1<br>k2: v2</code></pre>
                        </li>
                    </ul>
                </li>
                <li style="line-height: 1.8; margin-bottom: 10px;">Flink Legacy Map Pattern:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: Pairs are separated by a comma ",". Within the mapping, keys and values are separated by a colon ":".</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example: <code>k1:v1,k2:v2</code></li>
                    </ul>
                </li>
            </ul>
            Note: For values containing special characters, consider escaping them; details can be found in the description of <a href="#config-type-string">Config Type: String</a>.
        </td>
    </tr>
    <tr>
        <td><h5>List</h5></td>
        <td>
            <ul>
                <li style="line-height: 1.8; margin-bottom: 10px;">Flow Style:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: Enclosed within square brackets "[]" and list items are separated by a comma ",".</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example: <code>[a, b, c]</code></li>
                    </ul>
                </li>
                <li style="line-height: 1.8; margin-bottom: 10px;">Block Style:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: Uses indentation and a dash "-" to denote list items.</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example: 
                            <pre><code>- a<br>- b<br>- c</code></pre>
                        </li>
                    </ul>
                </li>
                <li style="line-height: 1.8; margin-bottom: 10px;">Flink Legacy Map Pattern:
                    <ul>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Description: List items are separated by a semicolon ";".</li>
                        <li style="line-height: 1.4; margin-bottom: 5px;">Example: <code>a;b;c</code></li>
                    </ul>
                </li>
            </ul>
            Note: For values containing special characters, consider escaping them; details can be found in the description of <a href="#config-type-string">Config Type: String</a>.
        </td>
    </tr>
    <tr>
        <td><h5>MemorySize</h5></td>
        <td>Regular expression: <code>[0-9]+ (b | kb | kibibytes | m | mb | mebibytes | g | gb | gibibytes | t | tb | tebibytes)?</code><br><br>Example: <code>100 mb</code></td>
    </tr>
    <tr>
        <td><h5>Duration</h5></td>
        <td>Regular expression: <code>[0-9]+ (d | day | h | hour | m | min | minute | s | sec | second | ms | milli | millisecond | us | micro | microsecond | ns | nano | nanosecond)?</code><br><br>Example: <code>10 s</code></td>
    </tr>
    <tr>
        <td><h5>Enum</h5></td>
        <td>Enum Constants</td>
    </tr>
    </tbody>
</table>