fix(SDK): regeneration after content review

IBM · Jun 24, 2021 · 55d4dde · 55d4dde
1 parent 6b36602
commit 55d4dde
Show file tree

Hide file tree

Showing 23 changed files with 250 additions and 230 deletions.
diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/Findings.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/Findings.java
diff --git a/.../findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiListProvidersResponse.java b/.../findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiListProvidersResponse.java
@@ -18,7 +18,7 @@
 import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * Response including listed providers.
+ * A list of providers is returned.
  */
 public class ApiListProvidersResponse extends GenericModel {
 
@@ -42,7 +42,7 @@ public List<ApiProvider> getProviders() {
   /**
    * Gets the limit.
    *
-   * The number of elements returned in the current instance. Default is 200.
+   * The number of elements returned in the current instance. The default is 200.
    *
    * @return the limit
    */
@@ -53,7 +53,7 @@ public Long getLimit() {
   /**
    * Gets the skip.
    *
-   * The offset is the index of the item from which you want to start returning data from. Default is 0.
+   * The offset is the index of the item from which you want to start returning data from. The default is 0.
    *
    * @return the skip
    */

diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiNote.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiNote.java
@@ -20,13 +20,12 @@
 import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * Provides a detailed description of a `Note`.
+ * Provides a detailed description of a note.
  */
 public class ApiNote extends GenericModel {
 
   /**
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -319,7 +318,7 @@ public Builder newBuilder() {
   /**
    * Gets the shortDescription.
    *
-   * A one sentence description of this `Note`.
+   * A one sentence description of your note.
    *
    * @return the shortDescription
    */
@@ -330,7 +329,7 @@ public String shortDescription() {
   /**
    * Gets the longDescription.
    *
-   * A detailed description of this `Note`.
+   * A more detailed description of your note.
    *
    * @return the longDescription
    */
@@ -341,8 +340,7 @@ public String longDescription() {
   /**
    * Gets the kind.
    *
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -358,8 +356,6 @@ public String kind() {
   /**
    * Gets the relatedUrl.
    *
-   * URLs associated with this note.
-   *
    * @return the relatedUrl
    */
   public List<ApiNoteRelatedUrl> relatedUrl() {
@@ -402,7 +398,7 @@ public Date updateTime() {
   /**
    * Gets the id.
    *
-   * The id of the note.
+   * The ID of the note.
    *
    * @return the id
    */
@@ -413,7 +409,7 @@ public String id() {
   /**
    * Gets the shared.
    *
-   * True if this `Note` can be shared by multiple accounts.
+   * True if this note can be shared by multiple accounts.
    *
    * @return the shared
    */

diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiNoteRelatedUrl.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiNoteRelatedUrl.java
@@ -115,7 +115,7 @@ public String label() {
   /**
    * Gets the url.
    *
-   * Specific URL to associate with the note.
+   * The URL that you want to associate with the note.
    *
    * @return the url
    */

diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiOccurrence.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiOccurrence.java
@@ -24,8 +24,7 @@
 public class ApiOccurrence extends GenericModel {
 
   /**
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -270,8 +269,7 @@ public String noteName() {
   /**
    * Gets the kind.
    *
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.

diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiProvider.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/ApiProvider.java
@@ -15,7 +15,7 @@
 import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * Provides a detailed description of a `Provider`.
+ * Provides a detailed description of a provider.
  */
 public class ApiProvider extends GenericModel {
 
@@ -25,7 +25,7 @@ public class ApiProvider extends GenericModel {
   /**
    * Gets the name.
    *
-   * The name of the provider in the form "{account_id}/providers/{provider_id}".
+   * The name of the provider in the form '{account_id}/providers/{provider_id}'.
    *
    * @return the name
    */
@@ -36,7 +36,7 @@ public String getName() {
   /**
    * Gets the id.
    *
-   * The id of the provider.
+   * The ID of the provider.
    *
    * @return the id
    */

diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/CreateNoteOptions.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/CreateNoteOptions.java
@@ -24,8 +24,7 @@
 public class CreateNoteOptions extends GenericModel {
 
   /**
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -365,7 +364,7 @@ public Builder newBuilder() {
   /**
    * Gets the providerId.
    *
-   * Part of `parent`. This field contains the provider_id for example: providers/{provider_id}.
+   * Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
    *
    * @return the providerId
    */
@@ -376,7 +375,7 @@ public String providerId() {
   /**
    * Gets the shortDescription.
    *
-   * A one sentence description of this `Note`.
+   * A one sentence description of your note.
    *
    * @return the shortDescription
    */
@@ -387,7 +386,7 @@ public String shortDescription() {
   /**
    * Gets the longDescription.
    *
-   * A detailed description of this `Note`.
+   * A more detailed description of your note.
    *
    * @return the longDescription
    */
@@ -398,8 +397,7 @@ public String longDescription() {
   /**
    * Gets the kind.
    *
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -415,7 +413,7 @@ public String kind() {
   /**
    * Gets the id.
    *
-   * The id of the note.
+   * The ID of the note.
    *
    * @return the id
    */
@@ -437,8 +435,6 @@ public Reporter reportedBy() {
   /**
    * Gets the relatedUrl.
    *
-   * URLs associated with this note.
-   *
    * @return the relatedUrl
    */
   public List<ApiNoteRelatedUrl> relatedUrl() {
@@ -459,7 +455,7 @@ public Date expirationTime() {
   /**
    * Gets the shared.
    *
-   * True if this `Note` can be shared by multiple accounts.
+   * True if this note can be shared by multiple accounts.
    *
    * @return the shared
    */
@@ -514,7 +510,7 @@ public Section section() {
   /**
    * Gets the transactionId.
    *
-   * The transaction id for the request in uuid v4 format.
+   * The transaction ID for the request in UUID v4 format.
    *
    * @return the transactionId
    */

diff --git a/...s/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/CreateOccurrenceOptions.java b/...s/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/CreateOccurrenceOptions.java
@@ -22,8 +22,7 @@
 public class CreateOccurrenceOptions extends GenericModel {
 
   /**
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -53,8 +52,8 @@ public interface Kind {
   protected Finding finding;
   protected Kpi kpi;
   protected Map<String, Object> referenceData;
-  protected Boolean replaceIfExists;
   protected String transactionId;
+  protected Boolean replaceIfExists;
 
   /**
    * Builder.
@@ -70,8 +69,8 @@ public static class Builder {
     private Finding finding;
     private Kpi kpi;
     private Map<String, Object> referenceData;
-    private Boolean replaceIfExists;
     private String transactionId;
+    private Boolean replaceIfExists;
 
     private Builder(CreateOccurrenceOptions createOccurrenceOptions) {
       this.providerId = createOccurrenceOptions.providerId;
@@ -84,8 +83,8 @@ private Builder(CreateOccurrenceOptions createOccurrenceOptions) {
       this.finding = createOccurrenceOptions.finding;
       this.kpi = createOccurrenceOptions.kpi;
       this.referenceData = createOccurrenceOptions.referenceData;
-      this.replaceIfExists = createOccurrenceOptions.replaceIfExists;
       this.transactionId = createOccurrenceOptions.transactionId;
+      this.replaceIfExists = createOccurrenceOptions.replaceIfExists;
     }
 
     /**
@@ -229,24 +228,24 @@ public Builder referenceData(Map<String, Object> referenceData) {
     }
 
     /**
-     * Set the replaceIfExists.
+     * Set the transactionId.
      *
-     * @param replaceIfExists the replaceIfExists
+     * @param transactionId the transactionId
      * @return the CreateOccurrenceOptions builder
      */
-    public Builder replaceIfExists(Boolean replaceIfExists) {
-      this.replaceIfExists = replaceIfExists;
+    public Builder transactionId(String transactionId) {
+      this.transactionId = transactionId;
       return this;
     }
 
     /**
-     * Set the transactionId.
+     * Set the replaceIfExists.
      *
-     * @param transactionId the transactionId
+     * @param replaceIfExists the replaceIfExists
      * @return the CreateOccurrenceOptions builder
      */
-    public Builder transactionId(String transactionId) {
-      this.transactionId = transactionId;
+    public Builder replaceIfExists(Boolean replaceIfExists) {
+      this.replaceIfExists = replaceIfExists;
       return this;
     }
 
@@ -289,8 +288,8 @@ protected CreateOccurrenceOptions(Builder builder) {
     finding = builder.finding;
     kpi = builder.kpi;
     referenceData = builder.referenceData;
-    replaceIfExists = builder.replaceIfExists;
     transactionId = builder.transactionId;
+    replaceIfExists = builder.replaceIfExists;
   }
 
   /**
@@ -305,7 +304,7 @@ public Builder newBuilder() {
   /**
    * Gets the providerId.
    *
-   * Part of `parent`. This contains the provider_id for example: providers/{provider_id}.
+   * Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
    *
    * @return the providerId
    */
@@ -328,8 +327,7 @@ public String noteName() {
   /**
    * Gets the kind.
    *
-   * This must be 1&amp;#58;1 with members of our oneofs, it can be used for filtering Note and Occurrence on their
-   * kind.
+   * The type of note. Use this field to filter notes and occurences by kind.
    *  - FINDING&amp;#58; The note and occurrence represent a finding.
    *  - KPI&amp;#58; The note and occurrence represent a KPI value.
    *  - CARD&amp;#58; The note represents a card showing findings and related metric values.
@@ -419,25 +417,25 @@ public Map<String, Object> referenceData() {
   }
 
   /**
-   * Gets the replaceIfExists.
+   * Gets the transactionId.
    *
-   * It allows replacing an existing occurrence when set to true.
+   * The transaction ID for the request in UUID v4 format.
    *
-   * @return the replaceIfExists
+   * @return the transactionId
    */
-  public Boolean replaceIfExists() {
-    return replaceIfExists;
+  public String transactionId() {
+    return transactionId;
   }
 
   /**
-   * Gets the transactionId.
+   * Gets the replaceIfExists.
    *
-   * The transaction id for the request in uuid v4 format.
+   * When set to true, an existing occurrence is replaced rather than duplicated.
    *
-   * @return the transactionId
+   * @return the replaceIfExists
    */
-  public String transactionId() {
-    return transactionId;
+  public Boolean replaceIfExists() {
+    return replaceIfExists;
   }
 }
 
diff --git a/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/DeleteNoteOptions.java b/modules/findings/src/main/java/com/ibm/cloud/scc/findings/v1/model/DeleteNoteOptions.java
@@ -119,7 +119,7 @@ public Builder newBuilder() {
   /**
    * Gets the providerId.
    *
-   * First part of note `name`: providers/{provider_id}/notes/{note_id}.
+   * Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
    *
    * @return the providerId
    */
@@ -141,7 +141,7 @@ public String noteId() {
   /**
    * Gets the transactionId.
    *
-   * The transaction id for the request in uuid v4 format.
+   * The transaction ID for the request in UUID v4 format.
    *
    * @return the transactionId
    */