Clarify localAsset and localArchive field descriptions

thomas11 · thomas11 · commit c8c200fed614 · 2024-05-13T16:40:25.000+02:00
diff --git a/provider/cmd/pulumi-resource-command/schema.json b/provider/cmd/pulumi-resource-command/schema.json
@@ -454,11 +454,11 @@
         },
         "localArchive": {
           "$ref": "pulumi.json#/Archive",
-          "description": "The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set."
+          "description": "An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set."
         },
         "localAsset": {
           "$ref": "pulumi.json#/Asset",
-          "description": "The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set."
+          "description": "An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set."
         },
         "remotePath": {
           "type": "string",
@@ -485,11 +485,11 @@
         },
         "localArchive": {
           "$ref": "pulumi.json#/Archive",
-          "description": "The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set."
+          "description": "An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set."
         },
         "localAsset": {
           "$ref": "pulumi.json#/Asset",
-          "description": "The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set."
+          "description": "An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set."
         },
         "remotePath": {
           "type": "string",
diff --git a/provider/pkg/provider/remote/copy.go b/provider/pkg/provider/remote/copy.go
@@ -40,8 +40,8 @@ type CopyInputs struct {
 func (c *CopyInputs) Annotate(a infer.Annotator) {
 	a.Describe(&c.Connection, "The parameters with which to connect to the remote host.")
 	a.Describe(&c.Triggers, "Trigger replacements on changes to this input.")
-	a.Describe(&c.LocalAsset, "The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.")
-	a.Describe(&c.LocalArchive, "The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.")
+	a.Describe(&c.LocalAsset, "An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.")
+	a.Describe(&c.LocalArchive, "An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.")
 	a.Describe(&c.RemotePath, "The destination path in the remote host.")
 }
 
diff --git a/sdk/dotnet/Remote/Copy.cs b/sdk/dotnet/Remote/Copy.cs
@@ -22,13 +22,13 @@ public partial class Copy : global::Pulumi.CustomResource
         public Output<Outputs.Connection> Connection { get; private set; } = null!;
 
         /// <summary>
-        /// The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+        /// An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
         /// </summary>
         [Output("localArchive")]
         public Output<Archive?> LocalArchive { get; private set; } = null!;
 
         /// <summary>
-        /// The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        /// An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         /// </summary>
         [Output("localAsset")]
         public Output<AssetOrArchive?> LocalAsset { get; private set; } = null!;
@@ -111,13 +111,13 @@ public Input<Inputs.ConnectionArgs>? Connection
         }
 
         /// <summary>
-        /// The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+        /// An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
         /// </summary>
         [Input("localArchive")]
         public Input<Archive>? LocalArchive { get; set; }
 
         /// <summary>
-        /// The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        /// An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         /// </summary>
         [Input("localAsset")]
         public Input<AssetOrArchive>? LocalAsset { get; set; }
diff --git a/sdk/go/command/remote/copy.go b/sdk/go/command/remote/copy.go
diff --git a/sdk/java/src/main/java/com/pulumi/command/remote/Copy.java b/sdk/java/src/main/java/com/pulumi/command/remote/Copy.java
@@ -39,28 +39,28 @@ public Output<Connection> connection() {
         return this.connection;
     }
     /**
-     * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     @Export(name="localArchive", refs={Archive.class}, tree="[0]")
     private Output</* @Nullable */ Archive> localArchive;
 
     /**
-     * @return The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * @return An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     public Output<Optional<Archive>> localArchive() {
         return Codegen.optional(this.localArchive);
     }
     /**
-     * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     @Export(name="localAsset", refs={AssetOrArchive.class}, tree="[0]")
     private Output</* @Nullable */ AssetOrArchive> localAsset;
 
     /**
-     * @return The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * @return An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     public Output<Optional<AssetOrArchive>> localAsset() {
diff --git a/sdk/java/src/main/java/com/pulumi/command/remote/CopyArgs.java b/sdk/java/src/main/java/com/pulumi/command/remote/CopyArgs.java
@@ -37,29 +37,29 @@ public Output<ConnectionArgs> connection() {
     }
 
     /**
-     * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     @Import(name="localArchive")
     private @Nullable Output<Archive> localArchive;
 
     /**
-     * @return The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * @return An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     public Optional<Output<Archive>> localArchive() {
         return Optional.ofNullable(this.localArchive);
     }
 
     /**
-     * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     @Import(name="localAsset")
     private @Nullable Output<AssetOrArchive> localAsset;
 
     /**
-     * @return The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * @return An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      * 
      */
     public Optional<Output<AssetOrArchive>> localAsset() {
@@ -146,7 +146,7 @@ public Builder connection(ConnectionArgs connection) {
         }
 
         /**
-         * @param localArchive The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+         * @param localArchive An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
          * 
          * @return builder
          * 
@@ -157,7 +157,7 @@ public Builder localArchive(@Nullable Output<Archive> localArchive) {
         }
 
         /**
-         * @param localArchive The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+         * @param localArchive An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
          * 
          * @return builder
          * 
@@ -167,7 +167,7 @@ public Builder localArchive(Archive localArchive) {
         }
 
         /**
-         * @param localAsset The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+         * @param localAsset An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
          * 
          * @return builder
          * 
@@ -178,7 +178,7 @@ public Builder localAsset(@Nullable Output<AssetOrArchive> localAsset) {
         }
 
         /**
-         * @param localAsset The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+         * @param localAsset An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
          * 
          * @return builder
          * 
diff --git a/sdk/nodejs/remote/copy.ts b/sdk/nodejs/remote/copy.ts
@@ -42,11 +42,11 @@ export class Copy extends pulumi.CustomResource {
      */
     public readonly connection!: pulumi.Output<outputs.remote.Connection>;
     /**
-     * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      */
     public readonly localArchive!: pulumi.Output<pulumi.asset.Archive | undefined>;
     /**
-     * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      */
     public readonly localAsset!: pulumi.Output<pulumi.asset.Asset | pulumi.asset.Archive | undefined>;
     /**
@@ -103,11 +103,11 @@ export interface CopyArgs {
      */
     connection: pulumi.Input<inputs.remote.ConnectionArgs>;
     /**
-     * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
      */
     localArchive?: pulumi.Input<pulumi.asset.Archive>;
     /**
-     * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+     * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
      */
     localAsset?: pulumi.Input<pulumi.asset.Asset | pulumi.asset.Archive>;
     /**
diff --git a/sdk/python/pulumi_command/remote/copy.py b/sdk/python/pulumi_command/remote/copy.py
@@ -25,8 +25,8 @@ def __init__(__self__, *,
         The set of arguments for constructing a Copy resource.
         :param pulumi.Input['ConnectionArgs'] connection: The parameters with which to connect to the remote host.
         :param pulumi.Input[str] remote_path: The destination path in the remote host.
-        :param pulumi.Input[pulumi.Archive] local_archive: The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
-        :param pulumi.Input[Union[pulumi.Asset, pulumi.Archive]] local_asset: The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        :param pulumi.Input[pulumi.Archive] local_archive: An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
+        :param pulumi.Input[Union[pulumi.Asset, pulumi.Archive]] local_asset: An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         :param pulumi.Input[Sequence[Any]] triggers: Trigger replacements on changes to this input.
         """
         pulumi.set(__self__, "connection", connection)
@@ -66,7 +66,7 @@ def remote_path(self, value: pulumi.Input[str]):
     @pulumi.getter(name="localArchive")
     def local_archive(self) -> Optional[pulumi.Input[pulumi.Archive]]:
         """
-        The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+        An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
         """
         return pulumi.get(self, "local_archive")
 
@@ -78,7 +78,7 @@ def local_archive(self, value: Optional[pulumi.Input[pulumi.Archive]]):
     @pulumi.getter(name="localAsset")
     def local_asset(self) -> Optional[pulumi.Input[Union[pulumi.Asset, pulumi.Archive]]]:
         """
-        The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         """
         return pulumi.get(self, "local_asset")
 
@@ -116,8 +116,8 @@ def __init__(__self__,
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[pulumi.InputType['ConnectionArgs']] connection: The parameters with which to connect to the remote host.
-        :param pulumi.Input[pulumi.Archive] local_archive: The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
-        :param pulumi.Input[Union[pulumi.Asset, pulumi.Archive]] local_asset: The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        :param pulumi.Input[pulumi.Archive] local_archive: An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
+        :param pulumi.Input[Union[pulumi.Asset, pulumi.Archive]] local_asset: An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         :param pulumi.Input[str] remote_path: The destination path in the remote host.
         :param pulumi.Input[Sequence[Any]] triggers: Trigger replacements on changes to this input.
         """
@@ -211,15 +211,15 @@ def connection(self) -> pulumi.Output['outputs.Connection']:
     @pulumi.getter(name="localArchive")
     def local_archive(self) -> pulumi.Output[Optional[pulumi.Archive]]:
         """
-        The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.
+        An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.
         """
         return pulumi.get(self, "local_archive")
 
     @property
     @pulumi.getter(name="localAsset")
     def local_asset(self) -> pulumi.Output[Optional[Union[pulumi.Asset, pulumi.Archive]]]:
         """
-        The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.
+        An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.
         """
         return pulumi.get(self, "local_asset")
 

Original file line number	Diff line number	Diff line change
`@@ -39,28 +39,28 @@ public Output<Connection> connection() {`
`39`	`39`	`return this.connection;`
`40`	`40`	`}`
`41`	`41`	`/**`
`42`		`- * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`42`	`+ * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`43`	`43`	`*`
`44`	`44`	`*/`
`45`	`45`	`@Export(name="localArchive", refs={Archive.class}, tree="[0]")`
`46`	`46`	`private Output</* @Nullable */ Archive> localArchive;`
`47`	`47`
`48`	`48`	`/**`
`49`		`- * @return The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`49`	`+ * @return An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`50`	`50`	`*`
`51`	`51`	`*/`
`52`	`52`	`public Output<Optional<Archive>> localArchive() {`
`53`	`53`	`return Codegen.optional(this.localArchive);`
`54`	`54`	`}`
`55`	`55`	`/**`
`56`		`- * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`56`	`+ * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`57`	`57`	`*`
`58`	`58`	`*/`
`59`	`59`	`@Export(name="localAsset", refs={AssetOrArchive.class}, tree="[0]")`
`60`	`60`	`private Output</* @Nullable */ AssetOrArchive> localAsset;`
`61`	`61`
`62`	`62`	`/**`
`63`		`- * @return The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`63`	`+ * @return An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`64`	`64`	`*`
`65`	`65`	`*/`
`66`	`66`	`public Output<Optional<AssetOrArchive>> localAsset() {`
Original file line number	Diff line number	Diff line change
`@@ -37,29 +37,29 @@ public Output<ConnectionArgs> connection() {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`
`40`		`- * The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`40`	`+ * An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`41`	`41`	`*`
`42`	`42`	`*/`
`43`	`43`	`@Import(name="localArchive")`
`44`	`44`	`private @Nullable Output<Archive> localArchive;`
`45`	`45`
`46`	`46`	`/**`
`47`		`- * @return The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`47`	`+ * @return An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`48`	`48`	`*`
`49`	`49`	`*/`
`50`	`50`	`public Optional<Output<Archive>> localArchive() {`
`51`	`51`	`return Optional.ofNullable(this.localArchive);`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`55`	`+ * An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`56`	`56`	`*`
`57`	`57`	`*/`
`58`	`58`	`@Import(name="localAsset")`
`59`	`59`	`private @Nullable Output<AssetOrArchive> localAsset;`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * @return The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`62`	`+ * @return An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`63`	`63`	`*`
`64`	`64`	`*/`
`65`	`65`	`public Optional<Output<AssetOrArchive>> localAsset() {`
`@@ -146,7 +146,7 @@ public Builder connection(ConnectionArgs connection) {`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`/**`
`149`		`- * @param localArchive The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`149`	`+ * @param localArchive An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`150`	`150`	`*`
`151`	`151`	`* @return builder`
`152`	`152`	`*`
`@@ -157,7 +157,7 @@ public Builder localArchive(@Nullable Output<Archive> localArchive) {`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`/**`
`160`		`- * @param localArchive The path of the folder or archive to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`160`	`+ * @param localArchive An archive to upload. It must be a path based archive. Only one of LocalAsset or LocalArchive can be set.`
`161`	`161`	`*`
`162`	`162`	`* @return builder`
`163`	`163`	`*`
`@@ -167,7 +167,7 @@ public Builder localArchive(Archive localArchive) {`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`/**`
`170`		`- * @param localAsset The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`170`	`+ * @param localAsset An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`171`	`171`	`*`
`172`	`172`	`* @return builder`
`173`	`173`	`*`
`@@ -178,7 +178,7 @@ public Builder localAsset(@Nullable Output<AssetOrArchive> localAsset) {`
`178`	`178`	`}`
`179`	`179`
`180`	`180`	`/**`
`181`		`- * @param localAsset The path of the file to be copied. Only one of LocalAsset or LocalArchive can be set.`
	`181`	`+ * @param localAsset An asset to upload. It must be a path based asset. Only one of LocalAsset or LocalArchive can be set.`
`182`	`182`	`*`
`183`	`183`	`* @return builder`
`184`	`184`	`*`