google-cloud-security_center_management-v1 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -245,10 +245,11 @@ module Google
245
245
  # Service calls
246
246
 
247
247
  ##
248
- # Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the
249
- # given parent. This includes resident modules defined at the scope of the
250
- # parent, and inherited modules, inherited from CRM ancestors (no
251
- # descendants).
248
+ # Returns a list of all
249
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}
250
+ # resources for the given parent. This includes resident modules defined at
251
+ # the scope of the parent, and inherited modules, inherited from ancestor
252
+ # organizations, folders, and projects (no descendants).
252
253
  #
253
254
  # @overload list_effective_security_health_analytics_custom_modules(request, options = nil)
254
255
  # Pass arguments to `list_effective_security_health_analytics_custom_modules` via a request object, either of type
@@ -266,17 +267,21 @@ module Google
266
267
  # the default parameter values, pass an empty Hash as a request object (see above).
267
268
  #
268
269
  # @param parent [::String]
269
- # Required. Name of parent to list effective custom modules. specified in one
270
- # of the following formats:
270
+ # Required. Name of parent to list effective custom modules, in one of the
271
+ # following formats:
272
+ #
271
273
  # * `organizations/{organization}/locations/{location}`
272
274
  # * `folders/{folder}/locations/{location}`
273
- # or
274
- # `projects/{project}/locations/{location}`
275
+ # * `projects/{project}/locations/{location}`
275
276
  # @param page_size [::Integer]
276
277
  # Optional. The maximum number of results to return in a single response.
277
278
  # Default is 10, minimum is 1, maximum is 1000.
278
279
  # @param page_token [::String]
279
- # Optional. The value returned by the last call indicating a continuation.
280
+ # Optional. A pagination token returned from a previous request. Provide this
281
+ # token to retrieve the next page of results.
282
+ #
283
+ # When paginating, the rest of the request must match the request that
284
+ # generated the page token.
280
285
  # @yield [result, operation] Access the result along with the TransportOperation object
281
286
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule>]
282
287
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -342,7 +347,8 @@ module Google
342
347
  end
343
348
 
344
349
  ##
345
- # Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.
350
+ # Gets details of a single
351
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}.
346
352
  #
347
353
  # @overload get_effective_security_health_analytics_custom_module(request, options = nil)
348
354
  # Pass arguments to `get_effective_security_health_analytics_custom_module` via a request object, either of type
@@ -363,9 +369,9 @@ module Google
363
369
  # Required. The full resource name of the custom module, specified in one of
364
370
  # the following formats:
365
371
  #
366
- # * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
367
- # * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
368
- # * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
372
+ # * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
373
+ # * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
374
+ # * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
369
375
  # @yield [result, operation] Access the result along with the TransportOperation object
370
376
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule]
371
377
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -426,9 +432,11 @@ module Google
426
432
  end
427
433
 
428
434
  ##
429
- # Returns a list of all SecurityHealthAnalyticsCustomModules for the given
430
- # parent. This includes resident modules defined at the scope of the parent,
431
- # and inherited modules, inherited from CRM ancestors (no descendants).
435
+ # Returns a list of all
436
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
437
+ # resources for the given parent. This includes resident modules defined at
438
+ # the scope of the parent, and inherited modules, inherited from ancestor
439
+ # organizations, folders, and projects (no descendants).
432
440
  #
433
441
  # @overload list_security_health_analytics_custom_modules(request, options = nil)
434
442
  # Pass arguments to `list_security_health_analytics_custom_modules` via a request object, either of type
@@ -446,8 +454,8 @@ module Google
446
454
  # the default parameter values, pass an empty Hash as a request object (see above).
447
455
  #
448
456
  # @param parent [::String]
449
- # Required. Name of parent organization, folder, or project in which to list
450
- # custom modules, specified in one of the following formats:
457
+ # Required. Name of the parent organization, folder, or project in which to
458
+ # list custom modules, in one of the following formats:
451
459
  #
452
460
  # * `organizations/{organization}/locations/{location}`
453
461
  # * `folders/{folder}/locations/{location}`
@@ -456,7 +464,11 @@ module Google
456
464
  # Optional. The maximum number of results to return in a single response.
457
465
  # Default is 10, minimum is 1, maximum is 1000.
458
466
  # @param page_token [::String]
459
- # Optional. A token identifying a page of results the server should return.
467
+ # Optional. A pagination token returned from a previous request. Provide this
468
+ # token to retrieve the next page of results.
469
+ #
470
+ # When paginating, the rest of the request must match the request that
471
+ # generated the page token.
460
472
  # @yield [result, operation] Access the result along with the TransportOperation object
461
473
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
462
474
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -522,8 +534,10 @@ module Google
522
534
  end
523
535
 
524
536
  ##
525
- # Returns a list of all resident SecurityHealthAnalyticsCustomModules under
526
- # the given CRM parent and all of the parent's CRM descendants.
537
+ # Returns a list of all resident
538
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
539
+ # resources under the given organization, folder, or project and all of its
540
+ # descendants.
527
541
  #
528
542
  # @overload list_descendant_security_health_analytics_custom_modules(request, options = nil)
529
543
  # Pass arguments to `list_descendant_security_health_analytics_custom_modules` via a request object, either of type
@@ -542,7 +556,7 @@ module Google
542
556
  #
543
557
  # @param parent [::String]
544
558
  # Required. Name of the parent organization, folder, or project in which to
545
- # list custom modules, specified in one of the following formats:
559
+ # list custom modules, in one of the following formats:
546
560
  #
547
561
  # * `organizations/{organization}/locations/{location}`
548
562
  # * `folders/{folder}/locations/{location}`
@@ -551,7 +565,11 @@ module Google
551
565
  # Optional. The maximum number of results to return in a single response.
552
566
  # Default is 10, minimum is 1, maximum is 1000.
553
567
  # @param page_token [::String]
554
- # Optional. A token identifying a page of results the server should return.
568
+ # Optional. A pagination token returned from a previous request. Provide this
569
+ # token to retrieve the next page of results.
570
+ #
571
+ # When paginating, the rest of the request must match the request that
572
+ # generated the page token.
555
573
  # @yield [result, operation] Access the result along with the TransportOperation object
556
574
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
557
575
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -617,7 +635,8 @@ module Google
617
635
  end
618
636
 
619
637
  ##
620
- # Retrieves a SecurityHealthAnalyticsCustomModule.
638
+ # Retrieves a
639
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}.
621
640
  #
622
641
  # @overload get_security_health_analytics_custom_module(request, options = nil)
623
642
  # Pass arguments to `get_security_health_analytics_custom_module` via a request object, either of type
@@ -635,7 +654,8 @@ module Google
635
654
  # the default parameter values, pass an empty Hash as a request object (see above).
636
655
  #
637
656
  # @param name [::String]
638
- # Required. Name of the resource
657
+ # Required. Name of the resource, in the format
658
+ # `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`.
639
659
  # @yield [result, operation] Access the result along with the TransportOperation object
640
660
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
641
661
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -696,10 +716,12 @@ module Google
696
716
  end
697
717
 
698
718
  ##
699
- # Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the
700
- # given CRM parent, and also creates inherited
701
- # SecurityHealthAnalyticsCustomModules for all CRM descendants of the given
702
- # parent. These modules are enabled by default.
719
+ # Creates a resident
720
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
721
+ # at the scope of the given organization, folder, or project, and also
722
+ # creates inherited `SecurityHealthAnalyticsCustomModule` resources for all
723
+ # folders and projects that are descendants of the given parent. These
724
+ # modules are enabled by default.
703
725
  #
704
726
  # @overload create_security_health_analytics_custom_module(request, options = nil)
705
727
  # Pass arguments to `create_security_health_analytics_custom_module` via a request object, either of type
@@ -718,22 +740,27 @@ module Google
718
740
  #
719
741
  # @param parent [::String]
720
742
  # Required. Name of the parent organization, folder, or project of the
721
- # module, specified in one of the following formats:
743
+ # module, in one of the following formats:
722
744
  #
723
745
  # * `organizations/{organization}/locations/{location}`
724
746
  # * `folders/{folder}/locations/{location}`
725
747
  # * `projects/{project}/locations/{location}`
726
748
  # @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
727
- # Required. The resource being created
749
+ # Required. The resource being created.
728
750
  # @param validate_only [::Boolean]
729
- # Optional. When set to true, only validations (including IAM checks) will
730
- # done for the request (no module will be created). An OK response indicates
731
- # the request is valid while an error response indicates the request is
732
- # invalid. Note that a subsequent request to actually create the module could
733
- # still fail because:
734
- # 1. the state could have changed (e.g. IAM permission lost) or
735
- # 2. A failure occurred during creation of the module.
736
- # Defaults to false.
751
+ # Optional. When set to `true`, the request will be validated (including IAM
752
+ # checks), but no module will be created. An `OK` response indicates that the
753
+ # request is valid, while an error response indicates that the request is
754
+ # invalid.
755
+ #
756
+ # If the request is valid, a subsequent request to create the module could
757
+ # still fail for one of the following reasons:
758
+ #
759
+ # * The state of your cloud resources changed; for example, you lost a
760
+ # required IAM permission
761
+ # * An error occurred during creation of the module
762
+ #
763
+ # Defaults to `false`.
737
764
  # @yield [result, operation] Access the result along with the TransportOperation object
738
765
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
739
766
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -794,11 +821,13 @@ module Google
794
821
  end
795
822
 
796
823
  ##
797
- # Updates the SecurityHealthAnalyticsCustomModule under the given name based
798
- # on the given update mask. Updating the enablement state is supported on
799
- # both resident and inherited modules (though resident modules cannot have an
800
- # enablement state of "inherited"). Updating the display name and custom
801
- # config of a module is supported on resident modules only.
824
+ # Updates the
825
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
826
+ # under the given name based on the given update mask. Updating the
827
+ # enablement state is supported on both resident and inherited modules
828
+ # (though resident modules cannot have an enablement state of "inherited").
829
+ # Updating the display name and custom configuration of a module is supported
830
+ # on resident modules only.
802
831
  #
803
832
  # @overload update_security_health_analytics_custom_module(request, options = nil)
804
833
  # Pass arguments to `update_security_health_analytics_custom_module` via a request object, either of type
@@ -816,20 +845,29 @@ module Google
816
845
  # the default parameter values, pass an empty Hash as a request object (see above).
817
846
  #
818
847
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
819
- # Required. The list of fields to be updated. The only fields that can be
820
- # updated are `enablement_state` and `custom_config`. If empty or set to the
821
- # wildcard value `*`, both `enablement_state` and `custom_config` are
822
- # updated.
848
+ # Required. The fields to update. The following values are valid:
849
+ #
850
+ # * `custom_config`
851
+ # * `enablement_state`
852
+ #
853
+ # If you omit this field or set it to the wildcard value `*`, then all
854
+ # eligible fields are updated.
823
855
  # @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
824
- # Required. The resource being updated
856
+ # Required. The resource being updated.
825
857
  # @param validate_only [::Boolean]
826
- # Optional. When set to true, only validations (including IAM checks) will
827
- # done for the request (module will not be updated). An OK response indicates
828
- # the request is valid while an error response indicates the request is
829
- # invalid. Note that a subsequent request to actually update the module could
830
- # still fail because 1. the state could have changed (e.g. IAM permission
831
- # lost) or
832
- # 2. A failure occurred while trying to update the module.
858
+ # Optional. When set to `true`, the request will be validated (including IAM
859
+ # checks), but no module will be updated. An `OK` response indicates that the
860
+ # request is valid, while an error response indicates that the request is
861
+ # invalid.
862
+ #
863
+ # If the request is valid, a subsequent request to update the module could
864
+ # still fail for one of the following reasons:
865
+ #
866
+ # * The state of your cloud resources changed; for example, you lost a
867
+ # required IAM permission
868
+ # * An error occurred during creation of the module
869
+ #
870
+ # Defaults to `false`.
833
871
  # @yield [result, operation] Access the result along with the TransportOperation object
834
872
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
835
873
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -890,9 +928,10 @@ module Google
890
928
  end
891
929
 
892
930
  ##
893
- # Deletes the specified SecurityHealthAnalyticsCustomModule and all of its
894
- # descendants in the CRM hierarchy. This method is only supported for
895
- # resident custom modules.
931
+ # Deletes the specified
932
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
933
+ # and all of its descendants in the resource hierarchy. This method is only
934
+ # supported for resident custom modules.
896
935
  #
897
936
  # @overload delete_security_health_analytics_custom_module(request, options = nil)
898
937
  # Pass arguments to `delete_security_health_analytics_custom_module` via a request object, either of type
@@ -910,21 +949,26 @@ module Google
910
949
  # the default parameter values, pass an empty Hash as a request object (see above).
911
950
  #
912
951
  # @param name [::String]
913
- # Required. The resource name of the SHA custom module.
914
- #
915
- # Its format is:
952
+ # Required. The resource name of the SHA custom module, in one of the
953
+ # following formats:
916
954
  #
917
- # * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
918
- # * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
919
- # * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
955
+ # * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
956
+ # * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
957
+ # * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
920
958
  # @param validate_only [::Boolean]
921
- # Optional. When set to true, only validations (including IAM checks) will
922
- # done for the request (module will not be deleted). An OK response indicates
923
- # the request is valid while an error response indicates the request is
924
- # invalid. Note that a subsequent request to actually delete the module could
925
- # still fail because 1. the state could have changed (e.g. IAM permission
926
- # lost) or
927
- # 2. A failure occurred while trying to delete the module.
959
+ # Optional. When set to `true`, the request will be validated (including IAM
960
+ # checks), but no module will be deleted. An `OK` response indicates that the
961
+ # request is valid, while an error response indicates that the request is
962
+ # invalid.
963
+ #
964
+ # If the request is valid, a subsequent request to delete the module could
965
+ # still fail for one of the following reasons:
966
+ #
967
+ # * The state of your cloud resources changed; for example, you lost a
968
+ # required IAM permission
969
+ # * An error occurred during deletion of the module
970
+ #
971
+ # Defaults to `false`.
928
972
  # @yield [result, operation] Access the result along with the TransportOperation object
929
973
  # @yieldparam result [::Google::Protobuf::Empty]
930
974
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -985,7 +1029,9 @@ module Google
985
1029
  end
986
1030
 
987
1031
  ##
988
- # Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
1032
+ # Simulates the result of using a
1033
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
1034
+ # to check a resource.
989
1035
  #
990
1036
  # @overload simulate_security_health_analytics_custom_module(request, options = nil)
991
1037
  # Pass arguments to `simulate_security_health_analytics_custom_module` via a request object, either of type
@@ -1004,10 +1050,9 @@ module Google
1004
1050
  #
1005
1051
  # @param parent [::String]
1006
1052
  # Required. The relative resource name of the organization, project, or
1007
- # folder. For more information about relative resource names, see [Relative
1008
- # Resource
1009
- # Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
1010
- # Example: `organizations/{organization_id}`.
1053
+ # folder. For more information about relative resource names, see [AIP-122:
1054
+ # Resource names](https://google.aip.dev/122). Example:
1055
+ # `organizations/{organization_id}`.
1011
1056
  # @param custom_config [::Google::Cloud::SecurityCenterManagement::V1::CustomConfig, ::Hash]
1012
1057
  # Required. The custom configuration that you need to test.
1013
1058
  # @param resource [::Google::Cloud::SecurityCenterManagement::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource, ::Hash]
@@ -1092,16 +1137,21 @@ module Google
1092
1137
  # the default parameter values, pass an empty Hash as a request object (see above).
1093
1138
  #
1094
1139
  # @param parent [::String]
1095
- # Required. Name of parent to list effective custom modules. Its format is
1096
- # `organizations/{organization}/locations/{location}`,
1097
- # `folders/{folder}/locations/{location}`,
1098
- # or
1099
- # `projects/{project}/locations/{location}`
1140
+ # Required. Name of parent to list effective custom modules, in one of the
1141
+ # following formats:
1142
+ #
1143
+ # * `organizations/{organization}/locations/{location}`
1144
+ # * `folders/{folder}/locations/{location}`
1145
+ # * `projects/{project}/locations/{location}`
1100
1146
  # @param page_size [::Integer]
1101
1147
  # Optional. The maximum number of results to return in a single response.
1102
1148
  # Default is 10, minimum is 1, maximum is 1000.
1103
1149
  # @param page_token [::String]
1104
- # Optional. The value returned by the last call indicating a continuation
1150
+ # Optional. A pagination token returned from a previous request. Provide this
1151
+ # token to retrieve the next page of results.
1152
+ #
1153
+ # When paginating, the rest of the request must match the request that
1154
+ # generated the page token.
1105
1155
  # @yield [result, operation] Access the result along with the TransportOperation object
1106
1156
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule>]
1107
1157
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1167,13 +1217,18 @@ module Google
1167
1217
  end
1168
1218
 
1169
1219
  ##
1170
- # Gets an effective ETD custom module. Retrieves the effective module at the
1171
- # given level. The difference between an EffectiveCustomModule and a
1172
- # CustomModule is that the fields for an EffectiveCustomModule are computed
1173
- # from ancestors if needed. For example, the enablement_state for a
1174
- # CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the
1175
- # enablement_state for an EffectiveCustomModule is always computed to ENABLED
1176
- # or DISABLED (the effective enablement_state).
1220
+ # Gets the effective Event Threat Detection custom module at the given level.
1221
+ #
1222
+ # The difference between an
1223
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule EffectiveEventThreatDetectionCustomModule}
1224
+ # and an
1225
+ # {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule EventThreatDetectionCustomModule}
1226
+ # is that the fields for an `EffectiveEventThreatDetectionCustomModule` are
1227
+ # computed from ancestors if needed. For example, the enablement state for an
1228
+ # `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or
1229
+ # `INHERITED`. In contrast, the enablement state for an
1230
+ # `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED`
1231
+ # or `DISABLED`.
1177
1232
  #
1178
1233
  # @overload get_effective_event_threat_detection_custom_module(request, options = nil)
1179
1234
  # Pass arguments to `get_effective_event_threat_detection_custom_module` via a request object, either of type
@@ -1191,13 +1246,12 @@ module Google
1191
1246
  # the default parameter values, pass an empty Hash as a request object (see above).
1192
1247
  #
1193
1248
  # @param name [::String]
1194
- # Required. The resource name of the ETD custom module.
1195
- #
1196
- # Its format is:
1249
+ # Required. The resource name of the Event Threat Detection custom module, in
1250
+ # one of the following formats:
1197
1251
  #
1198
- # * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1199
- # * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1200
- # * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1252
+ # * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1253
+ # * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1254
+ # * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1201
1255
  # @yield [result, operation] Access the result along with the TransportOperation object
1202
1256
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule]
1203
1257
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1258,9 +1312,9 @@ module Google
1258
1312
  end
1259
1313
 
1260
1314
  ##
1261
- # Lists all Event Threat Detection custom modules for the given
1262
- # Resource Manager parent. This includes resident modules defined at the
1263
- # scope of the parent along with modules inherited from ancestors.
1315
+ # Lists all Event Threat Detection custom modules for the given organization,
1316
+ # folder, or project. This includes resident modules defined at the scope of
1317
+ # the parent along with modules inherited from ancestors.
1264
1318
  #
1265
1319
  # @overload list_event_threat_detection_custom_modules(request, options = nil)
1266
1320
  # Pass arguments to `list_event_threat_detection_custom_modules` via a request object, either of type
@@ -1278,23 +1332,22 @@ module Google
1278
1332
  # the default parameter values, pass an empty Hash as a request object (see above).
1279
1333
  #
1280
1334
  # @param parent [::String]
1281
- # Required. Name of parent to list custom modules. Its format is
1282
- # `organizations/{organization}/locations/{location}`,
1283
- # `folders/{folder}/locations/{location}`,
1284
- # or
1285
- # `projects/{project}/locations/{location}`
1335
+ # Required. Name of parent to list custom modules, in one of the following
1336
+ # formats:
1337
+ #
1338
+ # * `organizations/{organization}/locations/{location}`
1339
+ # * `folders/{folder}/locations/{location}`
1340
+ # * `projects/{project}/locations/{location}`
1286
1341
  # @param page_size [::Integer]
1287
1342
  # Optional. The maximum number of modules to return. The service may return
1288
- # fewer than this value. If unspecified, at most 10 configs will be returned.
1343
+ # fewer than this value. If unspecified, at most 10 modules will be returned.
1289
1344
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
1290
1345
  # @param page_token [::String]
1291
- # Optional. A page token, received from a previous
1292
- # `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the
1293
- # subsequent page.
1346
+ # Optional. A pagination token returned from a previous request. Provide this
1347
+ # token to retrieve the next page of results.
1294
1348
  #
1295
- # When paginating, all other parameters provided to
1296
- # `ListEventThreatDetectionCustomModules` must match the call that provided
1297
- # the page token.
1349
+ # When paginating, the rest of the request must match the request that
1350
+ # generated the page token.
1298
1351
  # @yield [result, operation] Access the result along with the TransportOperation object
1299
1352
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
1300
1353
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1360,8 +1413,8 @@ module Google
1360
1413
  end
1361
1414
 
1362
1415
  ##
1363
- # Lists all resident Event Threat Detection custom modules under the
1364
- # given Resource Manager parent and its descendants.
1416
+ # Lists all resident Event Threat Detection custom modules for the given
1417
+ # organization, folder, or project and its descendants.
1365
1418
  #
1366
1419
  # @overload list_descendant_event_threat_detection_custom_modules(request, options = nil)
1367
1420
  # Pass arguments to `list_descendant_event_threat_detection_custom_modules` via a request object, either of type
@@ -1379,17 +1432,22 @@ module Google
1379
1432
  # the default parameter values, pass an empty Hash as a request object (see above).
1380
1433
  #
1381
1434
  # @param parent [::String]
1382
- # Required. Name of parent to list custom modules. Its format is
1383
- # `organizations/{organization}/locations/{location}`,
1384
- # `folders/{folder}/locations/{location}`,
1385
- # or
1386
- # `projects/{project}/locations/{location}`
1435
+ # Required. Name of parent to list custom modules, in one of the following
1436
+ # formats:
1437
+ #
1438
+ # * `organizations/{organization}/locations/{location}`
1439
+ # * `folders/{folder}/locations/{location}`
1440
+ # * `projects/{project}/locations/{location}`
1387
1441
  # @param page_size [::Integer]
1388
1442
  # Optional. The maximum number of modules to return. The service may return
1389
1443
  # fewer than this value. If unspecified, at most 10 configs will be returned.
1390
1444
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
1391
1445
  # @param page_token [::String]
1392
- # Optional. A token identifying a page of results the server should return.
1446
+ # Optional. A pagination token returned from a previous request. Provide this
1447
+ # token to retrieve the next page of results.
1448
+ #
1449
+ # When paginating, the rest of the request must match the request that
1450
+ # generated the page token.
1393
1451
  # @yield [result, operation] Access the result along with the TransportOperation object
1394
1452
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
1395
1453
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1473,13 +1531,12 @@ module Google
1473
1531
  # the default parameter values, pass an empty Hash as a request object (see above).
1474
1532
  #
1475
1533
  # @param name [::String]
1476
- # Required. The resource name of the ETD custom module.
1477
- #
1478
- # Its format is:
1534
+ # Required. The resource name of the Event Threat Detection custom module, in
1535
+ # one of the following formats:
1479
1536
  #
1480
- # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1481
- # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1482
- # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1537
+ # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1538
+ # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1539
+ # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1483
1540
  # @yield [result, operation] Access the result along with the TransportOperation object
1484
1541
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
1485
1542
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1541,9 +1598,9 @@ module Google
1541
1598
 
1542
1599
  ##
1543
1600
  # Creates a resident Event Threat Detection custom module at the scope of the
1544
- # given Resource Manager parent, and also creates inherited custom modules
1545
- # for all descendants of the given parent. These modules are enabled by
1546
- # default.
1601
+ # given organization, folder, or project, and creates inherited custom
1602
+ # modules for all descendants of the given parent. These modules are enabled
1603
+ # by default.
1547
1604
  #
1548
1605
  # @overload create_event_threat_detection_custom_module(request, options = nil)
1549
1606
  # Pass arguments to `create_event_threat_detection_custom_module` via a request object, either of type
@@ -1561,23 +1618,29 @@ module Google
1561
1618
  # the default parameter values, pass an empty Hash as a request object (see above).
1562
1619
  #
1563
1620
  # @param parent [::String]
1564
- # Required. Name of parent for the module. Its format is
1565
- # `organizations/{organization}/locations/{location}`,
1566
- # `folders/{folder}/locations/{location}`,
1567
- # or
1568
- # `projects/{project}/locations/{location}`
1621
+ # Required. Name of parent for the module, in one of the following formats:
1622
+ #
1623
+ # * `organizations/{organization}/locations/{location}`
1624
+ # * `folders/{folder}/locations/{location}`
1625
+ # * `projects/{project}/locations/{location}`
1569
1626
  # @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
1570
1627
  # Required. The module to create. The
1571
- # event_threat_detection_custom_module.name will be ignored and server
1572
- # generated.
1628
+ # {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule#name EventThreatDetectionCustomModule.name}
1629
+ # field is ignored; Security Command Center generates the name.
1573
1630
  # @param validate_only [::Boolean]
1574
- # Optional. When set to true, only validations (including IAM checks) will
1575
- # done for the request (no module will be created). An OK response indicates
1576
- # the request is valid while an error response indicates the request is
1577
- # invalid. Note that a subsequent request to actually create the module could
1578
- # still fail because 1. the state could have changed (e.g. IAM permission
1579
- # lost) or
1580
- # 2. A failure occurred during creation of the module.
1631
+ # Optional. When set to `true`, the request will be validated (including IAM
1632
+ # checks), but no module will be created. An `OK` response indicates that the
1633
+ # request is valid, while an error response indicates that the request is
1634
+ # invalid.
1635
+ #
1636
+ # If the request is valid, a subsequent request to create the module could
1637
+ # still fail for one of the following reasons:
1638
+ #
1639
+ # * The state of your cloud resources changed; for example, you lost a
1640
+ # required IAM permission
1641
+ # * An error occurred during creation of the module
1642
+ #
1643
+ # Defaults to `false`.
1581
1644
  # @yield [result, operation] Access the result along with the TransportOperation object
1582
1645
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
1583
1646
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1661,21 +1724,23 @@ module Google
1661
1724
  # the default parameter values, pass an empty Hash as a request object (see above).
1662
1725
  #
1663
1726
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1664
- # Required. Field mask is used to specify the fields to be overwritten in the
1665
- # EventThreatDetectionCustomModule resource by the update.
1666
- # The fields specified in the update_mask are relative to the resource, not
1667
- # the full request. A field will be overwritten if it is in the mask. If the
1668
- # user does not provide a mask then all fields will be overwritten.
1727
+ # Required. The fields to update. If omitted, then all fields are updated.
1669
1728
  # @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
1670
- # Required. The module being updated
1729
+ # Required. The module being updated.
1671
1730
  # @param validate_only [::Boolean]
1672
- # Optional. When set to true, only validations (including IAM checks) will
1673
- # done for the request (module will not be updated). An OK response indicates
1674
- # the request is valid while an error response indicates the request is
1675
- # invalid. Note that a subsequent request to actually update the module could
1676
- # still fail because 1. the state could have changed (e.g. IAM permission
1677
- # lost) or
1678
- # 2. A failure occurred while trying to update the module.
1731
+ # Optional. When set to `true`, the request will be validated (including IAM
1732
+ # checks), but no module will be updated. An `OK` response indicates that the
1733
+ # request is valid, while an error response indicates that the request is
1734
+ # invalid.
1735
+ #
1736
+ # If the request is valid, a subsequent request to update the module could
1737
+ # still fail for one of the following reasons:
1738
+ #
1739
+ # * The state of your cloud resources changed; for example, you lost a
1740
+ # required IAM permission
1741
+ # * An error occurred during creation of the module
1742
+ #
1743
+ # Defaults to `false`.
1679
1744
  # @yield [result, operation] Access the result along with the TransportOperation object
1680
1745
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
1681
1746
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1737,8 +1802,8 @@ module Google
1737
1802
 
1738
1803
  ##
1739
1804
  # Deletes the specified Event Threat Detection custom module and all of its
1740
- # descendants in the Resource Manager hierarchy. This method is only
1741
- # supported for resident custom modules.
1805
+ # descendants in the resource hierarchy. This method is only supported for
1806
+ # resident custom modules.
1742
1807
  #
1743
1808
  # @overload delete_event_threat_detection_custom_module(request, options = nil)
1744
1809
  # Pass arguments to `delete_event_threat_detection_custom_module` via a request object, either of type
@@ -1756,21 +1821,26 @@ module Google
1756
1821
  # the default parameter values, pass an empty Hash as a request object (see above).
1757
1822
  #
1758
1823
  # @param name [::String]
1759
- # Required. The resource name of the ETD custom module.
1824
+ # Required. The resource name of the Event Threat Detection custom module, in
1825
+ # one of the following formats:
1760
1826
  #
1761
- # Its format is:
1762
- #
1763
- # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1764
- # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1765
- # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1827
+ # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1828
+ # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1829
+ # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1766
1830
  # @param validate_only [::Boolean]
1767
- # Optional. When set to true, only validations (including IAM checks) will
1768
- # done for the request (module will not be deleted). An OK response indicates
1769
- # the request is valid while an error response indicates the request is
1770
- # invalid. Note that a subsequent request to actually delete the module could
1771
- # still fail because 1. the state could have changed (e.g. IAM permission
1772
- # lost) or
1773
- # 2. A failure occurred while trying to delete the module.
1831
+ # Optional. When set to `true`, the request will be validated (including IAM
1832
+ # checks), but no module will be deleted. An `OK` response indicates that the
1833
+ # request is valid, while an error response indicates that the request is
1834
+ # invalid.
1835
+ #
1836
+ # If the request is valid, a subsequent request to delete the module could
1837
+ # still fail for one of the following reasons:
1838
+ #
1839
+ # * The state of your cloud resources changed; for example, you lost a
1840
+ # required IAM permission
1841
+ # * An error occurred during creation of the module
1842
+ #
1843
+ # Defaults to `false`.
1774
1844
  # @yield [result, operation] Access the result along with the TransportOperation object
1775
1845
  # @yieldparam result [::Google::Protobuf::Empty]
1776
1846
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1849,16 +1919,15 @@ module Google
1849
1919
  # the default parameter values, pass an empty Hash as a request object (see above).
1850
1920
  #
1851
1921
  # @param parent [::String]
1852
- # Required. Resource name of the parent to validate the Custom Module under.
1922
+ # Required. Resource name of the parent to validate the custom modules under,
1923
+ # in one of the following formats:
1853
1924
  #
1854
- # Its format is:
1855
- #
1856
- # * `organizations/{organization}/locations/{location}`.
1925
+ # * `organizations/{organization}/locations/{location}`
1857
1926
  # @param raw_text [::String]
1858
1927
  # Required. The raw text of the module's contents. Used to generate error
1859
1928
  # messages.
1860
1929
  # @param type [::String]
1861
- # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
1930
+ # Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`.
1862
1931
  # @yield [result, operation] Access the result along with the TransportOperation object
1863
1932
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::ValidateEventThreatDetectionCustomModuleResponse]
1864
1933
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1937,24 +2006,23 @@ module Google
1937
2006
  # the default parameter values, pass an empty Hash as a request object (see above).
1938
2007
  #
1939
2008
  # @param name [::String]
1940
- # Required. The Security Command Center service to retrieve.
2009
+ # Required. The Security Command Center service to retrieve, in one of the
2010
+ # following formats:
1941
2011
  #
1942
- # Formats:
2012
+ # * organizations/\\{organization}/locations/\\{location}/securityCenterServices/\\{service}
2013
+ # * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
2014
+ # * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
1943
2015
  #
1944
- # * organizations/\\{organization}/locations/\\{location}/securityCenterServices/\\{service}
1945
- # * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
1946
- # * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
2016
+ # The following values are valid for `{service}`:
1947
2017
  #
1948
- # The possible values for id \\{service} are:
1949
- #
1950
- # * container-threat-detection
1951
- # * event-threat-detection
1952
- # * security-health-analytics
1953
- # * vm-threat-detection
1954
- # * web-security-scanner
2018
+ # * `container-threat-detection`
2019
+ # * `event-threat-detection`
2020
+ # * `security-health-analytics`
2021
+ # * `vm-threat-detection`
2022
+ # * `web-security-scanner`
1955
2023
  # @param show_eligible_modules_only [::Boolean]
1956
- # Flag that, when set, will be used to filter the ModuleSettings that are
1957
- # in scope. The default setting is that all modules will be shown.
2024
+ # Set to `true` to show only modules that are in scope. By default, all
2025
+ # modules are shown.
1958
2026
  # @yield [result, operation] Access the result along with the TransportOperation object
1959
2027
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
1960
2028
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2034,21 +2102,24 @@ module Google
2034
2102
  # the default parameter values, pass an empty Hash as a request object (see above).
2035
2103
  #
2036
2104
  # @param parent [::String]
2037
- # Required. The name of the parent to list Security Command Center services.
2038
- #
2039
- # Formats:
2105
+ # Required. The name of the parent to list Security Command Center services,
2106
+ # in one of the following formats:
2040
2107
  #
2041
- # * organizations/\\{organization}/locations/\\{location}
2042
- # * folders/\\{folder}/locations/\\{location}
2043
- # * projects/\\{project}/locations/\\{location}
2108
+ # * `organizations/{organization}/locations/{location}`
2109
+ # * `folders/{folder}/locations/{location}`
2110
+ # * `projects/{project}/locations/{location}`
2044
2111
  # @param page_size [::Integer]
2045
2112
  # Optional. The maximum number of results to return in a single response.
2046
2113
  # Default is 10, minimum is 1, maximum is 1000.
2047
2114
  # @param page_token [::String]
2048
- # Optional. The value returned by the last call indicating a continuation.
2115
+ # Optional. A pagination token returned from a previous request. Provide this
2116
+ # token to retrieve the next page of results.
2117
+ #
2118
+ # When paginating, the rest of the request must match the request that
2119
+ # generated the page token.
2049
2120
  # @param show_eligible_modules_only [::Boolean]
2050
- # Flag that, when set, will be used to filter the ModuleSettings that are
2051
- # in scope. The default setting is that all modules will be shown.
2121
+ # Flag that, when set, is used to filter the module settings that are shown.
2122
+ # The default setting is that all modules are shown.
2052
2123
  # @yield [result, operation] Access the result along with the TransportOperation object
2053
2124
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService>]
2054
2125
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2134,18 +2205,26 @@ module Google
2134
2205
  # @param security_center_service [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService, ::Hash]
2135
2206
  # Required. The updated service.
2136
2207
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2137
- # Required. The list of fields to be updated. Possible values:
2208
+ # Required. The fields to update. Accepts the following values:
2138
2209
  #
2139
- # * "intended_enablement_state"
2140
- # * "modules"
2210
+ # * `intended_enablement_state`
2211
+ # * `modules`
2212
+ #
2213
+ # If omitted, then all eligible fields are updated.
2141
2214
  # @param validate_only [::Boolean]
2142
- # Optional. When set to true, only validations (including IAM checks) will be
2143
- # done for the request (service will not be updated). An OK response
2144
- # indicates that the request is valid, while an error response indicates that
2145
- # the request is invalid. Note that a subsequent request to actually update
2146
- # the service could still fail for one of the following reasons:
2147
- # - The state could have changed (e.g. IAM permission lost).
2148
- # - A failure occurred while trying to delete the module.
2215
+ # Optional. When set to `true`, the request will be validated (including IAM
2216
+ # checks), but no service will be updated. An `OK` response indicates that
2217
+ # the request is valid, while an error response indicates that the request is
2218
+ # invalid.
2219
+ #
2220
+ # If the request is valid, a subsequent request to update the service could
2221
+ # still fail for one of the following reasons:
2222
+ #
2223
+ # * The state of your cloud resources changed; for example, you lost a
2224
+ # required IAM permission
2225
+ # * An error occurred during update of the service
2226
+ #
2227
+ # Defaults to `false`.
2149
2228
  # @yield [result, operation] Access the result along with the TransportOperation object
2150
2229
  # @yieldparam result [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
2151
2230
  # @yieldparam operation [::Gapic::Rest::TransportOperation]