@pulumi/pulumi 3.153.2-alpha.x272ede0 → 3.153.2-alpha.x2d22a7c

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pulumi/pulumi",
-    "version": "3.153.2-alpha.x272ede0",
+    "version": "3.153.2-alpha.x2d22a7c",
     "description": "Pulumi's Node.js SDK",
     "license": "Apache-2.0",
     "repository": {

package/proto/provider_grpc_pb.js

@@ -736,6 +736,22 @@ attach: {
   },
   // GetMapping fetches the mapping for this resource provider, if any. A provider should return an empty
 // response (not an error) if it doesn't have a mapping for the given key.
+//
+// `GetMapping` returns mappings designed to aid in [converting programs and state from other
+// ecosystems](converters). It accepts a "conversion key", which effectively corresponds to a source language, such
+// as `terraform`, and a *source provider name*, which is the name of the provider *in the source language*. Given
+// these, it returns source-specific mapping data for the provider requested. As an example, the Pulumi AWS
+// provider, which is bridged from the Terraform AWS provider and thus capable of mapping names between the two,
+// might respond to a call with key `terraform` and source provider name `aws` with mapping data for transforming
+// (among other things) Terraform AWS names such as `aws_s3_bucket` into Pulumi AWS types such as
+// `aws:s3/bucket:Bucket`. If a provider only supports a single source provider, or has some sensible default, it
+// may respond also to a call in which the source provider name is empty (`""`), which will be made when the engine
+// does not have sufficient knowledge to work out which provider offers a specific mapping.
+//
+// In general, it is expected that providers implemented by bridging an equivalent provider from another ecosystem
+// (such as bridged Terraform providers built atop the `pulumi-terraform-bridge`, for instance) implement
+// `GetMapping` to support conversion from that ecosystem into Pulumi using the same logic that underpins the
+// bridging itself.
 getMapping: {
     path: '/pulumirpc.ResourceProvider/GetMapping',
     requestStream: false,
@@ -747,9 +763,17 @@ getMapping: {
     responseSerialize: serialize_pulumirpc_GetMappingResponse,
     responseDeserialize: deserialize_pulumirpc_GetMappingResponse,
   },
-  // GetMappings is an optional method that returns what mappings (if any) a provider supports. If a provider does not
-// implement this method the engine falls back to the old behaviour of just calling GetMapping without a name.
-// If this method is implemented than the engine will then call GetMapping only with the names returned from this method.
+  // `GetMappings` is an optional method designed to aid in [converting programs and state from other
+// ecosystems](converters). `GetMappings` accepts a "conversion key". This corresponds to a source language, for
+// which we want to retrieve mappings for names etc. from that source language into Pulumi. An example key might
+// therefore be `terraform` in the event that we wish to map e.g. Terraform resource names to Pulumi resource types.
+// Given a key, `GetMappings` returns a list of *source provider names* for which calls to `GetMapping` will return
+// mappings. So, continuing the Terraform example, the Pulumi AWS provider, which is bridged from the Terraform AWS
+// provider and thus capable of mapping names between the two, might return the list `["aws"]` in response to a call
+// with key `terraform`.
+//
+// If a provider does not implement `GetMappings`, the engine will fall back to calling `GetMapping` blindly without
+// a source provider name (that is, with the value `""`).
 getMappings: {
     path: '/pulumirpc.ResourceProvider/GetMappings',
     requestStream: false,

package/version.js

@@ -13,5 +13,5 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = "3.153.2-alpha.x272ede0";
+exports.version = "3.153.2-alpha.x2d22a7c";
 //# sourceMappingURL=version.js.map