github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/output-funcs/docs/funcwithalloptionalinputs/_index.md (about)

     1  
     2  ---
     3  title: "funcWithAllOptionalInputs"
     4  title_tag: "mypkg.funcWithAllOptionalInputs"
     5  meta_desc: "Documentation for the mypkg.funcWithAllOptionalInputs 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  Check codegen of functions with all optional inputs.
    16  
    17  
    18  
    19  
    20  ## Using funcWithAllOptionalInputs {#using}
    21  
    22  Two invocation forms are available. The direct form accepts plain
    23  arguments and either blocks until the result value is available, or
    24  returns a Promise-wrapped result. The output form accepts
    25  Input-wrapped arguments and returns an Output-wrapped result.
    26  
    27  <div>
    28  <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser>
    29  </div>
    30  
    31  
    32  <div>
    33  <pulumi-choosable type="language" values="javascript,typescript">
    34  <div class="highlight"
    35  ><pre class="chroma"><code class="language-typescript" data-lang="typescript"
    36  ><span class="k">function </span>funcWithAllOptionalInputs<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">FuncWithAllOptionalInputsArgs</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&lt;<span class="nx"><a href="#result">FuncWithAllOptionalInputsResult</a></span>></span
    37  ><span class="k">
    38  function </span>funcWithAllOptionalInputsOutput<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">FuncWithAllOptionalInputsOutputArgs</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">): Output&lt;<span class="nx"><a href="#result">FuncWithAllOptionalInputsResult</a></span>></span
    39  ></code></pre></div>
    40  </pulumi-choosable>
    41  </div>
    42  
    43  
    44  <div>
    45  <pulumi-choosable type="language" values="python">
    46  <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"
    47  ><span class="k">def </span>func_with_all_optional_inputs<span class="p">(</span><span class="nx">a</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
    48                                    <span class="nx">b</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
    49                                    <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">) -&gt;</span> <span>FuncWithAllOptionalInputsResult</span
    50  ><span class="k">
    51  def </span>func_with_all_optional_inputs_output<span class="p">(</span><span class="nx">a</span><span class="p">:</span> <span class="nx">Optional[pulumi.Input[str]]</span> = None<span class="p">,</span>
    52                                    <span class="nx">b</span><span class="p">:</span> <span class="nx">Optional[pulumi.Input[str]]</span> = None<span class="p">,</span>
    53                                    <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">) -&gt;</span> <span>Output[FuncWithAllOptionalInputsResult]</span
    54  ></code></pre></div>
    55  </pulumi-choosable>
    56  </div>
    57  
    58  
    59  <div>
    60  <pulumi-choosable type="language" values="go">
    61  <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"
    62  ><span class="k">func </span>FuncWithAllOptionalInputs<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">FuncWithAllOptionalInputsArgs</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">FuncWithAllOptionalInputsResult</a></span>, error)</span
    63  ><span class="k">
    64  func </span>FuncWithAllOptionalInputsOutput<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">FuncWithAllOptionalInputsOutputArgs</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">) FuncWithAllOptionalInputsResultOutput</span
    65  ></code></pre></div>
    66  
    67  &gt; Note: This function is named `FuncWithAllOptionalInputs` in the Go SDK.
    68  
    69  </pulumi-choosable>
    70  </div>
    71  
    72  
    73  <div>
    74  <pulumi-choosable type="language" values="csharp">
    75  <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">FuncWithAllOptionalInputs </span><span class="p">
    76  {</span><span class="k">
    77      public static </span>Task&lt;<span class="nx"><a href="#result">FuncWithAllOptionalInputsResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">FuncWithAllOptionalInputsArgs</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="k">
    78      public static </span>Output&lt;<span class="nx"><a href="#result">FuncWithAllOptionalInputsResult</a></span>> <span class="p">Invoke(</span><span class="nx">FuncWithAllOptionalInputsInvokeArgs</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">
    79  }</span></code></pre></div>
    80  </pulumi-choosable>
    81  </div>
    82  
    83  
    84  <div>
    85  <pulumi-choosable type="language" values="java">
    86  <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture&lt;<span class="nx"><a href="#result">FuncWithAllOptionalInputsResult</a></span>> </span>funcWithAllOptionalInputs<span class="p">(</span><span class="nx">FuncWithAllOptionalInputsArgs</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>
    87  <span class="c">// Output-based functions aren't available in Java yet</span>
    88  </code></pre></div>
    89  </pulumi-choosable>
    90  </div>
    91  
    92  
    93  <div>
    94  <pulumi-choosable type="language" values="yaml">
    95  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span>
    96  <span class="k">&nbsp;&nbsp;function:</span> mypkg:funcWithAllOptionalInputs
    97  <span class="k">&nbsp;&nbsp;arguments:</span>
    98  <span class="c">&nbsp;&nbsp;&nbsp;&nbsp;# arguments dictionary</span></code></pre></div>
    99  </pulumi-choosable>
   100  </div>
   101  
   102  
   103  
   104  The following arguments are supported:
   105  
   106  
   107  <div>
   108  <pulumi-choosable type="language" values="csharp">
   109  <dl class="resources-properties"><dt class="property-optional"
   110              title="Optional">
   111          <span id="a_csharp">
   112  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_csharp" style="color: inherit; text-decoration: inherit;">A</a>
   113  </span>
   114          <span class="property-indicator"></span>
   115          <span class="property-type">string</span>
   116      </dt>
   117      <dd><p>Property A</p>
   118  </dd><dt class="property-optional"
   119              title="Optional">
   120          <span id="b_csharp">
   121  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_csharp" style="color: inherit; text-decoration: inherit;">B</a>
   122  </span>
   123          <span class="property-indicator"></span>
   124          <span class="property-type">string</span>
   125      </dt>
   126      <dd><p>Property B</p>
   127  </dd></dl>
   128  </pulumi-choosable>
   129  </div>
   130  
   131  <div>
   132  <pulumi-choosable type="language" values="go">
   133  <dl class="resources-properties"><dt class="property-optional"
   134              title="Optional">
   135          <span id="a_go">
   136  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_go" style="color: inherit; text-decoration: inherit;">A</a>
   137  </span>
   138          <span class="property-indicator"></span>
   139          <span class="property-type">string</span>
   140      </dt>
   141      <dd><p>Property A</p>
   142  </dd><dt class="property-optional"
   143              title="Optional">
   144          <span id="b_go">
   145  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_go" style="color: inherit; text-decoration: inherit;">B</a>
   146  </span>
   147          <span class="property-indicator"></span>
   148          <span class="property-type">string</span>
   149      </dt>
   150      <dd><p>Property B</p>
   151  </dd></dl>
   152  </pulumi-choosable>
   153  </div>
   154  
   155  <div>
   156  <pulumi-choosable type="language" values="java">
   157  <dl class="resources-properties"><dt class="property-optional"
   158              title="Optional">
   159          <span id="a_java">
   160  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_java" style="color: inherit; text-decoration: inherit;">a</a>
   161  </span>
   162          <span class="property-indicator"></span>
   163          <span class="property-type">String</span>
   164      </dt>
   165      <dd><p>Property A</p>
   166  </dd><dt class="property-optional"
   167              title="Optional">
   168          <span id="b_java">
   169  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_java" style="color: inherit; text-decoration: inherit;">b</a>
   170  </span>
   171          <span class="property-indicator"></span>
   172          <span class="property-type">String</span>
   173      </dt>
   174      <dd><p>Property B</p>
   175  </dd></dl>
   176  </pulumi-choosable>
   177  </div>
   178  
   179  <div>
   180  <pulumi-choosable type="language" values="javascript,typescript">
   181  <dl class="resources-properties"><dt class="property-optional"
   182              title="Optional">
   183          <span id="a_nodejs">
   184  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_nodejs" style="color: inherit; text-decoration: inherit;">a</a>
   185  </span>
   186          <span class="property-indicator"></span>
   187          <span class="property-type">string</span>
   188      </dt>
   189      <dd><p>Property A</p>
   190  </dd><dt class="property-optional"
   191              title="Optional">
   192          <span id="b_nodejs">
   193  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_nodejs" style="color: inherit; text-decoration: inherit;">b</a>
   194  </span>
   195          <span class="property-indicator"></span>
   196          <span class="property-type">string</span>
   197      </dt>
   198      <dd><p>Property B</p>
   199  </dd></dl>
   200  </pulumi-choosable>
   201  </div>
   202  
   203  <div>
   204  <pulumi-choosable type="language" values="python">
   205  <dl class="resources-properties"><dt class="property-optional"
   206              title="Optional">
   207          <span id="a_python">
   208  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_python" style="color: inherit; text-decoration: inherit;">a</a>
   209  </span>
   210          <span class="property-indicator"></span>
   211          <span class="property-type">str</span>
   212      </dt>
   213      <dd><p>Property A</p>
   214  </dd><dt class="property-optional"
   215              title="Optional">
   216          <span id="b_python">
   217  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_python" style="color: inherit; text-decoration: inherit;">b</a>
   218  </span>
   219          <span class="property-indicator"></span>
   220          <span class="property-type">str</span>
   221      </dt>
   222      <dd><p>Property B</p>
   223  </dd></dl>
   224  </pulumi-choosable>
   225  </div>
   226  
   227  <div>
   228  <pulumi-choosable type="language" values="yaml">
   229  <dl class="resources-properties"><dt class="property-optional"
   230              title="Optional">
   231          <span id="a_yaml">
   232  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_yaml" style="color: inherit; text-decoration: inherit;">a</a>
   233  </span>
   234          <span class="property-indicator"></span>
   235          <span class="property-type">String</span>
   236      </dt>
   237      <dd><p>Property A</p>
   238  </dd><dt class="property-optional"
   239              title="Optional">
   240          <span id="b_yaml">
   241  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_yaml" style="color: inherit; text-decoration: inherit;">b</a>
   242  </span>
   243          <span class="property-indicator"></span>
   244          <span class="property-type">String</span>
   245      </dt>
   246      <dd><p>Property B</p>
   247  </dd></dl>
   248  </pulumi-choosable>
   249  </div>
   250  
   251  
   252  
   253  
   254  ## funcWithAllOptionalInputs Result {#result}
   255  
   256  The following output properties are available:
   257  
   258  
   259  
   260  <div>
   261  <pulumi-choosable type="language" values="csharp">
   262  <dl class="resources-properties"><dt class="property-"
   263              title="">
   264          <span id="r_csharp">
   265  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_csharp" style="color: inherit; text-decoration: inherit;">R</a>
   266  </span>
   267          <span class="property-indicator"></span>
   268          <span class="property-type">string</span>
   269      </dt>
   270      <dd></dd></dl>
   271  </pulumi-choosable>
   272  </div>
   273  
   274  <div>
   275  <pulumi-choosable type="language" values="go">
   276  <dl class="resources-properties"><dt class="property-"
   277              title="">
   278          <span id="r_go">
   279  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_go" style="color: inherit; text-decoration: inherit;">R</a>
   280  </span>
   281          <span class="property-indicator"></span>
   282          <span class="property-type">string</span>
   283      </dt>
   284      <dd></dd></dl>
   285  </pulumi-choosable>
   286  </div>
   287  
   288  <div>
   289  <pulumi-choosable type="language" values="java">
   290  <dl class="resources-properties"><dt class="property-"
   291              title="">
   292          <span id="r_java">
   293  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_java" style="color: inherit; text-decoration: inherit;">r</a>
   294  </span>
   295          <span class="property-indicator"></span>
   296          <span class="property-type">String</span>
   297      </dt>
   298      <dd></dd></dl>
   299  </pulumi-choosable>
   300  </div>
   301  
   302  <div>
   303  <pulumi-choosable type="language" values="javascript,typescript">
   304  <dl class="resources-properties"><dt class="property-"
   305              title="">
   306          <span id="r_nodejs">
   307  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_nodejs" style="color: inherit; text-decoration: inherit;">r</a>
   308  </span>
   309          <span class="property-indicator"></span>
   310          <span class="property-type">string</span>
   311      </dt>
   312      <dd></dd></dl>
   313  </pulumi-choosable>
   314  </div>
   315  
   316  <div>
   317  <pulumi-choosable type="language" values="python">
   318  <dl class="resources-properties"><dt class="property-"
   319              title="">
   320          <span id="r_python">
   321  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_python" style="color: inherit; text-decoration: inherit;">r</a>
   322  </span>
   323          <span class="property-indicator"></span>
   324          <span class="property-type">str</span>
   325      </dt>
   326      <dd></dd></dl>
   327  </pulumi-choosable>
   328  </div>
   329  
   330  <div>
   331  <pulumi-choosable type="language" values="yaml">
   332  <dl class="resources-properties"><dt class="property-"
   333              title="">
   334          <span id="r_yaml">
   335  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#r_yaml" style="color: inherit; text-decoration: inherit;">r</a>
   336  </span>
   337          <span class="property-indicator"></span>
   338          <span class="property-type">String</span>
   339      </dt>
   340      <dd></dd></dl>
   341  </pulumi-choosable>
   342  </div>
   343  
   344  
   345  
   346  
   347  
   348  <h2 id="package-details">Package Details</h2>
   349  <dl class="package-details">
   350  	<dt>Repository</dt>
   351  	<dd><a href=""></a></dd>
   352  	<dt>License</dt>
   353  	<dd></dd>
   354  </dl>
   355