* Add test case * Fix tests * Add test dependencies correctly * Feed through error handling * Include test output * Get types to line up * Add remaining test files * Update changelog * Correctly find type paths * Handle transitive objects * Handle required fields * Add required+default test case * Don't `<any>` cast known types. * Add plain object to env-helper test This test fails right now. My next problem is fixing it. * Handle plain types * Handle function inputs * Fix the indentation * Handle output types correctly * Remove unnecessary `!` * Add missing change to fix test * Run tests with merge * Merge in next _index.md diff * Another attempt at _index.md * Make module generation deterministic * Fix docs generation Credit to @praneetloke
850 lines
39 KiB
Markdown
850 lines
39 KiB
Markdown
|
|
---
|
|
title: "Foo"
|
|
title_tag: "example.Foo"
|
|
meta_desc: "Documentation for the example.Foo resource with examples, input properties, output properties, lookup functions, and supporting types."
|
|
layout: api
|
|
no_edit_this_page: true
|
|
---
|
|
|
|
|
|
|
|
<!-- WARNING: this file was generated by test. -->
|
|
<!-- Do not edit by hand unless you're certain you know what you are doing! -->
|
|
|
|
test new feature with resoruces
|
|
|
|
|
|
|
|
|
|
## Create a Foo Resource {#create}
|
|
{{< chooser language "typescript,python,go,csharp" / >}}
|
|
|
|
|
|
{{% choosable language nodejs %}}
|
|
<div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">new </span><span class="nx">Foo</span><span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">FooArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span><span class="p">);</span></code></pre></div>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span>
|
|
<span class="k">def </span><span class="nx">Foo</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
|
|
<span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">,</span>
|
|
<span class="nx">argument</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
|
|
<span class="nx">backup_kube_client_settings</span><span class="p">:</span> <span class="nx">Optional[KubeClientSettingsArgs]</span> = None<span class="p">,</span>
|
|
<span class="nx">kube_client_settings</span><span class="p">:</span> <span class="nx">Optional[KubeClientSettingsArgs]</span> = None<span class="p">,</span>
|
|
<span class="nx">settings</span><span class="p">:</span> <span class="nx">Optional[LayeredTypeArgs]</span> = None<span class="p">)</span>
|
|
<span class=nd>@overload</span>
|
|
<span class="k">def </span><span class="nx">Foo</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
|
|
<span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">FooArgs</a></span><span class="p">,</span>
|
|
<span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">)</span></code></pre></div>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span><span class="nx">NewFoo</span><span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">name</span><span class="p"> </span><span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p"> </span><span class="nx"><a href="#inputs">FooArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span><span class="p">) (*<span class="nx">Foo</span>, error)</span></code></pre></div>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language csharp %}}
|
|
<div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span><span class="nx">Foo</span><span class="p">(</span><span class="nx">string</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">FooArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span></code></pre></div>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
|
|
<dl class="resources-properties"><dt
|
|
class="property-required" title="Required">
|
|
<span>name</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>The unique name of the resource.</dd><dt
|
|
class="property-required" title="Required">
|
|
<span>args</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#inputs">FooArgs</a></span>
|
|
</dt>
|
|
<dd>The arguments to resource properties.</dd><dt
|
|
class="property-optional" title="Optional">
|
|
<span>opts</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span>
|
|
</dt>
|
|
<dd>Bag of options to control resource's behavior.</dd></dl>
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
|
|
<dl class="resources-properties"><dt
|
|
class="property-required" title="Required">
|
|
<span>resource_name</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>The unique name of the resource.</dd><dt
|
|
class="property-required" title="Required">
|
|
<span>args</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#inputs">FooArgs</a></span>
|
|
</dt>
|
|
<dd>The arguments to resource properties.</dd><dt
|
|
class="property-optional" title="Optional">
|
|
<span>opts</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span>
|
|
</dt>
|
|
<dd>Bag of options to control resource's behavior.</dd></dl>
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
|
|
<dl class="resources-properties"><dt
|
|
class="property-optional" title="Optional">
|
|
<span>ctx</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span>
|
|
</dt>
|
|
<dd>Context object for the current deployment.</dd><dt
|
|
class="property-required" title="Required">
|
|
<span>name</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>The unique name of the resource.</dd><dt
|
|
class="property-required" title="Required">
|
|
<span>args</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#inputs">FooArgs</a></span>
|
|
</dt>
|
|
<dd>The arguments to resource properties.</dd><dt
|
|
class="property-optional" title="Optional">
|
|
<span>opts</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span>
|
|
</dt>
|
|
<dd>Bag of options to control resource's behavior.</dd></dl>
|
|
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language csharp %}}
|
|
|
|
<dl class="resources-properties"><dt
|
|
class="property-required" title="Required">
|
|
<span>name</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>The unique name of the resource.</dd><dt
|
|
class="property-required" title="Required">
|
|
<span>args</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#inputs">FooArgs</a></span>
|
|
</dt>
|
|
<dd>The arguments to resource properties.</dd><dt
|
|
class="property-optional" title="Optional">
|
|
<span>opts</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span>
|
|
</dt>
|
|
<dd>Bag of options to control resource's behavior.</dd></dl>
|
|
|
|
{{% /choosable %}}
|
|
|
|
## Foo Resource Properties {#properties}
|
|
|
|
To learn more about resource properties and how to use them, see [Inputs and Outputs]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) in the Architecture and Concepts docs.
|
|
|
|
### Inputs
|
|
|
|
The Foo resource accepts the following [input]({{< relref "/docs/intro/concepts/inputs-outputs" >}}) properties:
|
|
|
|
|
|
|
|
{{% choosable language csharp %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="backupkubeclientsettings_csharp">
|
|
<a href="#backupkubeclientsettings_csharp" style="color: inherit; text-decoration: inherit;">Backup<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="argument_csharp">
|
|
<a href="#argument_csharp" style="color: inherit; text-decoration: inherit;">Argument</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="kubeclientsettings_csharp">
|
|
<a href="#kubeclientsettings_csharp" style="color: inherit; text-decoration: inherit;">Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="settings_csharp">
|
|
<a href="#settings_csharp" style="color: inherit; text-decoration: inherit;">Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}describing things{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="backupkubeclientsettings_go">
|
|
<a href="#backupkubeclientsettings_go" style="color: inherit; text-decoration: inherit;">Backup<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="argument_go">
|
|
<a href="#argument_go" style="color: inherit; text-decoration: inherit;">Argument</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="kubeclientsettings_go">
|
|
<a href="#kubeclientsettings_go" style="color: inherit; text-decoration: inherit;">Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="settings_go">
|
|
<a href="#settings_go" style="color: inherit; text-decoration: inherit;">Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}describing things{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="backupkubeclientsettings_nodejs">
|
|
<a href="#backupkubeclientsettings_nodejs" style="color: inherit; text-decoration: inherit;">backup<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="argument_nodejs">
|
|
<a href="#argument_nodejs" style="color: inherit; text-decoration: inherit;">argument</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="kubeclientsettings_nodejs">
|
|
<a href="#kubeclientsettings_nodejs" style="color: inherit; text-decoration: inherit;">kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="settings_nodejs">
|
|
<a href="#settings_nodejs" style="color: inherit; text-decoration: inherit;">settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}describing things{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="backup_kube_client_settings_python">
|
|
<a href="#backup_kube_client_settings_python" style="color: inherit; text-decoration: inherit;">backup_<wbr>kube_<wbr>client_<wbr>settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="argument_python">
|
|
<a href="#argument_python" style="color: inherit; text-decoration: inherit;">argument</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="kube_client_settings_python">
|
|
<a href="#kube_client_settings_python" style="color: inherit; text-decoration: inherit;">kube_<wbr>client_<wbr>settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Options for tuning the Kubernetes client used by a Provider.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="settings_python">
|
|
<a href="#settings_python" style="color: inherit; text-decoration: inherit;">settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type<wbr>Args</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}describing things{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
|
|
### Outputs
|
|
|
|
All [input](#inputs) properties are implicitly available as output properties. Additionally, the Foo resource produces the following output properties:
|
|
|
|
|
|
|
|
{{% choosable language csharp %}}
|
|
<dl class="resources-properties"><dt class="property-"
|
|
title="">
|
|
<span id="id_csharp">
|
|
<a href="#id_csharp" style="color: inherit; text-decoration: inherit;">Id</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}</dd><dt class="property-"
|
|
title="">
|
|
<span id="defaultkubeclientsettings_csharp">
|
|
<a href="#defaultkubeclientsettings_csharp" style="color: inherit; text-decoration: inherit;">Default<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}A test for plain types{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<dl class="resources-properties"><dt class="property-"
|
|
title="">
|
|
<span id="id_go">
|
|
<a href="#id_go" style="color: inherit; text-decoration: inherit;">Id</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}</dd><dt class="property-"
|
|
title="">
|
|
<span id="defaultkubeclientsettings_go">
|
|
<a href="#defaultkubeclientsettings_go" style="color: inherit; text-decoration: inherit;">Default<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}A test for plain types{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
<dl class="resources-properties"><dt class="property-"
|
|
title="">
|
|
<span id="id_nodejs">
|
|
<a href="#id_nodejs" style="color: inherit; text-decoration: inherit;">id</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}</dd><dt class="property-"
|
|
title="">
|
|
<span id="defaultkubeclientsettings_nodejs">
|
|
<a href="#defaultkubeclientsettings_nodejs" style="color: inherit; text-decoration: inherit;">default<wbr>Kube<wbr>Client<wbr>Settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}A test for plain types{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<dl class="resources-properties"><dt class="property-"
|
|
title="">
|
|
<span id="id_python">
|
|
<a href="#id_python" style="color: inherit; text-decoration: inherit;">id</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}The provider-assigned unique ID for this managed resource.{{% /md %}}</dd><dt class="property-"
|
|
title="">
|
|
<span id="default_kube_client_settings_python">
|
|
<a href="#default_kube_client_settings_python" style="color: inherit; text-decoration: inherit;">default_<wbr>kube_<wbr>client_<wbr>settings</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}A test for plain types{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Supporting Types
|
|
|
|
|
|
|
|
<h4 id="helmreleasesettings">Helm<wbr>Release<wbr>Settings</h4>
|
|
|
|
{{% choosable language csharp %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="requiredarg_csharp">
|
|
<a href="#requiredarg_csharp" style="color: inherit; text-decoration: inherit;">Required<wbr>Arg</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}to test required args{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="driver_csharp">
|
|
<a href="#driver_csharp" style="color: inherit; text-decoration: inherit;">Driver</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="pluginspath_csharp">
|
|
<a href="#pluginspath_csharp" style="color: inherit; text-decoration: inherit;">Plugins<wbr>Path</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The path to the helm plugins directory.{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="requiredarg_go">
|
|
<a href="#requiredarg_go" style="color: inherit; text-decoration: inherit;">Required<wbr>Arg</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}to test required args{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="driver_go">
|
|
<a href="#driver_go" style="color: inherit; text-decoration: inherit;">Driver</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="pluginspath_go">
|
|
<a href="#pluginspath_go" style="color: inherit; text-decoration: inherit;">Plugins<wbr>Path</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The path to the helm plugins directory.{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="requiredarg_nodejs">
|
|
<a href="#requiredarg_nodejs" style="color: inherit; text-decoration: inherit;">required<wbr>Arg</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}to test required args{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="driver_nodejs">
|
|
<a href="#driver_nodejs" style="color: inherit; text-decoration: inherit;">driver</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="pluginspath_nodejs">
|
|
<a href="#pluginspath_nodejs" style="color: inherit; text-decoration: inherit;">plugins<wbr>Path</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The path to the helm plugins directory.{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="required_arg_python">
|
|
<a href="#required_arg_python" style="color: inherit; text-decoration: inherit;">required_<wbr>arg</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}to test required args{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="driver_python">
|
|
<a href="#driver_python" style="color: inherit; text-decoration: inherit;">driver</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}The backend storage driver for Helm. Values are: configmap, secret, memory, sql.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="plugins_path_python">
|
|
<a href="#plugins_path_python" style="color: inherit; text-decoration: inherit;">plugins_<wbr>path</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}The path to the helm plugins directory.{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
<h4 id="kubeclientsettings">Kube<wbr>Client<wbr>Settings</h4>
|
|
|
|
{{% choosable language csharp %}}
|
|
<dl class="resources-properties"><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="burst_csharp">
|
|
<a href="#burst_csharp" style="color: inherit; text-decoration: inherit;">Burst</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">int</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="qps_csharp">
|
|
<a href="#qps_csharp" style="color: inherit; text-decoration: inherit;">Qps</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">double</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="rectest_csharp">
|
|
<a href="#rectest_csharp" style="color: inherit; text-decoration: inherit;">Rec<wbr>Test</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<dl class="resources-properties"><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="burst_go">
|
|
<a href="#burst_go" style="color: inherit; text-decoration: inherit;">Burst</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">int</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="qps_go">
|
|
<a href="#qps_go" style="color: inherit; text-decoration: inherit;">Qps</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">float64</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="rectest_go">
|
|
<a href="#rectest_go" style="color: inherit; text-decoration: inherit;">Rec<wbr>Test</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
<dl class="resources-properties"><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="burst_nodejs">
|
|
<a href="#burst_nodejs" style="color: inherit; text-decoration: inherit;">burst</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">number</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="qps_nodejs">
|
|
<a href="#qps_nodejs" style="color: inherit; text-decoration: inherit;">qps</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">number</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="rectest_nodejs">
|
|
<a href="#rectest_nodejs" style="color: inherit; text-decoration: inherit;">rec<wbr>Test</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<dl class="resources-properties"><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="burst_python">
|
|
<a href="#burst_python" style="color: inherit; text-decoration: inherit;">burst</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">int</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum burst for throttle. Default value is 10.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="qps_python">
|
|
<a href="#qps_python" style="color: inherit; text-decoration: inherit;">qps</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">float</span>
|
|
</dt>
|
|
<dd>{{% md %}}Maximum queries per second (QPS) to the API server from this client. Default value is 5.{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="rec_test_python">
|
|
<a href="#rec_test_python" style="color: inherit; text-decoration: inherit;">rec_<wbr>test</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#kubeclientsettings">Kube<wbr>Client<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
<h4 id="layeredtype">Layered<wbr>Type</h4>
|
|
|
|
{{% choosable language csharp %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="other_csharp">
|
|
<a href="#other_csharp" style="color: inherit; text-decoration: inherit;">Other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-required"
|
|
title="Required">
|
|
<span id="thinker_csharp">
|
|
<a href="#thinker_csharp" style="color: inherit; text-decoration: inherit;">Thinker</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}To ask and answer{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="answer_csharp">
|
|
<a href="#answer_csharp" style="color: inherit; text-decoration: inherit;">Answer</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">double</span>
|
|
</dt>
|
|
<dd>{{% md %}}The answer to the question{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="plainother_csharp">
|
|
<a href="#plainother_csharp" style="color: inherit; text-decoration: inherit;">Plain<wbr>Other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Test how plain types interact{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="question_csharp">
|
|
<a href="#question_csharp" style="color: inherit; text-decoration: inherit;">Question</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The question already answered{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="recursive_csharp">
|
|
<a href="#recursive_csharp" style="color: inherit; text-decoration: inherit;">Recursive</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language go %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="other_go">
|
|
<a href="#other_go" style="color: inherit; text-decoration: inherit;">Other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-required"
|
|
title="Required">
|
|
<span id="thinker_go">
|
|
<a href="#thinker_go" style="color: inherit; text-decoration: inherit;">Thinker</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}To ask and answer{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="answer_go">
|
|
<a href="#answer_go" style="color: inherit; text-decoration: inherit;">Answer</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">float64</span>
|
|
</dt>
|
|
<dd>{{% md %}}The answer to the question{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="plainother_go">
|
|
<a href="#plainother_go" style="color: inherit; text-decoration: inherit;">Plain<wbr>Other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Test how plain types interact{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="question_go">
|
|
<a href="#question_go" style="color: inherit; text-decoration: inherit;">Question</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The question already answered{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="recursive_go">
|
|
<a href="#recursive_go" style="color: inherit; text-decoration: inherit;">Recursive</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language nodejs %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="other_nodejs">
|
|
<a href="#other_nodejs" style="color: inherit; text-decoration: inherit;">other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-required"
|
|
title="Required">
|
|
<span id="thinker_nodejs">
|
|
<a href="#thinker_nodejs" style="color: inherit; text-decoration: inherit;">thinker</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}To ask and answer{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="answer_nodejs">
|
|
<a href="#answer_nodejs" style="color: inherit; text-decoration: inherit;">answer</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">number</span>
|
|
</dt>
|
|
<dd>{{% md %}}The answer to the question{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="plainother_nodejs">
|
|
<a href="#plainother_nodejs" style="color: inherit; text-decoration: inherit;">plain<wbr>Other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Test how plain types interact{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="question_nodejs">
|
|
<a href="#question_nodejs" style="color: inherit; text-decoration: inherit;">question</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">string</span>
|
|
</dt>
|
|
<dd>{{% md %}}The question already answered{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="recursive_nodejs">
|
|
<a href="#recursive_nodejs" style="color: inherit; text-decoration: inherit;">recursive</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
{{% choosable language python %}}
|
|
<dl class="resources-properties"><dt class="property-required"
|
|
title="Required">
|
|
<span id="other_python">
|
|
<a href="#other_python" style="color: inherit; text-decoration: inherit;">other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd><dt class="property-required"
|
|
title="Required">
|
|
<span id="thinker_python">
|
|
<a href="#thinker_python" style="color: inherit; text-decoration: inherit;">thinker</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}To ask and answer{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="answer_python">
|
|
<a href="#answer_python" style="color: inherit; text-decoration: inherit;">answer</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">float</span>
|
|
</dt>
|
|
<dd>{{% md %}}The answer to the question{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="plain_other_python">
|
|
<a href="#plain_other_python" style="color: inherit; text-decoration: inherit;">plain_<wbr>other</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#helmreleasesettings">Helm<wbr>Release<wbr>Settings</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}Test how plain types interact{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="question_python">
|
|
<a href="#question_python" style="color: inherit; text-decoration: inherit;">question</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type">str</span>
|
|
</dt>
|
|
<dd>{{% md %}}The question already answered{{% /md %}}</dd><dt class="property-optional"
|
|
title="Optional">
|
|
<span id="recursive_python">
|
|
<a href="#recursive_python" style="color: inherit; text-decoration: inherit;">recursive</a>
|
|
</span>
|
|
<span class="property-indicator"></span>
|
|
<span class="property-type"><a href="#layeredtype">Layered<wbr>Type</a></span>
|
|
</dt>
|
|
<dd>{{% md %}}{{% /md %}}</dd></dl>
|
|
{{% /choosable %}}
|
|
|
|
|
|
<h2 id="package-details">Package Details</h2>
|
|
<dl class="package-details">
|
|
<dt>Repository</dt>
|
|
<dd><a href=""></a></dd>
|
|
<dt>License</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|