@pulumi/pulumi 3.148.1-alpha.x2b2a8cc → 3.148.1-alpha.x92edac0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/pulumi",
3
- "version": "3.148.1-alpha.x2b2a8cc",
3
+ "version": "3.148.1-alpha.x92edac0",
4
4
  "description": "Pulumi's Node.js SDK",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -332,13 +332,12 @@ function deserialize_pulumirpc_RuntimeOptionsResponse(buffer_arg) {
332
332
  }
333
333
 
334
334
 
335
- // The LanguageRuntime service defines a standard interface for [language hosts/runtimes](languages). At a high level, a
336
- // language runtime provides the ability to execute programs, install and query dependencies, and generate code for a
337
- // specific language.
335
+ // LanguageRuntime is the interface that the planning monitor uses to drive execution of an interpreter responsible
336
+ // for confguring and creating resource objects.
338
337
  var LanguageRuntimeService = exports.LanguageRuntimeService = {
339
- // `Handshake` is the first call made by the engine to a language host. It is used to pass the engine's address to
340
- // the language host so that it may establish its own connections back, and to establish protocol configuration that
341
- // will be used to communicate between the two parties.
338
+ // `Handshake` is the first call made by the engine to a language host. It is used to pass the
339
+ // engine's address to the language host so that it may establish its own connections back,
340
+ // and to establish protocol configuration that will be used to communicate between the two parties.
342
341
  handshake: {
343
342
  path: '/pulumirpc.LanguageRuntime/Handshake',
344
343
  requestStream: false,
@@ -350,15 +349,7 @@ handshake: {
350
349
  responseSerialize: serialize_pulumirpc_LanguageHandshakeResponse,
351
350
  responseDeserialize: deserialize_pulumirpc_LanguageHandshakeResponse,
352
351
  },
353
- // `GetRequiredPlugins` computes the complete set of anticipated [plugins](plugins) required by a Pulumi program.
354
- // Among other things, it is intended to be used to pre-install plugins before running a program with
355
- // [](pulumirpc.LanguageRuntime.Run), to avoid the need to install them on-demand in response to [resource
356
- // registrations](resource-registration) sent back from the running program to the engine.
357
- //
358
- // :::{important}
359
- // The use of `GetRequiredPlugins` is deprecated in favour of [](pulumirpc.LanguageRuntime.GetRequiredPackages),
360
- // which returns more granular information about which plugins are required by which packages.
361
- // :::
352
+ // GetRequiredPlugins computes the complete set of anticipated plugins required by a program.
362
353
  getRequiredPlugins: {
363
354
  path: '/pulumirpc.LanguageRuntime/GetRequiredPlugins',
364
355
  requestStream: false,
@@ -370,15 +361,7 @@ getRequiredPlugins: {
370
361
  responseSerialize: serialize_pulumirpc_GetRequiredPluginsResponse,
371
362
  responseDeserialize: deserialize_pulumirpc_GetRequiredPluginsResponse,
372
363
  },
373
- // `GetRequiredPackages` computes the complete set of anticipated [packages](pulumirpc.PackageDependency) required
374
- // by a program. It is used to pre-install packages before running a program with [](pulumirpc.LanguageRuntime.Run),
375
- // to avoid the need to install them on-demand in response to [resource registrations](resource-registration) sent
376
- // back from the running program to the engine. Moreover, when importing resources into a stack, it is used to
377
- // determine which plugins are required to service the import of a given resource, since given the presence of
378
- // [parameterized providers](parameterized-providers), it is not in general true that a package name corresponds 1:1
379
- // with a plugin name. It replaces [](pulumirpc.LanguageRuntime.GetRequiredPlugins) in the face of [parameterized
380
- // providers](parameterized-providers), which as mentioned above can enable multiple instances of the same plugin to
381
- // provide multiple packages.
364
+ // GetRequiredPackages computes the complete set of anticipated packages required by a program.
382
365
  getRequiredPackages: {
383
366
  path: '/pulumirpc.LanguageRuntime/GetRequiredPackages',
384
367
  requestStream: false,
@@ -390,7 +373,7 @@ getRequiredPackages: {
390
373
  responseSerialize: serialize_pulumirpc_GetRequiredPackagesResponse,
391
374
  responseDeserialize: deserialize_pulumirpc_GetRequiredPackagesResponse,
392
375
  },
393
- // `Run` executes a Pulumi program, returning information about whether or not the program produced an error.
376
+ // Run executes a program and returns its result.
394
377
  run: {
395
378
  path: '/pulumirpc.LanguageRuntime/Run',
396
379
  requestStream: false,
@@ -402,7 +385,7 @@ run: {
402
385
  responseSerialize: serialize_pulumirpc_RunResponse,
403
386
  responseDeserialize: deserialize_pulumirpc_RunResponse,
404
387
  },
405
- // `GetPluginInfo` returns information about the [plugin](plugins) implementing this language runtime.
388
+ // GetPluginInfo returns generic information about this plugin, like its version.
406
389
  getPluginInfo: {
407
390
  path: '/pulumirpc.LanguageRuntime/GetPluginInfo',
408
391
  requestStream: false,
@@ -414,11 +397,7 @@ getPluginInfo: {
414
397
  responseSerialize: serialize_pulumirpc_PluginInfo,
415
398
  responseDeserialize: deserialize_pulumirpc_PluginInfo,
416
399
  },
417
- // `InstallDependencies` accepts a request specifying a Pulumi project and program that can be executed with
418
- // [](pulumirpc.LanguageRuntime.Run) and installs the dependencies for that program (e.g. by running `npm install`
419
- // for NodeJS, or `pip install` for Python). Since dependency installation could take a while, and callers may wish
420
- // to report on its progress, this method returns a stream of [](pulumirpc.InstallDependenciesResponse) messages
421
- // containing information about standard error and output.
400
+ // InstallDependencies will install dependencies for the project, e.g. by running `npm install` for nodejs projects.
422
401
  installDependencies: {
423
402
  path: '/pulumirpc.LanguageRuntime/InstallDependencies',
424
403
  requestStream: false,
@@ -430,8 +409,7 @@ installDependencies: {
430
409
  responseSerialize: serialize_pulumirpc_InstallDependenciesResponse,
431
410
  responseDeserialize: deserialize_pulumirpc_InstallDependenciesResponse,
432
411
  },
433
- // `RuntimeOptionsPrompts` accepts a request specifying a Pulumi project and returns a list of additional prompts to
434
- // ask during `pulumi new`.
412
+ // RuntimeOptionsPrompts returns a list of additional prompts to ask during `pulumi new`.
435
413
  runtimeOptionsPrompts: {
436
414
  path: '/pulumirpc.LanguageRuntime/RuntimeOptionsPrompts',
437
415
  requestStream: false,
@@ -443,7 +421,7 @@ runtimeOptionsPrompts: {
443
421
  responseSerialize: serialize_pulumirpc_RuntimeOptionsResponse,
444
422
  responseDeserialize: deserialize_pulumirpc_RuntimeOptionsResponse,
445
423
  },
446
- // `About` returns information about the language runtime being used.
424
+ // About returns information about the runtime for this language.
447
425
  about: {
448
426
  path: '/pulumirpc.LanguageRuntime/About',
449
427
  requestStream: false,
@@ -455,8 +433,7 @@ about: {
455
433
  responseSerialize: serialize_pulumirpc_AboutResponse,
456
434
  responseDeserialize: deserialize_pulumirpc_AboutResponse,
457
435
  },
458
- // `GetProgramDependencies` computes the set of language-level dependencies (e.g. NPM packages for NodeJS, or Maven
459
- // libraries for Java) required by a program.
436
+ // GetProgramDependencies returns the set of dependencies required by the program.
460
437
  getProgramDependencies: {
461
438
  path: '/pulumirpc.LanguageRuntime/GetProgramDependencies',
462
439
  requestStream: false,
@@ -468,11 +445,7 @@ getProgramDependencies: {
468
445
  responseSerialize: serialize_pulumirpc_GetProgramDependenciesResponse,
469
446
  responseDeserialize: deserialize_pulumirpc_GetProgramDependenciesResponse,
470
447
  },
471
- // `RunPlugin` is used to execute a program written in this host's language that implements a Pulumi
472
- // [plugin](plugins). It it is plugins what [](pulumirpc.LanguageRuntime.Run) is to programs. Since a plugin is not
473
- // expected to terminate until instructed/for a long time, this method returns a stream of
474
- // [](pulumirpc.RunPluginResponse) messages containing information about standard error and output, as well as the
475
- // exit code of the plugin when it does terminate.
448
+ // RunPlugin executes a plugin program and returns its result asynchronously.
476
449
  runPlugin: {
477
450
  path: '/pulumirpc.LanguageRuntime/RunPlugin',
478
451
  requestStream: false,
@@ -484,11 +457,7 @@ runPlugin: {
484
457
  responseSerialize: serialize_pulumirpc_RunPluginResponse,
485
458
  responseDeserialize: deserialize_pulumirpc_RunPluginResponse,
486
459
  },
487
- // `GenerateProgram` generates code in this host's language that implements the given [PCL](pcl) program. Unlike
488
- // [](pulumirpc.LanguageRuntime.GenerateProject), this method *only* generates program code, and does not e.g.
489
- // generate a `package.json` for a NodeJS project that details how to run that code.
490
- // [](pulumirpc.LanguageRuntime.GenerateProject), this method underpins ["programgen"](programgen) and the main
491
- // functionality powering `pulumi convert`.
460
+ // GenerateProgram generates a given PCL program into a program for this language.
492
461
  generateProgram: {
493
462
  path: '/pulumirpc.LanguageRuntime/GenerateProgram',
494
463
  requestStream: false,
@@ -500,12 +469,7 @@ generateProgram: {
500
469
  responseSerialize: serialize_pulumirpc_GenerateProgramResponse,
501
470
  responseDeserialize: deserialize_pulumirpc_GenerateProgramResponse,
502
471
  },
503
- // `GenerateProject` generates code in this host's language that implements the given [PCL](pcl) program and wraps
504
- // it in some language-specific notion of a "project", where a project is a buildable or runnable artifact. In this
505
- // sense, `GenerateProject`'s output is a superset of that of [](pulumirpc.LanguageRuntime.GenerateProgram). For
506
- // instance, when generating a NodeJS project, this method might generate a corresponding `package.json` file, as
507
- // well as the relevant NodeJS program code. Along with [](pulumirpc.LanguageRuntime.GenerateProgram), this method
508
- // underpins ["programgen"](programgen) and the main functionality powering `pulumi convert`.
472
+ // GenerateProject generates a given PCL program into a project for this language.
509
473
  generateProject: {
510
474
  path: '/pulumirpc.LanguageRuntime/GenerateProject',
511
475
  requestStream: false,
@@ -517,8 +481,7 @@ generateProject: {
517
481
  responseSerialize: serialize_pulumirpc_GenerateProjectResponse,
518
482
  responseDeserialize: deserialize_pulumirpc_GenerateProjectResponse,
519
483
  },
520
- // `GeneratePackage` generates code in this host's language that implements an [SDK](sdkgen) ("sdkgen") for the
521
- // given Pulumi package, as specified by a [schema](schema).
484
+ // GeneratePackage generates a given pulumi package into a package for this language.
522
485
  generatePackage: {
523
486
  path: '/pulumirpc.LanguageRuntime/GeneratePackage',
524
487
  requestStream: false,
@@ -530,11 +493,7 @@ generatePackage: {
530
493
  responseSerialize: serialize_pulumirpc_GeneratePackageResponse,
531
494
  responseDeserialize: deserialize_pulumirpc_GeneratePackageResponse,
532
495
  },
533
- // `Pack` accepts a request specifying a generated SDK package and packs it into a language-specific artifact. For
534
- // instance, in the case of Java, it might produce a JAR file from a list of `.java` sources; in the case of NodeJS,
535
- // a `.tgz` file might be produced from a list of `.js` sources; and so on. Presently, `Pack` is primarily used in
536
- // [language conformance tests](language-conformance-tests), though it is intended to be used more widely in future
537
- // to standardise e.g. provider publishing workflows.
496
+ // Pack packs a package into a language specific artifact.
538
497
  pack: {
539
498
  path: '/pulumirpc.LanguageRuntime/Pack',
540
499
  requestStream: false,
@@ -294,9 +294,7 @@ registerStackInvokeTransform: {
294
294
  responseSerialize: serialize_google_protobuf_Empty,
295
295
  responseDeserialize: deserialize_google_protobuf_Empty,
296
296
  },
297
- // Registers a package and allocates a packageRef. The same package can be registered multiple times in Pulumi.
298
- // Multiple requests are idempotent and guaranteed to return the same result.
299
- registerPackage: {
297
+ registerPackage: {
300
298
  path: '/pulumirpc.ResourceMonitor/RegisterPackage',
301
299
  requestStream: false,
302
300
  responseStream: false,
package/version.js CHANGED
@@ -13,5 +13,5 @@
13
13
  // See the License for the specific language governing permissions and
14
14
  // limitations under the License.
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.version = "3.148.1-alpha.x2b2a8cc";
16
+ exports.version = "3.148.1-alpha.x92edac0";
17
17
  //# sourceMappingURL=version.js.map