github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/regress-node-8110/docs/examplefunc/_index.md (about) 1 2 --- 3 title: "exampleFunc" 4 title_tag: "my8110.exampleFunc" 5 meta_desc: "Documentation for the my8110.exampleFunc function with examples, input properties, output properties, and supporting types." 6 layout: api 7 no_edit_this_page: true 8 --- 9 10 11 12 <!-- WARNING: this file was generated by test. --> 13 <!-- Do not edit by hand unless you're certain you know what you are doing! --> 14 15 16 17 18 ## Using exampleFunc {#using} 19 20 <div> 21 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 22 </div> 23 24 25 <div> 26 <pulumi-choosable type="language" values="javascript,typescript"> 27 <div class="highlight" 28 ><pre class="chroma"><code class="language-typescript" data-lang="typescript" 29 ><span class="k">function </span>exampleFunc<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">ExampleFuncArgs</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/#InvokeOptions">InvokeOptions</a></span><span class="p">): Promise<<span class="nx"><a href="#result">ExampleFuncResult</a></span>></span 30 ></code></pre></div> 31 </pulumi-choosable> 32 </div> 33 34 35 <div> 36 <pulumi-choosable type="language" values="python"> 37 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python" 38 ><span class="k">def </span>example_func<span class="p">(</span><span class="nx">enums</span><span class="p">:</span> <span class="nx">Optional[Sequence[Union[str, MyEnum]]]</span> = None<span class="p">,</span> 39 <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.InvokeOptions">Optional[InvokeOptions]</a></span> = None<span class="p">) -></span> <span>ExampleFuncResult</span 40 ></code></pre></div> 41 </pulumi-choosable> 42 </div> 43 44 45 <div> 46 <pulumi-choosable type="language" values="go"> 47 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go" 48 ><span class="k">func </span>ExampleFunc<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">args</span><span class="p"> *</span><span class="nx">ExampleFuncArgs</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#InvokeOption">InvokeOption</a></span><span class="p">) (*<span class="nx"><a href="#result">ExampleFuncResult</a></span>, error)</span 49 ></code></pre></div> 50 51 > Note: This function is named `ExampleFunc` in the Go SDK. 52 53 </pulumi-choosable> 54 </div> 55 56 57 <div> 58 <pulumi-choosable type="language" values="csharp"> 59 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">ExampleFunc </span><span class="p"> 60 {</span><span class="k"> 61 public static </span>Task<<span class="nx"><a href="#result">ExampleFuncResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">ExampleFuncArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.InvokeOptions.html">InvokeOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span><span class="p"> 62 }</span></code></pre></div> 63 </pulumi-choosable> 64 </div> 65 66 67 <div> 68 <pulumi-choosable type="language" values="java"> 69 <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture<<span class="nx"><a href="#result">ExampleFuncResult</a></span>> </span>exampleFunc<span class="p">(</span><span class="nx">ExampleFuncArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">InvokeOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span> 70 <span class="c">// Output-based functions aren't available in Java yet</span> 71 </code></pre></div> 72 </pulumi-choosable> 73 </div> 74 75 76 <div> 77 <pulumi-choosable type="language" values="yaml"> 78 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span> 79 <span class="k"> function:</span> my8110:exampleFunc 80 <span class="k"> arguments:</span> 81 <span class="c"> # arguments dictionary</span></code></pre></div> 82 </pulumi-choosable> 83 </div> 84 85 86 87 The following arguments are supported: 88 89 90 <div> 91 <pulumi-choosable type="language" values="csharp"> 92 <dl class="resources-properties"><dt class="property-optional" 93 title="Optional"> 94 <span id="enums_csharp"> 95 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_csharp" style="color: inherit; text-decoration: inherit;">Enums</a> 96 </span> 97 <span class="property-indicator"></span> 98 <span class="property-type">List<Union<string, Pulumi.<wbr>My8110.<wbr>My<wbr>Enum>></span> 99 </dt> 100 <dd></dd></dl> 101 </pulumi-choosable> 102 </div> 103 104 <div> 105 <pulumi-choosable type="language" values="go"> 106 <dl class="resources-properties"><dt class="property-optional" 107 title="Optional"> 108 <span id="enums_go"> 109 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_go" style="color: inherit; text-decoration: inherit;">Enums</a> 110 </span> 111 <span class="property-indicator"></span> 112 <span class="property-type">[]string</span> 113 </dt> 114 <dd></dd></dl> 115 </pulumi-choosable> 116 </div> 117 118 <div> 119 <pulumi-choosable type="language" values="java"> 120 <dl class="resources-properties"><dt class="property-optional" 121 title="Optional"> 122 <span id="enums_java"> 123 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_java" style="color: inherit; text-decoration: inherit;">enums</a> 124 </span> 125 <span class="property-indicator"></span> 126 <span class="property-type">List<Either<String,My<wbr>Enum>></span> 127 </dt> 128 <dd></dd></dl> 129 </pulumi-choosable> 130 </div> 131 132 <div> 133 <pulumi-choosable type="language" values="javascript,typescript"> 134 <dl class="resources-properties"><dt class="property-optional" 135 title="Optional"> 136 <span id="enums_nodejs"> 137 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_nodejs" style="color: inherit; text-decoration: inherit;">enums</a> 138 </span> 139 <span class="property-indicator"></span> 140 <span class="property-type">(string | My<wbr>Enum)[]</span> 141 </dt> 142 <dd></dd></dl> 143 </pulumi-choosable> 144 </div> 145 146 <div> 147 <pulumi-choosable type="language" values="python"> 148 <dl class="resources-properties"><dt class="property-optional" 149 title="Optional"> 150 <span id="enums_python"> 151 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_python" style="color: inherit; text-decoration: inherit;">enums</a> 152 </span> 153 <span class="property-indicator"></span> 154 <span class="property-type">Sequence[Union[str, My<wbr>Enum]]</span> 155 </dt> 156 <dd></dd></dl> 157 </pulumi-choosable> 158 </div> 159 160 <div> 161 <pulumi-choosable type="language" values="yaml"> 162 <dl class="resources-properties"><dt class="property-optional" 163 title="Optional"> 164 <span id="enums_yaml"> 165 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#enums_yaml" style="color: inherit; text-decoration: inherit;">enums</a> 166 </span> 167 <span class="property-indicator"></span> 168 <span class="property-type">List<String | "one" | "two"></span> 169 </dt> 170 <dd></dd></dl> 171 </pulumi-choosable> 172 </div> 173 174 175 176 177 ## exampleFunc Result {#result} 178 179 The following output properties are available: 180 181 182 183 184 185 186 ## Supporting Types 187 188 189 <h4 id="myenum">My<wbr>Enum</h4> 190 191 192 193 194 195 196 197 <h2 id="package-details">Package Details</h2> 198 <dl class="package-details"> 199 <dt>Repository</dt> 200 <dd><a href=""></a></dd> 201 <dt>License</dt> 202 <dd></dd> 203 </dl> 204