Skip to content

Commit c952200

Browse files
docs: [securitycentermanagement] update documentation for UpdateSecurityHealthAnalyticsCustomModule 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>
1 parent b5a90c4 commit c952200

File tree

5 files changed

+68
-86
lines changed

5 files changed

+68
-86
lines changed

java-securitycentermanagement/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
201201
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-securitycentermanagement/java11.html
202202
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
203203
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-securitycentermanagement.svg
204-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.0.0
204+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-securitycentermanagement/0.1.0
205205
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
206206
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
207207
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

java-securitycentermanagement/google-cloud-securitycentermanagement/src/main/java/com/google/cloud/securitycentermanagement/v1/SecurityCenterManagementClient.java

+3-5
Original file line numberDiff line numberDiff line change
@@ -1995,11 +1995,9 @@ public final SecurityHealthAnalyticsCustomModule createSecurityHealthAnalyticsCu
19951995
* }</pre>
19961996
*
19971997
* @param securityHealthAnalyticsCustomModule Required. The resource being updated
1998-
* @param updateMask Required. Field mask is used to specify the fields to be overwritten in the
1999-
* SecurityHealthAnalyticsCustomModule resource by the update. The fields specified in the
2000-
* update_mask are relative to the resource, not the full request. A field will be overwritten
2001-
* if it is in the mask. If the user does not provide a mask then all fields will be
2002-
* overwritten.
1998+
* @param updateMask Required. The list of fields to be updated. The only fields that can be
1999+
* updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value
2000+
* `&#42;`, both `enablement_state` and `custom_config` are updated.
20032001
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
20042002
*/
20052003
public final SecurityHealthAnalyticsCustomModule updateSecurityHealthAnalyticsCustomModule(

java-securitycentermanagement/proto-google-cloud-securitycentermanagement-v1/src/main/java/com/google/cloud/securitycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequest.java

+48-60
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,10 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
7171
*
7272
*
7373
* <pre>
74-
* Required. Field mask is used to specify the fields to be overwritten in the
75-
* SecurityHealthAnalyticsCustomModule resource by the update.
76-
* The fields specified in the update_mask are relative to the resource, not
77-
* the full request. A field will be overwritten if it is in the mask. If the
78-
* user does not provide a mask then all fields will be overwritten.
74+
* Required. The list of fields to be updated. The only fields that can be
75+
* updated are `enablement_state` and `custom_config`. If empty or set to the
76+
* wildcard value `*`, both `enablement_state` and `custom_config` are
77+
* updated.
7978
* </pre>
8079
*
8180
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -91,11 +90,10 @@ public boolean hasUpdateMask() {
9190
*
9291
*
9392
* <pre>
94-
* Required. Field mask is used to specify the fields to be overwritten in the
95-
* SecurityHealthAnalyticsCustomModule resource by the update.
96-
* The fields specified in the update_mask are relative to the resource, not
97-
* the full request. A field will be overwritten if it is in the mask. If the
98-
* user does not provide a mask then all fields will be overwritten.
93+
* Required. The list of fields to be updated. The only fields that can be
94+
* updated are `enablement_state` and `custom_config`. If empty or set to the
95+
* wildcard value `*`, both `enablement_state` and `custom_config` are
96+
* updated.
9997
* </pre>
10098
*
10199
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -111,11 +109,10 @@ public com.google.protobuf.FieldMask getUpdateMask() {
111109
*
112110
*
113111
* <pre>
114-
* Required. Field mask is used to specify the fields to be overwritten in the
115-
* SecurityHealthAnalyticsCustomModule resource by the update.
116-
* The fields specified in the update_mask are relative to the resource, not
117-
* the full request. A field will be overwritten if it is in the mask. If the
118-
* user does not provide a mask then all fields will be overwritten.
112+
* Required. The list of fields to be updated. The only fields that can be
113+
* updated are `enablement_state` and `custom_config`. If empty or set to the
114+
* wildcard value `*`, both `enablement_state` and `custom_config` are
115+
* updated.
119116
* </pre>
120117
*
121118
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -686,11 +683,10 @@ public Builder mergeFrom(
686683
*
687684
*
688685
* <pre>
689-
* Required. Field mask is used to specify the fields to be overwritten in the
690-
* SecurityHealthAnalyticsCustomModule resource by the update.
691-
* The fields specified in the update_mask are relative to the resource, not
692-
* the full request. A field will be overwritten if it is in the mask. If the
693-
* user does not provide a mask then all fields will be overwritten.
686+
* Required. The list of fields to be updated. The only fields that can be
687+
* updated are `enablement_state` and `custom_config`. If empty or set to the
688+
* wildcard value `*`, both `enablement_state` and `custom_config` are
689+
* updated.
694690
* </pre>
695691
*
696692
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -705,11 +701,10 @@ public boolean hasUpdateMask() {
705701
*
706702
*
707703
* <pre>
708-
* Required. Field mask is used to specify the fields to be overwritten in the
709-
* SecurityHealthAnalyticsCustomModule resource by the update.
710-
* The fields specified in the update_mask are relative to the resource, not
711-
* the full request. A field will be overwritten if it is in the mask. If the
712-
* user does not provide a mask then all fields will be overwritten.
704+
* Required. The list of fields to be updated. The only fields that can be
705+
* updated are `enablement_state` and `custom_config`. If empty or set to the
706+
* wildcard value `*`, both `enablement_state` and `custom_config` are
707+
* updated.
713708
* </pre>
714709
*
715710
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -730,11 +725,10 @@ public com.google.protobuf.FieldMask getUpdateMask() {
730725
*
731726
*
732727
* <pre>
733-
* Required. Field mask is used to specify the fields to be overwritten in the
734-
* SecurityHealthAnalyticsCustomModule resource by the update.
735-
* The fields specified in the update_mask are relative to the resource, not
736-
* the full request. A field will be overwritten if it is in the mask. If the
737-
* user does not provide a mask then all fields will be overwritten.
728+
* Required. The list of fields to be updated. The only fields that can be
729+
* updated are `enablement_state` and `custom_config`. If empty or set to the
730+
* wildcard value `*`, both `enablement_state` and `custom_config` are
731+
* updated.
738732
* </pre>
739733
*
740734
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -757,11 +751,10 @@ public Builder setUpdateMask(com.google.protobuf.FieldMask value) {
757751
*
758752
*
759753
* <pre>
760-
* Required. Field mask is used to specify the fields to be overwritten in the
761-
* SecurityHealthAnalyticsCustomModule resource by the update.
762-
* The fields specified in the update_mask are relative to the resource, not
763-
* the full request. A field will be overwritten if it is in the mask. If the
764-
* user does not provide a mask then all fields will be overwritten.
754+
* Required. The list of fields to be updated. The only fields that can be
755+
* updated are `enablement_state` and `custom_config`. If empty or set to the
756+
* wildcard value `*`, both `enablement_state` and `custom_config` are
757+
* updated.
765758
* </pre>
766759
*
767760
* <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
781774
*
782775
*
783776
* <pre>
784-
* Required. Field mask is used to specify the fields to be overwritten in the
785-
* SecurityHealthAnalyticsCustomModule resource by the update.
786-
* The fields specified in the update_mask are relative to the resource, not
787-
* the full request. A field will be overwritten if it is in the mask. If the
788-
* user does not provide a mask then all fields will be overwritten.
777+
* Required. The list of fields to be updated. The only fields that can be
778+
* updated are `enablement_state` and `custom_config`. If empty or set to the
779+
* wildcard value `*`, both `enablement_state` and `custom_config` are
780+
* updated.
789781
* </pre>
790782
*
791783
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -811,11 +803,10 @@ public Builder mergeUpdateMask(com.google.protobuf.FieldMask value) {
811803
*
812804
*
813805
* <pre>
814-
* Required. Field mask is used to specify the fields to be overwritten in the
815-
* SecurityHealthAnalyticsCustomModule resource by the update.
816-
* The fields specified in the update_mask are relative to the resource, not
817-
* the full request. A field will be overwritten if it is in the mask. If the
818-
* user does not provide a mask then all fields will be overwritten.
806+
* Required. The list of fields to be updated. The only fields that can be
807+
* updated are `enablement_state` and `custom_config`. If empty or set to the
808+
* wildcard value `*`, both `enablement_state` and `custom_config` are
809+
* updated.
819810
* </pre>
820811
*
821812
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -835,11 +826,10 @@ public Builder clearUpdateMask() {
835826
*
836827
*
837828
* <pre>
838-
* Required. Field mask is used to specify the fields to be overwritten in the
839-
* SecurityHealthAnalyticsCustomModule resource by the update.
840-
* The fields specified in the update_mask are relative to the resource, not
841-
* the full request. A field will be overwritten if it is in the mask. If the
842-
* user does not provide a mask then all fields will be overwritten.
829+
* Required. The list of fields to be updated. The only fields that can be
830+
* updated are `enablement_state` and `custom_config`. If empty or set to the
831+
* wildcard value `*`, both `enablement_state` and `custom_config` are
832+
* updated.
843833
* </pre>
844834
*
845835
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -854,11 +844,10 @@ public com.google.protobuf.FieldMask.Builder getUpdateMaskBuilder() {
854844
*
855845
*
856846
* <pre>
857-
* Required. Field mask is used to specify the fields to be overwritten in the
858-
* SecurityHealthAnalyticsCustomModule resource by the update.
859-
* The fields specified in the update_mask are relative to the resource, not
860-
* the full request. A field will be overwritten if it is in the mask. If the
861-
* user does not provide a mask then all fields will be overwritten.
847+
* Required. The list of fields to be updated. The only fields that can be
848+
* updated are `enablement_state` and `custom_config`. If empty or set to the
849+
* wildcard value `*`, both `enablement_state` and `custom_config` are
850+
* updated.
862851
* </pre>
863852
*
864853
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -877,11 +866,10 @@ public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder() {
877866
*
878867
*
879868
* <pre>
880-
* Required. Field mask is used to specify the fields to be overwritten in the
881-
* SecurityHealthAnalyticsCustomModule resource by the update.
882-
* The fields specified in the update_mask are relative to the resource, not
883-
* the full request. A field will be overwritten if it is in the mask. If the
884-
* user does not provide a mask then all fields will be overwritten.
869+
* Required. The list of fields to be updated. The only fields that can be
870+
* updated are `enablement_state` and `custom_config`. If empty or set to the
871+
* wildcard value `*`, both `enablement_state` and `custom_config` are
872+
* updated.
885873
* </pre>
886874
*
887875
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];

java-securitycentermanagement/proto-google-cloud-securitycentermanagement-v1/src/main/java/com/google/cloud/securitycentermanagement/v1/UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder.java

+12-15
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* Required. Field mask is used to specify the fields to be overwritten in the
31-
* SecurityHealthAnalyticsCustomModule resource by the update.
32-
* The fields specified in the update_mask are relative to the resource, not
33-
* the full request. A field will be overwritten if it is in the mask. If the
34-
* user does not provide a mask then all fields will be overwritten.
30+
* Required. The list of fields to be updated. The only fields that can be
31+
* updated are `enablement_state` and `custom_config`. If empty or set to the
32+
* wildcard value `*`, both `enablement_state` and `custom_config` are
33+
* updated.
3534
* </pre>
3635
*
3736
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -44,11 +43,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
4443
*
4544
*
4645
* <pre>
47-
* Required. Field mask is used to specify the fields to be overwritten in the
48-
* SecurityHealthAnalyticsCustomModule resource by the update.
49-
* The fields specified in the update_mask are relative to the resource, not
50-
* the full request. A field will be overwritten if it is in the mask. If the
51-
* user does not provide a mask then all fields will be overwritten.
46+
* Required. The list of fields to be updated. The only fields that can be
47+
* updated are `enablement_state` and `custom_config`. If empty or set to the
48+
* wildcard value `*`, both `enablement_state` and `custom_config` are
49+
* updated.
5250
* </pre>
5351
*
5452
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];
@@ -61,11 +59,10 @@ public interface UpdateSecurityHealthAnalyticsCustomModuleRequestOrBuilder
6159
*
6260
*
6361
* <pre>
64-
* Required. Field mask is used to specify the fields to be overwritten in the
65-
* SecurityHealthAnalyticsCustomModule resource by the update.
66-
* The fields specified in the update_mask are relative to the resource, not
67-
* the full request. A field will be overwritten if it is in the mask. If the
68-
* user does not provide a mask then all fields will be overwritten.
62+
* Required. The list of fields to be updated. The only fields that can be
63+
* updated are `enablement_state` and `custom_config`. If empty or set to the
64+
* wildcard value `*`, both `enablement_state` and `custom_config` are
65+
* updated.
6966
* </pre>
7067
*
7168
* <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];

java-securitycentermanagement/proto-google-cloud-securitycentermanagement-v1/src/main/proto/google/cloud/securitycentermanagement/v1/security_center_management.proto

+4-5
Original file line numberDiff line numberDiff line change
@@ -765,11 +765,10 @@ message CreateSecurityHealthAnalyticsCustomModuleRequest {
765765

766766
// Message for updating a SecurityHealthAnalyticsCustomModule
767767
message UpdateSecurityHealthAnalyticsCustomModuleRequest {
768-
// Required. Field mask is used to specify the fields to be overwritten in the
769-
// SecurityHealthAnalyticsCustomModule resource by the update.
770-
// The fields specified in the update_mask are relative to the resource, not
771-
// the full request. A field will be overwritten if it is in the mask. If the
772-
// user does not provide a mask then all fields will be overwritten.
768+
// Required. The list of fields to be updated. The only fields that can be
769+
// updated are `enablement_state` and `custom_config`. If empty or set to the
770+
// wildcard value `*`, both `enablement_state` and `custom_config` are
771+
// updated.
773772
google.protobuf.FieldMask update_mask = 1
774773
[(google.api.field_behavior) = REQUIRED];
775774

0 commit comments

Comments
 (0)