fix(Context-Based Restrictions): add support for the X-Correlation-Id header (#130)

Author: JonahFarc

modules/context-based-restrictions/src/main/java/com/ibm/cloud/platform_services/context_based_restrictions/v1/ContextBasedRestrictions.java

@@ -50,8 +50,8 @@
 
 /**
  * With the Context Based Restrictions API, you can:
- * * Create, list, get, update, and delete network zones
- * * Create, list, get, update, and delete context-based restriction rules
+ * * Create, list, get, replace, and delete network zones
+ * * Create, list, get, replace, and delete context-based restriction rules
  * * Get account settings
  * .
  *
@@ -100,7 +100,7 @@ public ContextBasedRestrictions(String serviceName, Authenticator authenticator)
   }
 
   /**
-   * Create a zone.
+   * Create a network zone.
    *
    * This operation creates a network zone for the specified account.
    *
@@ -119,6 +119,9 @@ public ServiceCall<Zone> createZone(CreateZoneOptions createZoneOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (createZoneOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", createZoneOptions.xCorrelationId());
+    }
     if (createZoneOptions.transactionId() != null) {
       builder.header("Transaction-Id", createZoneOptions.transactionId());
     }
@@ -147,7 +150,7 @@ public ServiceCall<Zone> createZone(CreateZoneOptions createZoneOptions) {
   }
 
   /**
-   * Create a zone.
+   * Create a network zone.
    *
    * This operation creates a network zone for the specified account.
    *
@@ -174,6 +177,9 @@ public ServiceCall<ZoneList> listZones(ListZonesOptions listZonesOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (listZonesOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", listZonesOptions.xCorrelationId());
+    }
     if (listZonesOptions.transactionId() != null) {
       builder.header("Transaction-Id", listZonesOptions.transactionId());
     }
@@ -190,9 +196,9 @@ public ServiceCall<ZoneList> listZones(ListZonesOptions listZonesOptions) {
   }
 
   /**
-   * Get the specified network zone.
+   * Get a network zone.
    *
-   * This operation returns the network zone for the specified ID.
+   * This operation retrieves the network zone identified by the specified zone ID.
    *
    * @param getZoneOptions the {@link GetZoneOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link Zone}
@@ -208,6 +214,9 @@ public ServiceCall<Zone> getZone(GetZoneOptions getZoneOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (getZoneOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", getZoneOptions.xCorrelationId());
+    }
     if (getZoneOptions.transactionId() != null) {
       builder.header("Transaction-Id", getZoneOptions.transactionId());
     }
@@ -217,9 +226,10 @@ public ServiceCall<Zone> getZone(GetZoneOptions getZoneOptions) {
   }
 
   /**
-   * Update the specified network zone.
+   * Replace a network zone.
    *
-   * This operation updates the network zone with the specified ID.
+   * This operation replaces the network zone identified by the specified zone ID. Partial updates are not supported.
+   * The entire network zone object must be replaced.
    *
    * @param replaceZoneOptions the {@link ReplaceZoneOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link Zone}
@@ -236,6 +246,9 @@ public ServiceCall<Zone> replaceZone(ReplaceZoneOptions replaceZoneOptions) {
     }
     builder.header("Accept", "application/json");
     builder.header("If-Match", replaceZoneOptions.ifMatch());
+    if (replaceZoneOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", replaceZoneOptions.xCorrelationId());
+    }
     if (replaceZoneOptions.transactionId() != null) {
       builder.header("Transaction-Id", replaceZoneOptions.transactionId());
     }
@@ -262,9 +275,9 @@ public ServiceCall<Zone> replaceZone(ReplaceZoneOptions replaceZoneOptions) {
   }
 
   /**
-   * Delete the specified network zone.
+   * Delete a network zone.
    *
-   * This operation deletes the network zone with the specified home ID.
+   * This operation deletes the network zone identified by the specified zone ID.
    *
    * @param deleteZoneOptions the {@link DeleteZoneOptions} containing the options for the call
    * @return a {@link ServiceCall} with a void result
@@ -279,6 +292,9 @@ public ServiceCall<Void> deleteZone(DeleteZoneOptions deleteZoneOptions) {
     for (Entry<String, String> header : sdkHeaders.entrySet()) {
       builder.header(header.getKey(), header.getValue());
     }
+    if (deleteZoneOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", deleteZoneOptions.xCorrelationId());
+    }
     if (deleteZoneOptions.transactionId() != null) {
       builder.header("Transaction-Id", deleteZoneOptions.transactionId());
     }
@@ -304,6 +320,12 @@ public ServiceCall<ServiceRefTargetList> listAvailableServicerefTargets(ListAvai
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (listAvailableServicerefTargetsOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", listAvailableServicerefTargetsOptions.xCorrelationId());
+    }
+    if (listAvailableServicerefTargetsOptions.transactionId() != null) {
+      builder.header("Transaction-Id", listAvailableServicerefTargetsOptions.transactionId());
+    }
     if (listAvailableServicerefTargetsOptions.type() != null) {
       builder.query("type", String.valueOf(listAvailableServicerefTargetsOptions.type()));
     }
@@ -343,6 +365,9 @@ public ServiceCall<Rule> createRule(CreateRuleOptions createRuleOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (createRuleOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", createRuleOptions.xCorrelationId());
+    }
     if (createRuleOptions.transactionId() != null) {
       builder.header("Transaction-Id", createRuleOptions.transactionId());
     }
@@ -378,7 +403,7 @@ public ServiceCall<Rule> createRule() {
   /**
    * List rules.
    *
-   * This operation lists rules for the specified account.
+   * This operation lists rules in the specified account.
    *
    * @param listRulesOptions the {@link ListRulesOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link RuleList}
@@ -392,6 +417,9 @@ public ServiceCall<RuleList> listRules(ListRulesOptions listRulesOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (listRulesOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", listRulesOptions.xCorrelationId());
+    }
     if (listRulesOptions.transactionId() != null) {
       builder.header("Transaction-Id", listRulesOptions.transactionId());
     }
@@ -426,9 +454,9 @@ public ServiceCall<RuleList> listRules(ListRulesOptions listRulesOptions) {
   }
 
   /**
-   * Get the specified rule.
+   * Get a rule.
    *
-   * This operation gets the rule for the specified ID.
+   * This operation retrieves the rule identified by the specified rule ID.
    *
    * @param getRuleOptions the {@link GetRuleOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link Rule}
@@ -444,6 +472,9 @@ public ServiceCall<Rule> getRule(GetRuleOptions getRuleOptions) {
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (getRuleOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", getRuleOptions.xCorrelationId());
+    }
     if (getRuleOptions.transactionId() != null) {
       builder.header("Transaction-Id", getRuleOptions.transactionId());
     }
@@ -453,9 +484,10 @@ public ServiceCall<Rule> getRule(GetRuleOptions getRuleOptions) {
   }
 
   /**
-   * Update the specified rule.
+   * Replace a rule.
    *
-   * This operation updates the rule for the specified ID.
+   * This operation replaces the rule identified by the specified rule ID. Partial updates are not supported. The entire
+   * rule object must be replaced.
    *
    * @param replaceRuleOptions the {@link ReplaceRuleOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link Rule}
@@ -472,6 +504,9 @@ public ServiceCall<Rule> replaceRule(ReplaceRuleOptions replaceRuleOptions) {
     }
     builder.header("Accept", "application/json");
     builder.header("If-Match", replaceRuleOptions.ifMatch());
+    if (replaceRuleOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", replaceRuleOptions.xCorrelationId());
+    }
     if (replaceRuleOptions.transactionId() != null) {
       builder.header("Transaction-Id", replaceRuleOptions.transactionId());
     }
@@ -492,9 +527,9 @@ public ServiceCall<Rule> replaceRule(ReplaceRuleOptions replaceRuleOptions) {
   }
 
   /**
-   * Delete the specified rule.
+   * Delete a rule.
    *
-   * This operation deletes the rule for the specified home ID.
+   * This operation deletes the rule identified by the specified rule ID.
    *
    * @param deleteRuleOptions the {@link DeleteRuleOptions} containing the options for the call
    * @return a {@link ServiceCall} with a void result
@@ -509,6 +544,9 @@ public ServiceCall<Void> deleteRule(DeleteRuleOptions deleteRuleOptions) {
     for (Entry<String, String> header : sdkHeaders.entrySet()) {
       builder.header(header.getKey(), header.getValue());
     }
+    if (deleteRuleOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", deleteRuleOptions.xCorrelationId());
+    }
     if (deleteRuleOptions.transactionId() != null) {
       builder.header("Transaction-Id", deleteRuleOptions.transactionId());
     }
@@ -517,9 +555,9 @@ public ServiceCall<Void> deleteRule(DeleteRuleOptions deleteRuleOptions) {
   }
 
   /**
-   * Get the specified account settings.
+   * Get account settings.
    *
-   * This operation gets the settings for the specified account ID.
+   * This operation retrieves the settings for the specified account ID.
    *
    * @param getAccountSettingsOptions the {@link GetAccountSettingsOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link AccountSettings}
@@ -535,6 +573,9 @@ public ServiceCall<AccountSettings> getAccountSettings(GetAccountSettingsOptions
       builder.header(header.getKey(), header.getValue());
     }
     builder.header("Accept", "application/json");
+    if (getAccountSettingsOptions.xCorrelationId() != null) {
+      builder.header("X-Correlation-Id", getAccountSettingsOptions.xCorrelationId());
+    }
     if (getAccountSettingsOptions.transactionId() != null) {
       builder.header("Transaction-Id", getAccountSettingsOptions.transactionId());
     }

modules/context-based-restrictions/src/main/java/com/ibm/cloud/platform_services/context_based_restrictions/v1/model/CreateRuleOptions.java

@@ -25,6 +25,7 @@ public class CreateRuleOptions extends GenericModel {
   protected String description;
   protected List<RuleContext> contexts;
   protected List<Resource> resources;
+  protected String xCorrelationId;
   protected String transactionId;
 
   /**
@@ -34,12 +35,14 @@ public static class Builder {
     private String description;
     private List<RuleContext> contexts;
     private List<Resource> resources;
+    private String xCorrelationId;
     private String transactionId;
 
     private Builder(CreateRuleOptions createRuleOptions) {
       this.description = createRuleOptions.description;
       this.contexts = createRuleOptions.contexts;
       this.resources = createRuleOptions.resources;
+      this.xCorrelationId = createRuleOptions.xCorrelationId;
       this.transactionId = createRuleOptions.transactionId;
     }
 
@@ -125,6 +128,17 @@ public Builder resources(List<Resource> resources) {
       return this;
     }
 
+    /**
+     * Set the xCorrelationId.
+     *
+     * @param xCorrelationId the xCorrelationId
+     * @return the CreateRuleOptions builder
+     */
+    public Builder xCorrelationId(String xCorrelationId) {
+      this.xCorrelationId = xCorrelationId;
+      return this;
+    }
+
     /**
      * Set the transactionId.
      *
@@ -141,6 +155,7 @@ protected CreateRuleOptions(Builder builder) {
     description = builder.description;
     contexts = builder.contexts;
     resources = builder.resources;
+    xCorrelationId = builder.xCorrelationId;
     transactionId = builder.transactionId;
   }
 
@@ -186,13 +201,25 @@ public List<Resource> resources() {
     return resources;
   }
 
+  /**
+   * Gets the xCorrelationId.
+   *
+   * The supplied or generated value of this header is logged for a request and repeated in a response header for the
+   * corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
+   * this headers is not supplied in a request, the service generates a random (version 4) UUID.
+   *
+   * @return the xCorrelationId
+   */
+  public String xCorrelationId() {
+    return xCorrelationId;
+  }
+
   /**
    * Gets the transactionId.
    *
-   * The UUID that is used to correlate and track transactions. If you omit this field, the service generates and sends
-   * a transaction ID in the response.
-   * **Note:** To help with debugging, we strongly recommend that you generate and supply a `Transaction-Id` with each
-   * request.
+   * The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
+   * with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
+   * `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
    *
    * @return the transactionId
    */