f8/sdk/fidl/fuchsia.component.config/README.md

<link rel="stylesheet" href="../style.css" />

[TOC]
# fuchsia.component.config

<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>


## **STRUCTS**

### ResolvedConfig  {#ResolvedConfig data-text="ResolvedConfig"}
*Defined in [fuchsia.component.config/resolved.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/resolved.fidl;l=10)*
<p>A configuration that has been completely resolved by component manager.</p>

<table>
    <tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
        <tr id="ResolvedConfig.fields">
            <td><code>fields</code></td>
            <td>
                <code>vector&lt;<a class='link' href='#ResolvedConfigField'>ResolvedConfigField</a>&gt;</code>
            </td>
            <td></td>
            <td>No default</td>
        </tr>
        <tr id="ResolvedConfig.checksum">
            <td><code>checksum</code></td>
            <td>
                <code><a class='link' href='../fuchsia.component.decl/'>fuchsia.component.decl</a>/<a class='link' href='../fuchsia.component.decl/#ConfigChecksum'>ConfigChecksum</a></code>
            </td>
            <td></td>
            <td>No default</td>
        </tr>
</table>

### ResolvedConfigField  {#ResolvedConfigField data-text="ResolvedConfigField"}
*Defined in [fuchsia.component.config/resolved.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/resolved.fidl;l=15)*

<table>
    <tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
        <tr id="ResolvedConfigField.key">
            <td><code>key</code></td>
            <td>
                <code>string</code>
            </td>
            <td></td>
            <td>No default</td>
        </tr>
        <tr id="ResolvedConfigField.value">
            <td><code>value</code></td>
            <td>
                <code><a class='link' href='#Value'>Value</a></code>
            </td>
            <td></td>
            <td>No default</td>
        </tr>
</table>



## **TABLES**

### ValueSpec  {#ValueSpec data-text="ValueSpec"}


*Defined in [fuchsia.component.config/specs.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/specs.fidl;l=22)*
<p>An individual configuration value. It is matched against a specific configuration field based
on its offset within <code>ValuesData.values</code>.</p>

<table>
    <tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
        <tr id="ValueSpec.value">
<td><h3 id="ValueSpec.value" class="add-link hide-from-toc">1</h3></td>
            <td><code>value</code></td>
            <td>
                <code><a class='link' href='#Value'>Value</a></code>
            </td>
            <td></td>
        </tr>
</table>

### ValuesData  {#ValuesData data-text="ValuesData"}


*Defined in [fuchsia.component.config/specs.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/specs.fidl;l=10)*
<p>Contents of the configuration value file. Defines the base values for a component's config.</p>

<table>
    <tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
        <tr id="ValuesData.values">
<td><h3 id="ValuesData.values" class="add-link hide-from-toc">1</h3></td>
            <td><code>values</code></td>
            <td>
                <code>vector&lt;<a class='link' href='#ValueSpec'>ValueSpec</a>&gt;</code>
            </td>
            <td><p>The concrete values for the component's configuration.</p>
</td>
        </tr>
        <tr id="ValuesData.checksum">
<td><h3 id="ValuesData.checksum" class="add-link hide-from-toc">2</h3></td>
            <td><code>checksum</code></td>
            <td>
                <code><a class='link' href='../fuchsia.component.decl/'>fuchsia.component.decl</a>/<a class='link' href='../fuchsia.component.decl/#ConfigChecksum'>ConfigChecksum</a></code>
            </td>
            <td><p>A SHA-256 checksum of the configuration schema. Must match the checksum in the component
manifest and config parser library used to resolve the final configuration.</p>
</td>
        </tr>
</table>


## **UNIONS**

### SingleValue [flexible](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute}  {#SingleValue data-text="SingleValue"}
*Defined in [fuchsia.component.config/value.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/value.fidl;l=20)*
<p>A single configuration value.</p>
<table>
    <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
        <tr id="SingleValue.bool">
<td><h3 id="SingleValue.bool" class="add-link hide-from-toc">1</h3></td>
            <td><code>bool</code></td>
            <td>
                <code>bool</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.uint8">
<td><h3 id="SingleValue.uint8" class="add-link hide-from-toc">2</h3></td>
            <td><code>uint8</code></td>
            <td>
                <code>uint8</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.uint16">
<td><h3 id="SingleValue.uint16" class="add-link hide-from-toc">3</h3></td>
            <td><code>uint16</code></td>
            <td>
                <code>uint16</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.uint32">
<td><h3 id="SingleValue.uint32" class="add-link hide-from-toc">4</h3></td>
            <td><code>uint32</code></td>
            <td>
                <code>uint32</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.uint64">
<td><h3 id="SingleValue.uint64" class="add-link hide-from-toc">5</h3></td>
            <td><code>uint64</code></td>
            <td>
                <code>uint64</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.int8">
<td><h3 id="SingleValue.int8" class="add-link hide-from-toc">6</h3></td>
            <td><code>int8</code></td>
            <td>
                <code>int8</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.int16">
<td><h3 id="SingleValue.int16" class="add-link hide-from-toc">7</h3></td>
            <td><code>int16</code></td>
            <td>
                <code>int16</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.int32">
<td><h3 id="SingleValue.int32" class="add-link hide-from-toc">8</h3></td>
            <td><code>int32</code></td>
            <td>
                <code>int32</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.int64">
<td><h3 id="SingleValue.int64" class="add-link hide-from-toc">9</h3></td>
            <td><code>int64</code></td>
            <td>
                <code>int64</code>
            </td>
            <td></td>
        </tr>
        <tr id="SingleValue.string">
<td><h3 id="SingleValue.string" class="add-link hide-from-toc">10</h3></td>
            <td><code>string</code></td>
            <td>
                <code>string</code>
            </td>
            <td></td>
        </tr>
</table>

### Value [flexible](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute}  {#Value data-text="Value"}
*Defined in [fuchsia.component.config/value.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/value.fidl;l=14)*
<p>A configuration value which can be provided to a component.</p>
<p>Used both for storing configuration at-rest and in runtime configuration APIs.</p>
<table>
    <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
        <tr id="Value.single">
<td><h3 id="Value.single" class="add-link hide-from-toc">1</h3></td>
            <td><code>single</code></td>
            <td>
                <code><a class='link' href='#SingleValue'>SingleValue</a></code>
            </td>
            <td></td>
        </tr>
        <tr id="Value.vector">
<td><h3 id="Value.vector" class="add-link hide-from-toc">2</h3></td>
            <td><code>vector</code></td>
            <td>
                <code><a class='link' href='#VectorValue'>VectorValue</a></code>
            </td>
            <td></td>
        </tr>
</table>

### VectorValue [flexible](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute}  {#VectorValue data-text="VectorValue"}
*Defined in [fuchsia.component.config/value.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.component.config/value.fidl;l=34)*
<p>A vector configuration value.</p>
<table>
    <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
        <tr id="VectorValue.bool_vector">
<td><h3 id="VectorValue.bool_vector" class="add-link hide-from-toc">1</h3></td>
            <td><code>bool_vector</code></td>
            <td>
                <code>vector&lt;bool&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.uint8_vector">
<td><h3 id="VectorValue.uint8_vector" class="add-link hide-from-toc">2</h3></td>
            <td><code>uint8_vector</code></td>
            <td>
                <code>vector&lt;uint8&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.uint16_vector">
<td><h3 id="VectorValue.uint16_vector" class="add-link hide-from-toc">3</h3></td>
            <td><code>uint16_vector</code></td>
            <td>
                <code>vector&lt;uint16&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.uint32_vector">
<td><h3 id="VectorValue.uint32_vector" class="add-link hide-from-toc">4</h3></td>
            <td><code>uint32_vector</code></td>
            <td>
                <code>vector&lt;uint32&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.uint64_vector">
<td><h3 id="VectorValue.uint64_vector" class="add-link hide-from-toc">5</h3></td>
            <td><code>uint64_vector</code></td>
            <td>
                <code>vector&lt;uint64&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.int8_vector">
<td><h3 id="VectorValue.int8_vector" class="add-link hide-from-toc">6</h3></td>
            <td><code>int8_vector</code></td>
            <td>
                <code>vector&lt;int8&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.int16_vector">
<td><h3 id="VectorValue.int16_vector" class="add-link hide-from-toc">7</h3></td>
            <td><code>int16_vector</code></td>
            <td>
                <code>vector&lt;int16&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.int32_vector">
<td><h3 id="VectorValue.int32_vector" class="add-link hide-from-toc">8</h3></td>
            <td><code>int32_vector</code></td>
            <td>
                <code>vector&lt;int32&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.int64_vector">
<td><h3 id="VectorValue.int64_vector" class="add-link hide-from-toc">9</h3></td>
            <td><code>int64_vector</code></td>
            <td>
                <code>vector&lt;int64&gt;</code>
            </td>
            <td></td>
        </tr>
        <tr id="VectorValue.string_vector">
<td><h3 id="VectorValue.string_vector" class="add-link hide-from-toc">10</h3></td>
            <td><code>string_vector</code></td>
            <td>
                <code>vector&lt;string&gt;</code>
            </td>
            <td></td>
        </tr>
</table>