Add --exclude and --exclude-dependents to the Automation API (#1781)

i-am-tom · web-flow · commit a9d02795aa47 · 2025-04-29T16:18:59.000+02:00
Copying the same structure of `targets` and `targetDependents`.
diff --git a/CHANGELOG_PENDING.md b/CHANGELOG_PENDING.md
@@ -2,4 +2,6 @@
 
 * Support generating programs using the `import` resource option
 
-### Bug Fixes
+* Support `--exclude` and `--exclude-dependents` in the Automation API.
+
+### Bug Fixes
diff --git a/sdk/java/pulumi/src/main/java/com/pulumi/automation/DestroyOptions.java b/sdk/java/pulumi/src/main/java/com/pulumi/automation/DestroyOptions.java
@@ -7,13 +7,15 @@
  * operation.
  */
 public final class DestroyOptions extends UpdateOptions {
+    private final boolean excludeDependents;
     private final boolean targetDependents;
     private final boolean showSecrets;
     private final boolean continueOnError;
     private final boolean previewOnly;
 
     private DestroyOptions(Builder builder) {
         super(builder);
+        this.excludeDependents = builder.excludeDependents;
         this.targetDependents = builder.targetDependents;
         this.showSecrets = builder.showSecrets;
         this.continueOnError = builder.continueOnError;
@@ -29,6 +31,16 @@ public static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Allows exclusion of dependent targets discovered but not specified
+     * {@link #excludes()}
+     *
+     * @return true if dependent targets should be excluded
+     */
+    public boolean isExcludeDependents() {
+        return excludeDependents;
+    }
+
     /**
      * Allows updating of dependent targets discovered but not specified
      * {@link #targets()}
@@ -70,6 +82,7 @@ public boolean previewOnly() {
      * Builder for {@link DestroyOptions}.
      */
     public static final class Builder extends UpdateOptions.Builder<DestroyOptions.Builder> {
+        private boolean excludeDependents;
         private boolean targetDependents;
         private boolean showSecrets;
         private boolean continueOnError;
@@ -78,6 +91,18 @@ public static final class Builder extends UpdateOptions.Builder<DestroyOptions.B
         private Builder() {
         }
 
+        /**
+         * Allows exclusion of dependent targets discovered but not specified
+         * {@link #excludes}.
+         *
+         * @param excludeDependents true if dependent targets should be excluded
+         * @return the builder
+         */
+        public Builder excludeDependents(boolean excludeDependents) {
+            this.excludeDependents = excludeDependents;
+            return this;
+        }
+
         /**
          * Allows updating of dependent targets discovered but not specified
          * {@link #targets}.
diff --git a/sdk/java/pulumi/src/main/java/com/pulumi/automation/PreviewOptions.java b/sdk/java/pulumi/src/main/java/com/pulumi/automation/PreviewOptions.java
@@ -19,6 +19,7 @@ public final class PreviewOptions extends UpdateOptions {
     private final boolean expectNoChanges;
     private final boolean diff;
     private final List<String> replaces;
+    private final boolean excludeDependents;
     private final boolean targetDependents;
     @Nullable
     private final Consumer<Context> program;
@@ -34,6 +35,7 @@ private PreviewOptions(Builder builder) {
         this.replaces = builder.replaces == null
                 ? Collections.emptyList()
                 : Collections.unmodifiableList(builder.replaces);
+        this.excludeDependents = builder.excludeDependents;
         this.targetDependents = builder.targetDependents;
         this.program = builder.program;
         this.plan = builder.plan;
@@ -76,6 +78,16 @@ public List<String> replaces() {
         return replaces;
     }
 
+    /**
+     * Allows exclusion of dependent targets discovered but not specified
+     * {@link #excludes()}
+     *
+     * @return true if dependent targets should be excluded
+     */
+    public boolean excludeDependents() {
+        return excludeDependents;
+    }
+
     /**
      * Allows updating of dependent targets discovered but not specified
      * {@link #targets()}
@@ -125,6 +137,7 @@ public static final class Builder extends UpdateOptions.Builder<PreviewOptions.B
         private boolean diff;
         @Nullable
         private List<String> replaces;
+        private boolean excludeDependents;
         private boolean targetDependents;
         @Nullable
         private Consumer<Context> program;
@@ -170,6 +183,18 @@ public Builder replaces(List<String> replaces) {
             return this;
         }
 
+        /**
+         * Allows exclusion of dependent targets discovered but not specified
+         * {@link #excludes()}
+         *
+         * @param excludeDependents true if dependent targets should be excluded
+         * @return the builder
+         */
+        public Builder excludeDependents(boolean excludeDependents) {
+            this.excludeDependents = excludeDependents;
+            return this;
+        }
+
         /**
          * Allows updating of dependent targets discovered but not specified
          * {@link #targets()}
diff --git a/sdk/java/pulumi/src/main/java/com/pulumi/automation/UpOptions.java b/sdk/java/pulumi/src/main/java/com/pulumi/automation/UpOptions.java
@@ -17,6 +17,7 @@ public final class UpOptions extends UpdateOptions {
     private final boolean expectNoChanges;
     private final boolean diff;
     private final List<String> replaces;
+    private final boolean excludeDependents;
     private final boolean targetDependents;
     @Nullable
     private final Consumer<Context> program;
@@ -32,6 +33,7 @@ private UpOptions(Builder builder) {
         this.expectNoChanges = builder.expectNoChanges;
         this.diff = builder.diff;
         this.replaces = builder.replaces;
+        this.excludeDependents = builder.excludeDependents;
         this.targetDependents = builder.targetDependents;
         this.program = builder.program;
         this.plan = builder.plan;
@@ -76,6 +78,16 @@ public List<String> replaces() {
         return replaces;
     }
 
+    /**
+     * Allows exclusion of dependent targets discovered but not specified
+     * {@link #excludes()}
+     *
+     * @return true if dependent targets should be excluded
+     */
+    public boolean excludeDependents() {
+        return excludeDependents;
+    }
+
     /**
      * Allows updating of dependent targets discovered but not specified
      * {@link #targets()}
@@ -143,6 +155,7 @@ public static final class Builder extends UpdateOptions.Builder<UpOptions.Builde
         private boolean diff;
         @Nullable
         private List<String> replaces;
+        private boolean excludeDependents;
         private boolean targetDependents;
         @Nullable
         private Consumer<Context> program;
@@ -190,6 +203,18 @@ public Builder replaces(List<String> replaces) {
             return this;
         }
 
+        /**
+         * Allows exclusion of dependent targets discovered but not specified
+         * {@link #excludes}.
+         *
+         * @param excludeDependents true if dependent targets should be excluded
+         * @return the builder
+         */
+        public Builder excludeDependents(boolean excludeDependents) {
+            this.excludeDependents = excludeDependents;
+            return this;
+        }
+
         /**
          * Allows updating of dependent targets discovered but not specified
          * {@link #targets}.
diff --git a/sdk/java/pulumi/src/main/java/com/pulumi/automation/UpdateOptions.java b/sdk/java/pulumi/src/main/java/com/pulumi/automation/UpdateOptions.java
@@ -19,6 +19,7 @@ public abstract class UpdateOptions {
     private final Integer parallel;
     @Nullable
     private final String message;
+    private final List<String> excludes;
     private final List<String> targets;
     private final List<String> policyPacks;
     private final List<String> policyPackConfigs;
@@ -42,6 +43,9 @@ public abstract class UpdateOptions {
     protected UpdateOptions(Builder<?> builder) {
         parallel = builder.parallel;
         message = builder.message;
+        excludes = builder.excludes == null
+                ? Collections.emptyList()
+                : Collections.unmodifiableList(builder.excludes);
         targets = builder.targets == null
                 ? Collections.emptyList()
                 : Collections.unmodifiableList(builder.targets);
@@ -84,6 +88,16 @@ public String Message() {
         return message;
     }
 
+    /**
+     * A list of resource URNs to exclude during the operation. Wildcards
+     * (*, **) are also supported.
+     *
+     * @return the list of excluded resource URNs
+     */
+    public List<String> excludes() {
+        return excludes;
+    }
+
     /**
      * A list of resource URNs to target during the operation. Wildcards (*, **) are
      * also supported.
@@ -219,6 +233,8 @@ public static abstract class Builder<B extends Builder<B>> {
         @Nullable
         private String message;
         @Nullable
+        private List<String> excludes;
+        @Nullable
         private List<String> targets;
         @Nullable
         private List<String> policyPacks;
@@ -269,6 +285,19 @@ public B message(String message) {
             return (B) this;
         }
 
+        /**
+         * A list of resource URNs to exclude during the operation. Wildcards
+         * (*, **) are also supported.
+         *
+         * @param excludes the list of excluded resource URNs
+         * @return the builder
+         */
+        @SuppressWarnings("unchecked")
+        public B excludes(List<String> excludes) {
+            this.excludes = excludes;
+            return (B) this;
+        }
+
         /**
          * A list of resource URNs to target during the operation. Wildcards (*, **) are
          * also supported.
diff --git a/sdk/java/pulumi/src/main/java/com/pulumi/automation/WorkspaceStack.java b/sdk/java/pulumi/src/main/java/com/pulumi/automation/WorkspaceStack.java
@@ -422,6 +422,10 @@ public UpResult up(UpOptions options) throws AutomationException {
                 }
             }
 
+            if (options.excludeDependents()) {
+                args.add("--exclude-dependents");
+            }
+
             if (options.targetDependents()) {
                 args.add("--target-dependents");
             }
@@ -541,6 +545,10 @@ public PreviewResult preview(PreviewOptions options) throws AutomationException
                 }
             }
 
+            if (options.excludeDependents()) {
+                args.add("--exclude-dependents");
+            }
+
             if (options.targetDependents()) {
                 args.add("--target-dependents");
             }
@@ -730,6 +738,10 @@ public UpdateResult destroy(DestroyOptions options) throws AutomationException {
         }
 
         if (options != null) {
+            if (options.isExcludeDependents()) {
+                args.add("--exclude-dependents");
+            }
+
             if (options.isTargetDependents()) {
                 args.add("--target-dependents");
             }
@@ -970,6 +982,14 @@ private static void applyUpdateOptions(UpdateOptions options, ArrayList<String>
             }
         }
 
+        var excludes = options.excludes();
+        if (excludes != null) {
+            for (var item : excludes) {
+                args.add("--exclude");
+                args.add(item);
+            }
+        }
+
         var policyPacks = options.policyPacks();
         if (policyPacks != null) {
             for (var item : policyPacks) {

Original file line number	Diff line number	Diff line change
`@@ -422,6 +422,10 @@ public UpResult up(UpOptions options) throws AutomationException {`
`422`	`422`	`}`
`423`	`423`	`}`
`424`	`424`
	`425`	`+ if (options.excludeDependents()) {`
	`426`	`+ args.add("--exclude-dependents");`
	`427`	`+ }`
	`428`	`+`
`425`	`429`	`if (options.targetDependents()) {`
`426`	`430`	`args.add("--target-dependents");`
`427`	`431`	`}`
`@@ -541,6 +545,10 @@ public PreviewResult preview(PreviewOptions options) throws AutomationException`
`541`	`545`	`}`
`542`	`546`	`}`
`543`	`547`
	`548`	`+ if (options.excludeDependents()) {`
	`549`	`+ args.add("--exclude-dependents");`
	`550`	`+ }`
	`551`	`+`
`544`	`552`	`if (options.targetDependents()) {`
`545`	`553`	`args.add("--target-dependents");`
`546`	`554`	`}`
`@@ -730,6 +738,10 @@ public UpdateResult destroy(DestroyOptions options) throws AutomationException {`
`730`	`738`	`}`
`731`	`739`
`732`	`740`	`if (options != null) {`
	`741`	`+ if (options.isExcludeDependents()) {`
	`742`	`+ args.add("--exclude-dependents");`
	`743`	`+ }`
	`744`	`+`
`733`	`745`	`if (options.isTargetDependents()) {`
`734`	`746`	`args.add("--target-dependents");`
`735`	`747`	`}`
`@@ -970,6 +982,14 @@ private static void applyUpdateOptions(UpdateOptions options, ArrayList<String>`
`970`	`982`	`}`
`971`	`983`	`}`
`972`	`984`
	`985`	`+ var excludes = options.excludes();`
	`986`	`+ if (excludes != null) {`
	`987`	`+ for (var item : excludes) {`
	`988`	`+ args.add("--exclude");`
	`989`	`+ args.add(item);`
	`990`	`+ }`
	`991`	`+ }`
	`992`	`+`
`973`	`993`	`var policyPacks = options.policyPacks();`
`974`	`994`	`if (policyPacks != null) {`
`975`	`995`	`for (var item : policyPacks) {`