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

     1  
     2  ---
     3  title: "funcWithEmptyOutputs"
     4  title_tag: "mypkg.funcWithEmptyOutputs"
     5  meta_desc: "Documentation for the mypkg.funcWithEmptyOutputs 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  n/a
    16  
    17  
    18  
    19  
    20  ## Using funcWithEmptyOutputs {#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>funcWithEmptyOutputs<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">FuncWithEmptyOutputsArgs</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">FuncWithEmptyOutputsResult</a></span>></span
    37  ><span class="k">
    38  function </span>funcWithEmptyOutputsOutput<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">FuncWithEmptyOutputsOutputArgs</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">FuncWithEmptyOutputsResult</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_empty_outputs<span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
    48                              <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>FuncWithEmptyOutputsResult</span
    49  ><span class="k">
    50  def </span>func_with_empty_outputs_output<span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">Optional[pulumi.Input[str]]</span> = None<span class="p">,</span>
    51                              <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[FuncWithEmptyOutputsResult]</span
    52  ></code></pre></div>
    53  </pulumi-choosable>
    54  </div>
    55  
    56  
    57  <div>
    58  <pulumi-choosable type="language" values="go">
    59  <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"
    60  ><span class="k">func </span>FuncWithEmptyOutputs<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">FuncWithEmptyOutputsArgs</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">FuncWithEmptyOutputsResult</a></span>, error)</span
    61  ><span class="k">
    62  func </span>FuncWithEmptyOutputsOutput<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">FuncWithEmptyOutputsOutputArgs</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">) FuncWithEmptyOutputsResultOutput</span
    63  ></code></pre></div>
    64  
    65  &gt; Note: This function is named `FuncWithEmptyOutputs` in the Go SDK.
    66  
    67  </pulumi-choosable>
    68  </div>
    69  
    70  
    71  <div>
    72  <pulumi-choosable type="language" values="csharp">
    73  <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">FuncWithEmptyOutputs </span><span class="p">
    74  {</span><span class="k">
    75      public static </span>Task&lt;<span class="nx"><a href="#result">FuncWithEmptyOutputsResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">FuncWithEmptyOutputsArgs</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">
    76      public static </span>Output&lt;<span class="nx"><a href="#result">FuncWithEmptyOutputsResult</a></span>> <span class="p">Invoke(</span><span class="nx">FuncWithEmptyOutputsInvokeArgs</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">
    77  }</span></code></pre></div>
    78  </pulumi-choosable>
    79  </div>
    80  
    81  
    82  <div>
    83  <pulumi-choosable type="language" values="java">
    84  <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">FuncWithEmptyOutputsResult</a></span>> </span>funcWithEmptyOutputs<span class="p">(</span><span class="nx">FuncWithEmptyOutputsArgs</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>
    85  <span class="c">// Output-based functions aren't available in Java yet</span>
    86  </code></pre></div>
    87  </pulumi-choosable>
    88  </div>
    89  
    90  
    91  <div>
    92  <pulumi-choosable type="language" values="yaml">
    93  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span>
    94  <span class="k">&nbsp;&nbsp;function:</span> mypkg:funcWithEmptyOutputs
    95  <span class="k">&nbsp;&nbsp;arguments:</span>
    96  <span class="c">&nbsp;&nbsp;&nbsp;&nbsp;# arguments dictionary</span></code></pre></div>
    97  </pulumi-choosable>
    98  </div>
    99  
   100  
   101  
   102  The following arguments are supported:
   103  
   104  
   105  <div>
   106  <pulumi-choosable type="language" values="csharp">
   107  <dl class="resources-properties"><dt class="property-required"
   108              title="Required">
   109          <span id="name_csharp">
   110  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_csharp" style="color: inherit; text-decoration: inherit;">Name</a>
   111  </span>
   112          <span class="property-indicator"></span>
   113          <span class="property-type">string</span>
   114      </dt>
   115      <dd><p>The Name of the FeatureGroup.</p>
   116  </dd></dl>
   117  </pulumi-choosable>
   118  </div>
   119  
   120  <div>
   121  <pulumi-choosable type="language" values="go">
   122  <dl class="resources-properties"><dt class="property-required"
   123              title="Required">
   124          <span id="name_go">
   125  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_go" style="color: inherit; text-decoration: inherit;">Name</a>
   126  </span>
   127          <span class="property-indicator"></span>
   128          <span class="property-type">string</span>
   129      </dt>
   130      <dd><p>The Name of the FeatureGroup.</p>
   131  </dd></dl>
   132  </pulumi-choosable>
   133  </div>
   134  
   135  <div>
   136  <pulumi-choosable type="language" values="java">
   137  <dl class="resources-properties"><dt class="property-required"
   138              title="Required">
   139          <span id="name_java">
   140  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_java" style="color: inherit; text-decoration: inherit;">name</a>
   141  </span>
   142          <span class="property-indicator"></span>
   143          <span class="property-type">String</span>
   144      </dt>
   145      <dd><p>The Name of the FeatureGroup.</p>
   146  </dd></dl>
   147  </pulumi-choosable>
   148  </div>
   149  
   150  <div>
   151  <pulumi-choosable type="language" values="javascript,typescript">
   152  <dl class="resources-properties"><dt class="property-required"
   153              title="Required">
   154          <span id="name_nodejs">
   155  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_nodejs" style="color: inherit; text-decoration: inherit;">name</a>
   156  </span>
   157          <span class="property-indicator"></span>
   158          <span class="property-type">string</span>
   159      </dt>
   160      <dd><p>The Name of the FeatureGroup.</p>
   161  </dd></dl>
   162  </pulumi-choosable>
   163  </div>
   164  
   165  <div>
   166  <pulumi-choosable type="language" values="python">
   167  <dl class="resources-properties"><dt class="property-required"
   168              title="Required">
   169          <span id="name_python">
   170  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_python" style="color: inherit; text-decoration: inherit;">name</a>
   171  </span>
   172          <span class="property-indicator"></span>
   173          <span class="property-type">str</span>
   174      </dt>
   175      <dd><p>The Name of the FeatureGroup.</p>
   176  </dd></dl>
   177  </pulumi-choosable>
   178  </div>
   179  
   180  <div>
   181  <pulumi-choosable type="language" values="yaml">
   182  <dl class="resources-properties"><dt class="property-required"
   183              title="Required">
   184          <span id="name_yaml">
   185  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#name_yaml" style="color: inherit; text-decoration: inherit;">name</a>
   186  </span>
   187          <span class="property-indicator"></span>
   188          <span class="property-type">String</span>
   189      </dt>
   190      <dd><p>The Name of the FeatureGroup.</p>
   191  </dd></dl>
   192  </pulumi-choosable>
   193  </div>
   194  
   195  
   196  
   197  
   198  ## funcWithEmptyOutputs Result {#result}
   199  
   200  The following output properties are available:
   201  
   202  
   203  
   204  <div>
   205  <pulumi-choosable type="language" values="csharp">
   206  <dl class="resources-properties"></dl>
   207  </pulumi-choosable>
   208  </div>
   209  
   210  <div>
   211  <pulumi-choosable type="language" values="go">
   212  <dl class="resources-properties"></dl>
   213  </pulumi-choosable>
   214  </div>
   215  
   216  <div>
   217  <pulumi-choosable type="language" values="java">
   218  <dl class="resources-properties"></dl>
   219  </pulumi-choosable>
   220  </div>
   221  
   222  <div>
   223  <pulumi-choosable type="language" values="javascript,typescript">
   224  <dl class="resources-properties"></dl>
   225  </pulumi-choosable>
   226  </div>
   227  
   228  <div>
   229  <pulumi-choosable type="language" values="python">
   230  <dl class="resources-properties"></dl>
   231  </pulumi-choosable>
   232  </div>
   233  
   234  <div>
   235  <pulumi-choosable type="language" values="yaml">
   236  <dl class="resources-properties"></dl>
   237  </pulumi-choosable>
   238  </div>
   239  
   240  
   241  
   242  
   243  
   244  <h2 id="package-details">Package Details</h2>
   245  <dl class="package-details">
   246  	<dt>Repository</dt>
   247  	<dd><a href=""></a></dd>
   248  	<dt>License</dt>
   249  	<dd></dd>
   250  </dl>
   251