docs: [securitycentermanagement] update documentation for UpdateSecur…

…ityHealthAnalyticsCustomModule update_mask field (#10222) * docs: update documentation for UpdateSecurityHealthAnalyticsCustomModule update_mask field --- docs: Add description --- chore: update go_package and Go importpath PiperOrigin-RevId: 597960211 Source-Link: googleapis/googleapis@5a5e3d6 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d02cc580379bd23f398d77ec04ff6beb18341ed2 Copy-Tag: eyJwIjoiamF2YS1zZWN1cml0eWNlbnRlcm1hbmFnZW1lbnQvLk93bEJvdC55YW1sIiwiaCI6ImQwMmNjNTgwMzc5YmQyM2YzOThkNzdlYzA0ZmY2YmViMTgzNDFlZDIifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Jan 19, 2024 · c952200 · c952200
1 parent b5a90c4
commit c952200
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 86 deletions.
diff --git a/java-securitycentermanagement/README.md b/java-securitycentermanagement/README.md
@@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-securitycentermanagement/java11.html
 [stability-image]: https://img.shields.io/badge/stability-preview-yellow
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-securitycentermanagement.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.0.0
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.1.0
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/...ain/java/com/google/cloud/securitycentermanagement/v1/SecurityCenterManagementClient.java b/...ain/java/com/google/cloud/securitycentermanagement/v1/SecurityCenterManagementClient.java
@@ -1995,11 +1995,9 @@ public final SecurityHealthAnalyticsCustomModule createSecurityHealthAnalyticsCu
    * }</pre>
    *
    * @param securityHealthAnalyticsCustomModule Required. The resource being updated
-   * @param updateMask Required. Field mask is used to specify the fields to be overwritten in the
-   *     SecurityHealthAnalyticsCustomModule resource by the update. The fields specified in the
-   *     update_mask are relative to the resource, not the full request. A field will be overwritten
-   *     if it is in the mask. If the user does not provide a mask then all fields will be
-   *     overwritten.
+   * @param updateMask Required. The list of fields to be updated. The only fields that can be
+   *     updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value
+   *     `&#42;`, both `enablement_state` and `custom_config` are updated.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final SecurityHealthAnalyticsCustomModule updateSecurityHealthAnalyticsCustomModule(

diff --git a/...e/cloud/securitycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequest.java b/...e/cloud/securitycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequest.java
@@ -71,11 +71,10 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -91,11 +90,10 @@ public boolean hasUpdateMask() {
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -111,11 +109,10 @@ public com.google.protobuf.FieldMask getUpdateMask() {
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -686,11 +683,10 @@ public Builder mergeFrom(
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -705,11 +701,10 @@ public boolean hasUpdateMask() {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -730,11 +725,10 @@ public com.google.protobuf.FieldMask getUpdateMask() {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -757,11 +751,10 @@ public Builder setUpdateMask(com.google.protobuf.FieldMask value) {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -781,11 +774,10 @@ public Builder setUpdateMask(com.google.protobuf.FieldMask.Builder builderForVal
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -811,11 +803,10 @@ public Builder mergeUpdateMask(com.google.protobuf.FieldMask value) {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -835,11 +826,10 @@ public Builder clearUpdateMask() {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -854,11 +844,10 @@ public com.google.protobuf.FieldMask.Builder getUpdateMaskBuilder() {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -877,11 +866,10 @@ public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder() {
      *
      *
      * <pre>
-     * Required. Field mask is used to specify the fields to be overwritten in the
-     * SecurityHealthAnalyticsCustomModule resource by the update.
-     * The fields specified in the update_mask are relative to the resource, not
-     * the full request. A field will be overwritten if it is in the mask. If the
-     * user does not provide a mask then all fields will be overwritten.
+     * Required. The list of fields to be updated. The only fields that can be
+     * updated are `enablement_state` and `custom_config`. If empty or set to the
+     * wildcard value `*`, both `enablement_state` and `custom_config` are
+     * updated.
      * </pre>
      *
      * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];

diff --git a/...ecuritycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder.java b/...ecuritycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder.java
@@ -27,11 +27,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -44,11 +43,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -61,11 +59,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
    *
    *
    * <pre>
-   * Required. Field mask is used to specify the fields to be overwritten in the
-   * SecurityHealthAnalyticsCustomModule resource by the update.
-   * The fields specified in the update_mask are relative to the resource, not
-   * the full request. A field will be overwritten if it is in the mask. If the
-   * user does not provide a mask then all fields will be overwritten.
+   * Required. The list of fields to be updated. The only fields that can be
+   * updated are `enablement_state` and `custom_config`. If empty or set to the
+   * wildcard value `*`, both `enablement_state` and `custom_config` are
+   * updated.
    * </pre>
    *
    * <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];

diff --git a/.../src/main/proto/google/cloud/securitycentermanagement/v1/security_center_management.proto b/.../src/main/proto/google/cloud/securitycentermanagement/v1/security_center_management.proto
@@ -765,11 +765,10 @@ message CreateSecurityHealthAnalyticsCustomModuleRequest {
 
 // Message for updating a SecurityHealthAnalyticsCustomModule
 message UpdateSecurityHealthAnalyticsCustomModuleRequest {
-  // Required. Field mask is used to specify the fields to be overwritten in the
-  // SecurityHealthAnalyticsCustomModule resource by the update.
-  // The fields specified in the update_mask are relative to the resource, not
-  // the full request. A field will be overwritten if it is in the mask. If the
-  // user does not provide a mask then all fields will be overwritten.
+  // Required. The list of fields to be updated. The only fields that can be
+  // updated are `enablement_state` and `custom_config`. If empty or set to the
+  // wildcard value `*`, both `enablement_state` and `custom_config` are
+  // updated.
   google.protobuf.FieldMask update_mask = 1
       [(google.api.field_behavior) = REQUIRED];