google-cloud-security_center_management-v1 1.0.1 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/README.md +2 -2
- data/lib/google/cloud/security_center_management/v1/security_center_management/client.rb +287 -208
- data/lib/google/cloud/security_center_management/v1/security_center_management/rest/client.rb +287 -208
- data/lib/google/cloud/security_center_management/v1/version.rb +1 -1
- data/lib/google/cloud/securitycentermanagement/v1/security_center_management_services_pb.rb +60 -41
- data/proto_docs/README.md +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/cloud/securitycentermanagement/v1/security_center_management.rb +511 -430
- metadata +3 -3
@@ -251,10 +251,11 @@ module Google
|
|
251
251
|
# Service calls
|
252
252
|
|
253
253
|
##
|
254
|
-
# Returns a list of all
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
254
|
+
# Returns a list of all
|
255
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}
|
256
|
+
# resources for the given parent. This includes resident modules defined at
|
257
|
+
# the scope of the parent, and inherited modules, inherited from ancestor
|
258
|
+
# organizations, folders, and projects (no descendants).
|
258
259
|
#
|
259
260
|
# @overload list_effective_security_health_analytics_custom_modules(request, options = nil)
|
260
261
|
# Pass arguments to `list_effective_security_health_analytics_custom_modules` via a request object, either of type
|
@@ -272,17 +273,21 @@ module Google
|
|
272
273
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
273
274
|
#
|
274
275
|
# @param parent [::String]
|
275
|
-
# Required. Name of parent to list effective custom modules
|
276
|
-
#
|
276
|
+
# Required. Name of parent to list effective custom modules, in one of the
|
277
|
+
# following formats:
|
278
|
+
#
|
277
279
|
# * `organizations/{organization}/locations/{location}`
|
278
280
|
# * `folders/{folder}/locations/{location}`
|
279
|
-
#
|
280
|
-
# `projects/{project}/locations/{location}`
|
281
|
+
# * `projects/{project}/locations/{location}`
|
281
282
|
# @param page_size [::Integer]
|
282
283
|
# Optional. The maximum number of results to return in a single response.
|
283
284
|
# Default is 10, minimum is 1, maximum is 1000.
|
284
285
|
# @param page_token [::String]
|
285
|
-
# Optional.
|
286
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
287
|
+
# token to retrieve the next page of results.
|
288
|
+
#
|
289
|
+
# When paginating, the rest of the request must match the request that
|
290
|
+
# generated the page token.
|
286
291
|
#
|
287
292
|
# @yield [response, operation] Access the result along with the RPC operation
|
288
293
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule>]
|
@@ -355,7 +360,8 @@ module Google
|
|
355
360
|
end
|
356
361
|
|
357
362
|
##
|
358
|
-
# Gets details of a single
|
363
|
+
# Gets details of a single
|
364
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}.
|
359
365
|
#
|
360
366
|
# @overload get_effective_security_health_analytics_custom_module(request, options = nil)
|
361
367
|
# Pass arguments to `get_effective_security_health_analytics_custom_module` via a request object, either of type
|
@@ -376,9 +382,9 @@ module Google
|
|
376
382
|
# Required. The full resource name of the custom module, specified in one of
|
377
383
|
# the following formats:
|
378
384
|
#
|
379
|
-
# * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{
|
380
|
-
# * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{
|
381
|
-
# * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{
|
385
|
+
# * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
|
386
|
+
# * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
|
387
|
+
# * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
|
382
388
|
#
|
383
389
|
# @yield [response, operation] Access the result along with the RPC operation
|
384
390
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule]
|
@@ -446,9 +452,11 @@ module Google
|
|
446
452
|
end
|
447
453
|
|
448
454
|
##
|
449
|
-
# Returns a list of all
|
450
|
-
#
|
451
|
-
#
|
455
|
+
# Returns a list of all
|
456
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
457
|
+
# resources for the given parent. This includes resident modules defined at
|
458
|
+
# the scope of the parent, and inherited modules, inherited from ancestor
|
459
|
+
# organizations, folders, and projects (no descendants).
|
452
460
|
#
|
453
461
|
# @overload list_security_health_analytics_custom_modules(request, options = nil)
|
454
462
|
# Pass arguments to `list_security_health_analytics_custom_modules` via a request object, either of type
|
@@ -466,8 +474,8 @@ module Google
|
|
466
474
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
467
475
|
#
|
468
476
|
# @param parent [::String]
|
469
|
-
# Required. Name of parent organization, folder, or project in which to
|
470
|
-
# custom modules,
|
477
|
+
# Required. Name of the parent organization, folder, or project in which to
|
478
|
+
# list custom modules, in one of the following formats:
|
471
479
|
#
|
472
480
|
# * `organizations/{organization}/locations/{location}`
|
473
481
|
# * `folders/{folder}/locations/{location}`
|
@@ -476,7 +484,11 @@ module Google
|
|
476
484
|
# Optional. The maximum number of results to return in a single response.
|
477
485
|
# Default is 10, minimum is 1, maximum is 1000.
|
478
486
|
# @param page_token [::String]
|
479
|
-
# Optional. A token
|
487
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
488
|
+
# token to retrieve the next page of results.
|
489
|
+
#
|
490
|
+
# When paginating, the rest of the request must match the request that
|
491
|
+
# generated the page token.
|
480
492
|
#
|
481
493
|
# @yield [response, operation] Access the result along with the RPC operation
|
482
494
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
|
@@ -549,8 +561,10 @@ module Google
|
|
549
561
|
end
|
550
562
|
|
551
563
|
##
|
552
|
-
# Returns a list of all resident
|
553
|
-
#
|
564
|
+
# Returns a list of all resident
|
565
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
566
|
+
# resources under the given organization, folder, or project and all of its
|
567
|
+
# descendants.
|
554
568
|
#
|
555
569
|
# @overload list_descendant_security_health_analytics_custom_modules(request, options = nil)
|
556
570
|
# Pass arguments to `list_descendant_security_health_analytics_custom_modules` via a request object, either of type
|
@@ -569,7 +583,7 @@ module Google
|
|
569
583
|
#
|
570
584
|
# @param parent [::String]
|
571
585
|
# Required. Name of the parent organization, folder, or project in which to
|
572
|
-
# list custom modules,
|
586
|
+
# list custom modules, in one of the following formats:
|
573
587
|
#
|
574
588
|
# * `organizations/{organization}/locations/{location}`
|
575
589
|
# * `folders/{folder}/locations/{location}`
|
@@ -578,7 +592,11 @@ module Google
|
|
578
592
|
# Optional. The maximum number of results to return in a single response.
|
579
593
|
# Default is 10, minimum is 1, maximum is 1000.
|
580
594
|
# @param page_token [::String]
|
581
|
-
# Optional. A token
|
595
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
596
|
+
# token to retrieve the next page of results.
|
597
|
+
#
|
598
|
+
# When paginating, the rest of the request must match the request that
|
599
|
+
# generated the page token.
|
582
600
|
#
|
583
601
|
# @yield [response, operation] Access the result along with the RPC operation
|
584
602
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
|
@@ -651,7 +669,8 @@ module Google
|
|
651
669
|
end
|
652
670
|
|
653
671
|
##
|
654
|
-
# Retrieves a
|
672
|
+
# Retrieves a
|
673
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}.
|
655
674
|
#
|
656
675
|
# @overload get_security_health_analytics_custom_module(request, options = nil)
|
657
676
|
# Pass arguments to `get_security_health_analytics_custom_module` via a request object, either of type
|
@@ -669,7 +688,8 @@ module Google
|
|
669
688
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
670
689
|
#
|
671
690
|
# @param name [::String]
|
672
|
-
# Required. Name of the resource
|
691
|
+
# Required. Name of the resource, in the format
|
692
|
+
# `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`.
|
673
693
|
#
|
674
694
|
# @yield [response, operation] Access the result along with the RPC operation
|
675
695
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
|
@@ -737,10 +757,12 @@ module Google
|
|
737
757
|
end
|
738
758
|
|
739
759
|
##
|
740
|
-
# Creates a resident
|
741
|
-
#
|
742
|
-
#
|
743
|
-
#
|
760
|
+
# Creates a resident
|
761
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
762
|
+
# at the scope of the given organization, folder, or project, and also
|
763
|
+
# creates inherited `SecurityHealthAnalyticsCustomModule` resources for all
|
764
|
+
# folders and projects that are descendants of the given parent. These
|
765
|
+
# modules are enabled by default.
|
744
766
|
#
|
745
767
|
# @overload create_security_health_analytics_custom_module(request, options = nil)
|
746
768
|
# Pass arguments to `create_security_health_analytics_custom_module` via a request object, either of type
|
@@ -759,22 +781,27 @@ module Google
|
|
759
781
|
#
|
760
782
|
# @param parent [::String]
|
761
783
|
# Required. Name of the parent organization, folder, or project of the
|
762
|
-
# module,
|
784
|
+
# module, in one of the following formats:
|
763
785
|
#
|
764
786
|
# * `organizations/{organization}/locations/{location}`
|
765
787
|
# * `folders/{folder}/locations/{location}`
|
766
788
|
# * `projects/{project}/locations/{location}`
|
767
789
|
# @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
|
768
|
-
# Required. The resource being created
|
790
|
+
# Required. The resource being created.
|
769
791
|
# @param validate_only [::Boolean]
|
770
|
-
# Optional. When set to true
|
771
|
-
#
|
772
|
-
#
|
773
|
-
# invalid.
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
792
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
793
|
+
# checks), but no module will be created. An `OK` response indicates that the
|
794
|
+
# request is valid, while an error response indicates that the request is
|
795
|
+
# invalid.
|
796
|
+
#
|
797
|
+
# If the request is valid, a subsequent request to create the module could
|
798
|
+
# still fail for one of the following reasons:
|
799
|
+
#
|
800
|
+
# * The state of your cloud resources changed; for example, you lost a
|
801
|
+
# required IAM permission
|
802
|
+
# * An error occurred during creation of the module
|
803
|
+
#
|
804
|
+
# Defaults to `false`.
|
778
805
|
#
|
779
806
|
# @yield [response, operation] Access the result along with the RPC operation
|
780
807
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
|
@@ -842,11 +869,13 @@ module Google
|
|
842
869
|
end
|
843
870
|
|
844
871
|
##
|
845
|
-
# Updates the
|
846
|
-
#
|
847
|
-
#
|
848
|
-
# enablement state
|
849
|
-
#
|
872
|
+
# Updates the
|
873
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
874
|
+
# under the given name based on the given update mask. Updating the
|
875
|
+
# enablement state is supported on both resident and inherited modules
|
876
|
+
# (though resident modules cannot have an enablement state of "inherited").
|
877
|
+
# Updating the display name and custom configuration of a module is supported
|
878
|
+
# on resident modules only.
|
850
879
|
#
|
851
880
|
# @overload update_security_health_analytics_custom_module(request, options = nil)
|
852
881
|
# Pass arguments to `update_security_health_analytics_custom_module` via a request object, either of type
|
@@ -864,20 +893,29 @@ module Google
|
|
864
893
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
865
894
|
#
|
866
895
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
867
|
-
# Required. The
|
868
|
-
#
|
869
|
-
#
|
870
|
-
#
|
896
|
+
# Required. The fields to update. The following values are valid:
|
897
|
+
#
|
898
|
+
# * `custom_config`
|
899
|
+
# * `enablement_state`
|
900
|
+
#
|
901
|
+
# If you omit this field or set it to the wildcard value `*`, then all
|
902
|
+
# eligible fields are updated.
|
871
903
|
# @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
|
872
|
-
# Required. The resource being updated
|
904
|
+
# Required. The resource being updated.
|
873
905
|
# @param validate_only [::Boolean]
|
874
|
-
# Optional. When set to true
|
875
|
-
#
|
876
|
-
#
|
877
|
-
# invalid.
|
878
|
-
#
|
879
|
-
#
|
880
|
-
#
|
906
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
907
|
+
# checks), but no module will be updated. An `OK` response indicates that the
|
908
|
+
# request is valid, while an error response indicates that the request is
|
909
|
+
# invalid.
|
910
|
+
#
|
911
|
+
# If the request is valid, a subsequent request to update the module could
|
912
|
+
# still fail for one of the following reasons:
|
913
|
+
#
|
914
|
+
# * The state of your cloud resources changed; for example, you lost a
|
915
|
+
# required IAM permission
|
916
|
+
# * An error occurred during creation of the module
|
917
|
+
#
|
918
|
+
# Defaults to `false`.
|
881
919
|
#
|
882
920
|
# @yield [response, operation] Access the result along with the RPC operation
|
883
921
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
|
@@ -945,9 +983,10 @@ module Google
|
|
945
983
|
end
|
946
984
|
|
947
985
|
##
|
948
|
-
# Deletes the specified
|
949
|
-
#
|
950
|
-
#
|
986
|
+
# Deletes the specified
|
987
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
988
|
+
# and all of its descendants in the resource hierarchy. This method is only
|
989
|
+
# supported for resident custom modules.
|
951
990
|
#
|
952
991
|
# @overload delete_security_health_analytics_custom_module(request, options = nil)
|
953
992
|
# Pass arguments to `delete_security_health_analytics_custom_module` via a request object, either of type
|
@@ -965,21 +1004,26 @@ module Google
|
|
965
1004
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
966
1005
|
#
|
967
1006
|
# @param name [::String]
|
968
|
-
# Required. The resource name of the SHA custom module
|
969
|
-
#
|
970
|
-
# Its format is:
|
1007
|
+
# Required. The resource name of the SHA custom module, in one of the
|
1008
|
+
# following formats:
|
971
1009
|
#
|
972
|
-
# * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{
|
973
|
-
# * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{
|
974
|
-
# * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{
|
1010
|
+
# * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
|
1011
|
+
# * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
|
1012
|
+
# * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
|
975
1013
|
# @param validate_only [::Boolean]
|
976
|
-
# Optional. When set to true
|
977
|
-
#
|
978
|
-
#
|
979
|
-
# invalid.
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
1014
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
1015
|
+
# checks), but no module will be deleted. An `OK` response indicates that the
|
1016
|
+
# request is valid, while an error response indicates that the request is
|
1017
|
+
# invalid.
|
1018
|
+
#
|
1019
|
+
# If the request is valid, a subsequent request to delete the module could
|
1020
|
+
# still fail for one of the following reasons:
|
1021
|
+
#
|
1022
|
+
# * The state of your cloud resources changed; for example, you lost a
|
1023
|
+
# required IAM permission
|
1024
|
+
# * An error occurred during deletion of the module
|
1025
|
+
#
|
1026
|
+
# Defaults to `false`.
|
983
1027
|
#
|
984
1028
|
# @yield [response, operation] Access the result along with the RPC operation
|
985
1029
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1047,7 +1091,9 @@ module Google
|
|
1047
1091
|
end
|
1048
1092
|
|
1049
1093
|
##
|
1050
|
-
# Simulates
|
1094
|
+
# Simulates the result of using a
|
1095
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
|
1096
|
+
# to check a resource.
|
1051
1097
|
#
|
1052
1098
|
# @overload simulate_security_health_analytics_custom_module(request, options = nil)
|
1053
1099
|
# Pass arguments to `simulate_security_health_analytics_custom_module` via a request object, either of type
|
@@ -1066,10 +1112,9 @@ module Google
|
|
1066
1112
|
#
|
1067
1113
|
# @param parent [::String]
|
1068
1114
|
# Required. The relative resource name of the organization, project, or
|
1069
|
-
# folder. For more information about relative resource names, see [
|
1070
|
-
# Resource
|
1071
|
-
#
|
1072
|
-
# Example: `organizations/{organization_id}`.
|
1115
|
+
# folder. For more information about relative resource names, see [AIP-122:
|
1116
|
+
# Resource names](https://google.aip.dev/122). Example:
|
1117
|
+
# `organizations/{organization_id}`.
|
1073
1118
|
# @param custom_config [::Google::Cloud::SecurityCenterManagement::V1::CustomConfig, ::Hash]
|
1074
1119
|
# Required. The custom configuration that you need to test.
|
1075
1120
|
# @param resource [::Google::Cloud::SecurityCenterManagement::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource, ::Hash]
|
@@ -1161,16 +1206,21 @@ module Google
|
|
1161
1206
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1162
1207
|
#
|
1163
1208
|
# @param parent [::String]
|
1164
|
-
# Required. Name of parent to list effective custom modules
|
1165
|
-
#
|
1166
|
-
#
|
1167
|
-
#
|
1168
|
-
# `
|
1209
|
+
# Required. Name of parent to list effective custom modules, in one of the
|
1210
|
+
# following formats:
|
1211
|
+
#
|
1212
|
+
# * `organizations/{organization}/locations/{location}`
|
1213
|
+
# * `folders/{folder}/locations/{location}`
|
1214
|
+
# * `projects/{project}/locations/{location}`
|
1169
1215
|
# @param page_size [::Integer]
|
1170
1216
|
# Optional. The maximum number of results to return in a single response.
|
1171
1217
|
# Default is 10, minimum is 1, maximum is 1000.
|
1172
1218
|
# @param page_token [::String]
|
1173
|
-
# Optional.
|
1219
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
1220
|
+
# token to retrieve the next page of results.
|
1221
|
+
#
|
1222
|
+
# When paginating, the rest of the request must match the request that
|
1223
|
+
# generated the page token.
|
1174
1224
|
#
|
1175
1225
|
# @yield [response, operation] Access the result along with the RPC operation
|
1176
1226
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule>]
|
@@ -1243,13 +1293,18 @@ module Google
|
|
1243
1293
|
end
|
1244
1294
|
|
1245
1295
|
##
|
1246
|
-
# Gets
|
1247
|
-
#
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
#
|
1296
|
+
# Gets the effective Event Threat Detection custom module at the given level.
|
1297
|
+
#
|
1298
|
+
# The difference between an
|
1299
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule EffectiveEventThreatDetectionCustomModule}
|
1300
|
+
# and an
|
1301
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule EventThreatDetectionCustomModule}
|
1302
|
+
# is that the fields for an `EffectiveEventThreatDetectionCustomModule` are
|
1303
|
+
# computed from ancestors if needed. For example, the enablement state for an
|
1304
|
+
# `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or
|
1305
|
+
# `INHERITED`. In contrast, the enablement state for an
|
1306
|
+
# `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED`
|
1307
|
+
# or `DISABLED`.
|
1253
1308
|
#
|
1254
1309
|
# @overload get_effective_event_threat_detection_custom_module(request, options = nil)
|
1255
1310
|
# Pass arguments to `get_effective_event_threat_detection_custom_module` via a request object, either of type
|
@@ -1267,13 +1322,12 @@ module Google
|
|
1267
1322
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1268
1323
|
#
|
1269
1324
|
# @param name [::String]
|
1270
|
-
# Required. The resource name of the
|
1271
|
-
#
|
1272
|
-
# Its format is:
|
1325
|
+
# Required. The resource name of the Event Threat Detection custom module, in
|
1326
|
+
# one of the following formats:
|
1273
1327
|
#
|
1274
|
-
#
|
1275
|
-
#
|
1276
|
-
#
|
1328
|
+
# * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
|
1329
|
+
# * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
|
1330
|
+
# * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
|
1277
1331
|
#
|
1278
1332
|
# @yield [response, operation] Access the result along with the RPC operation
|
1279
1333
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule]
|
@@ -1341,9 +1395,9 @@ module Google
|
|
1341
1395
|
end
|
1342
1396
|
|
1343
1397
|
##
|
1344
|
-
# Lists all Event Threat Detection custom modules for the given
|
1345
|
-
#
|
1346
|
-
#
|
1398
|
+
# Lists all Event Threat Detection custom modules for the given organization,
|
1399
|
+
# folder, or project. This includes resident modules defined at the scope of
|
1400
|
+
# the parent along with modules inherited from ancestors.
|
1347
1401
|
#
|
1348
1402
|
# @overload list_event_threat_detection_custom_modules(request, options = nil)
|
1349
1403
|
# Pass arguments to `list_event_threat_detection_custom_modules` via a request object, either of type
|
@@ -1361,23 +1415,22 @@ module Google
|
|
1361
1415
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1362
1416
|
#
|
1363
1417
|
# @param parent [::String]
|
1364
|
-
# Required. Name of parent to list custom modules
|
1365
|
-
#
|
1366
|
-
#
|
1367
|
-
#
|
1368
|
-
# `
|
1418
|
+
# Required. Name of parent to list custom modules, in one of the following
|
1419
|
+
# formats:
|
1420
|
+
#
|
1421
|
+
# * `organizations/{organization}/locations/{location}`
|
1422
|
+
# * `folders/{folder}/locations/{location}`
|
1423
|
+
# * `projects/{project}/locations/{location}`
|
1369
1424
|
# @param page_size [::Integer]
|
1370
1425
|
# Optional. The maximum number of modules to return. The service may return
|
1371
|
-
# fewer than this value. If unspecified, at most 10
|
1426
|
+
# fewer than this value. If unspecified, at most 10 modules will be returned.
|
1372
1427
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
1373
1428
|
# @param page_token [::String]
|
1374
|
-
# Optional. A
|
1375
|
-
#
|
1376
|
-
# subsequent page.
|
1429
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
1430
|
+
# token to retrieve the next page of results.
|
1377
1431
|
#
|
1378
|
-
# When paginating,
|
1379
|
-
#
|
1380
|
-
# the page token.
|
1432
|
+
# When paginating, the rest of the request must match the request that
|
1433
|
+
# generated the page token.
|
1381
1434
|
#
|
1382
1435
|
# @yield [response, operation] Access the result along with the RPC operation
|
1383
1436
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
|
@@ -1450,8 +1503,8 @@ module Google
|
|
1450
1503
|
end
|
1451
1504
|
|
1452
1505
|
##
|
1453
|
-
# Lists all resident Event Threat Detection custom modules
|
1454
|
-
#
|
1506
|
+
# Lists all resident Event Threat Detection custom modules for the given
|
1507
|
+
# organization, folder, or project and its descendants.
|
1455
1508
|
#
|
1456
1509
|
# @overload list_descendant_event_threat_detection_custom_modules(request, options = nil)
|
1457
1510
|
# Pass arguments to `list_descendant_event_threat_detection_custom_modules` via a request object, either of type
|
@@ -1469,17 +1522,22 @@ module Google
|
|
1469
1522
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1470
1523
|
#
|
1471
1524
|
# @param parent [::String]
|
1472
|
-
# Required. Name of parent to list custom modules
|
1473
|
-
#
|
1474
|
-
#
|
1475
|
-
#
|
1476
|
-
# `
|
1525
|
+
# Required. Name of parent to list custom modules, in one of the following
|
1526
|
+
# formats:
|
1527
|
+
#
|
1528
|
+
# * `organizations/{organization}/locations/{location}`
|
1529
|
+
# * `folders/{folder}/locations/{location}`
|
1530
|
+
# * `projects/{project}/locations/{location}`
|
1477
1531
|
# @param page_size [::Integer]
|
1478
1532
|
# Optional. The maximum number of modules to return. The service may return
|
1479
1533
|
# fewer than this value. If unspecified, at most 10 configs will be returned.
|
1480
1534
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
1481
1535
|
# @param page_token [::String]
|
1482
|
-
# Optional. A token
|
1536
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
1537
|
+
# token to retrieve the next page of results.
|
1538
|
+
#
|
1539
|
+
# When paginating, the rest of the request must match the request that
|
1540
|
+
# generated the page token.
|
1483
1541
|
#
|
1484
1542
|
# @yield [response, operation] Access the result along with the RPC operation
|
1485
1543
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
|
@@ -1570,13 +1628,12 @@ module Google
|
|
1570
1628
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1571
1629
|
#
|
1572
1630
|
# @param name [::String]
|
1573
|
-
# Required. The resource name of the
|
1574
|
-
#
|
1575
|
-
# Its format is:
|
1631
|
+
# Required. The resource name of the Event Threat Detection custom module, in
|
1632
|
+
# one of the following formats:
|
1576
1633
|
#
|
1577
|
-
#
|
1578
|
-
#
|
1579
|
-
#
|
1634
|
+
# * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1635
|
+
# * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1636
|
+
# * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1580
1637
|
#
|
1581
1638
|
# @yield [response, operation] Access the result along with the RPC operation
|
1582
1639
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
|
@@ -1645,9 +1702,9 @@ module Google
|
|
1645
1702
|
|
1646
1703
|
##
|
1647
1704
|
# Creates a resident Event Threat Detection custom module at the scope of the
|
1648
|
-
# given
|
1649
|
-
# for all descendants of the given parent. These modules are enabled
|
1650
|
-
# default.
|
1705
|
+
# given organization, folder, or project, and creates inherited custom
|
1706
|
+
# modules for all descendants of the given parent. These modules are enabled
|
1707
|
+
# by default.
|
1651
1708
|
#
|
1652
1709
|
# @overload create_event_threat_detection_custom_module(request, options = nil)
|
1653
1710
|
# Pass arguments to `create_event_threat_detection_custom_module` via a request object, either of type
|
@@ -1665,23 +1722,29 @@ module Google
|
|
1665
1722
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1666
1723
|
#
|
1667
1724
|
# @param parent [::String]
|
1668
|
-
# Required. Name of parent for the module
|
1669
|
-
#
|
1670
|
-
# `
|
1671
|
-
#
|
1672
|
-
# `projects/{project}/locations/{location}`
|
1725
|
+
# Required. Name of parent for the module, in one of the following formats:
|
1726
|
+
#
|
1727
|
+
# * `organizations/{organization}/locations/{location}`
|
1728
|
+
# * `folders/{folder}/locations/{location}`
|
1729
|
+
# * `projects/{project}/locations/{location}`
|
1673
1730
|
# @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
|
1674
1731
|
# Required. The module to create. The
|
1675
|
-
#
|
1676
|
-
#
|
1732
|
+
# {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule#name EventThreatDetectionCustomModule.name}
|
1733
|
+
# field is ignored; Security Command Center generates the name.
|
1677
1734
|
# @param validate_only [::Boolean]
|
1678
|
-
# Optional. When set to true
|
1679
|
-
#
|
1680
|
-
#
|
1681
|
-
# invalid.
|
1682
|
-
#
|
1683
|
-
#
|
1684
|
-
#
|
1735
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
1736
|
+
# checks), but no module will be created. An `OK` response indicates that the
|
1737
|
+
# request is valid, while an error response indicates that the request is
|
1738
|
+
# invalid.
|
1739
|
+
#
|
1740
|
+
# If the request is valid, a subsequent request to create the module could
|
1741
|
+
# still fail for one of the following reasons:
|
1742
|
+
#
|
1743
|
+
# * The state of your cloud resources changed; for example, you lost a
|
1744
|
+
# required IAM permission
|
1745
|
+
# * An error occurred during creation of the module
|
1746
|
+
#
|
1747
|
+
# Defaults to `false`.
|
1685
1748
|
#
|
1686
1749
|
# @yield [response, operation] Access the result along with the RPC operation
|
1687
1750
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
|
@@ -1772,21 +1835,23 @@ module Google
|
|
1772
1835
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1773
1836
|
#
|
1774
1837
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1775
|
-
# Required.
|
1776
|
-
# EventThreatDetectionCustomModule resource by the update.
|
1777
|
-
# The fields specified in the update_mask are relative to the resource, not
|
1778
|
-
# the full request. A field will be overwritten if it is in the mask. If the
|
1779
|
-
# user does not provide a mask then all fields will be overwritten.
|
1838
|
+
# Required. The fields to update. If omitted, then all fields are updated.
|
1780
1839
|
# @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
|
1781
|
-
# Required. The module being updated
|
1840
|
+
# Required. The module being updated.
|
1782
1841
|
# @param validate_only [::Boolean]
|
1783
|
-
# Optional. When set to true
|
1784
|
-
#
|
1785
|
-
#
|
1786
|
-
# invalid.
|
1787
|
-
#
|
1788
|
-
#
|
1789
|
-
#
|
1842
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
1843
|
+
# checks), but no module will be updated. An `OK` response indicates that the
|
1844
|
+
# request is valid, while an error response indicates that the request is
|
1845
|
+
# invalid.
|
1846
|
+
#
|
1847
|
+
# If the request is valid, a subsequent request to update the module could
|
1848
|
+
# still fail for one of the following reasons:
|
1849
|
+
#
|
1850
|
+
# * The state of your cloud resources changed; for example, you lost a
|
1851
|
+
# required IAM permission
|
1852
|
+
# * An error occurred during creation of the module
|
1853
|
+
#
|
1854
|
+
# Defaults to `false`.
|
1790
1855
|
#
|
1791
1856
|
# @yield [response, operation] Access the result along with the RPC operation
|
1792
1857
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
|
@@ -1855,8 +1920,8 @@ module Google
|
|
1855
1920
|
|
1856
1921
|
##
|
1857
1922
|
# Deletes the specified Event Threat Detection custom module and all of its
|
1858
|
-
# descendants in the
|
1859
|
-
#
|
1923
|
+
# descendants in the resource hierarchy. This method is only supported for
|
1924
|
+
# resident custom modules.
|
1860
1925
|
#
|
1861
1926
|
# @overload delete_event_threat_detection_custom_module(request, options = nil)
|
1862
1927
|
# Pass arguments to `delete_event_threat_detection_custom_module` via a request object, either of type
|
@@ -1874,21 +1939,26 @@ module Google
|
|
1874
1939
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1875
1940
|
#
|
1876
1941
|
# @param name [::String]
|
1877
|
-
# Required. The resource name of the
|
1942
|
+
# Required. The resource name of the Event Threat Detection custom module, in
|
1943
|
+
# one of the following formats:
|
1878
1944
|
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
1882
|
-
# * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
|
1883
|
-
# * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
|
1945
|
+
# * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1946
|
+
# * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1947
|
+
# * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
|
1884
1948
|
# @param validate_only [::Boolean]
|
1885
|
-
# Optional. When set to true
|
1886
|
-
#
|
1887
|
-
#
|
1888
|
-
# invalid.
|
1889
|
-
#
|
1890
|
-
#
|
1891
|
-
#
|
1949
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
1950
|
+
# checks), but no module will be deleted. An `OK` response indicates that the
|
1951
|
+
# request is valid, while an error response indicates that the request is
|
1952
|
+
# invalid.
|
1953
|
+
#
|
1954
|
+
# If the request is valid, a subsequent request to delete the module could
|
1955
|
+
# still fail for one of the following reasons:
|
1956
|
+
#
|
1957
|
+
# * The state of your cloud resources changed; for example, you lost a
|
1958
|
+
# required IAM permission
|
1959
|
+
# * An error occurred during creation of the module
|
1960
|
+
#
|
1961
|
+
# Defaults to `false`.
|
1892
1962
|
#
|
1893
1963
|
# @yield [response, operation] Access the result along with the RPC operation
|
1894
1964
|
# @yieldparam response [::Google::Protobuf::Empty]
|
@@ -1974,16 +2044,15 @@ module Google
|
|
1974
2044
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1975
2045
|
#
|
1976
2046
|
# @param parent [::String]
|
1977
|
-
# Required. Resource name of the parent to validate the
|
2047
|
+
# Required. Resource name of the parent to validate the custom modules under,
|
2048
|
+
# in one of the following formats:
|
1978
2049
|
#
|
1979
|
-
#
|
1980
|
-
#
|
1981
|
-
# * `organizations/{organization}/locations/{location}`.
|
2050
|
+
# * `organizations/{organization}/locations/{location}`
|
1982
2051
|
# @param raw_text [::String]
|
1983
2052
|
# Required. The raw text of the module's contents. Used to generate error
|
1984
2053
|
# messages.
|
1985
2054
|
# @param type [::String]
|
1986
|
-
# Required. The type of the module
|
2055
|
+
# Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`.
|
1987
2056
|
#
|
1988
2057
|
# @yield [response, operation] Access the result along with the RPC operation
|
1989
2058
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::ValidateEventThreatDetectionCustomModuleResponse]
|
@@ -2069,24 +2138,23 @@ module Google
|
|
2069
2138
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2070
2139
|
#
|
2071
2140
|
# @param name [::String]
|
2072
|
-
# Required. The Security Command Center service to retrieve
|
2141
|
+
# Required. The Security Command Center service to retrieve, in one of the
|
2142
|
+
# following formats:
|
2073
2143
|
#
|
2074
|
-
#
|
2144
|
+
# * organizations/\\{organization}/locations/\\{location}/securityCenterServices/\\{service}
|
2145
|
+
# * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
|
2146
|
+
# * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
|
2075
2147
|
#
|
2076
|
-
#
|
2077
|
-
# * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
|
2078
|
-
# * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
|
2148
|
+
# The following values are valid for `{service}`:
|
2079
2149
|
#
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
#
|
2083
|
-
#
|
2084
|
-
#
|
2085
|
-
# * vm-threat-detection
|
2086
|
-
# * web-security-scanner
|
2150
|
+
# * `container-threat-detection`
|
2151
|
+
# * `event-threat-detection`
|
2152
|
+
# * `security-health-analytics`
|
2153
|
+
# * `vm-threat-detection`
|
2154
|
+
# * `web-security-scanner`
|
2087
2155
|
# @param show_eligible_modules_only [::Boolean]
|
2088
|
-
#
|
2089
|
-
#
|
2156
|
+
# Set to `true` to show only modules that are in scope. By default, all
|
2157
|
+
# modules are shown.
|
2090
2158
|
#
|
2091
2159
|
# @yield [response, operation] Access the result along with the RPC operation
|
2092
2160
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
|
@@ -2173,21 +2241,24 @@ module Google
|
|
2173
2241
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2174
2242
|
#
|
2175
2243
|
# @param parent [::String]
|
2176
|
-
# Required. The name of the parent to list Security Command Center services
|
2177
|
-
#
|
2178
|
-
# Formats:
|
2244
|
+
# Required. The name of the parent to list Security Command Center services,
|
2245
|
+
# in one of the following formats:
|
2179
2246
|
#
|
2180
|
-
#
|
2181
|
-
#
|
2182
|
-
#
|
2247
|
+
# * `organizations/{organization}/locations/{location}`
|
2248
|
+
# * `folders/{folder}/locations/{location}`
|
2249
|
+
# * `projects/{project}/locations/{location}`
|
2183
2250
|
# @param page_size [::Integer]
|
2184
2251
|
# Optional. The maximum number of results to return in a single response.
|
2185
2252
|
# Default is 10, minimum is 1, maximum is 1000.
|
2186
2253
|
# @param page_token [::String]
|
2187
|
-
# Optional.
|
2254
|
+
# Optional. A pagination token returned from a previous request. Provide this
|
2255
|
+
# token to retrieve the next page of results.
|
2256
|
+
#
|
2257
|
+
# When paginating, the rest of the request must match the request that
|
2258
|
+
# generated the page token.
|
2188
2259
|
# @param show_eligible_modules_only [::Boolean]
|
2189
|
-
# Flag that, when set,
|
2190
|
-
#
|
2260
|
+
# Flag that, when set, is used to filter the module settings that are shown.
|
2261
|
+
# The default setting is that all modules are shown.
|
2191
2262
|
#
|
2192
2263
|
# @yield [response, operation] Access the result along with the RPC operation
|
2193
2264
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService>]
|
@@ -2280,18 +2351,26 @@ module Google
|
|
2280
2351
|
# @param security_center_service [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService, ::Hash]
|
2281
2352
|
# Required. The updated service.
|
2282
2353
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2283
|
-
# Required. The
|
2354
|
+
# Required. The fields to update. Accepts the following values:
|
2284
2355
|
#
|
2285
|
-
#
|
2286
|
-
#
|
2356
|
+
# * `intended_enablement_state`
|
2357
|
+
# * `modules`
|
2358
|
+
#
|
2359
|
+
# If omitted, then all eligible fields are updated.
|
2287
2360
|
# @param validate_only [::Boolean]
|
2288
|
-
# Optional. When set to true
|
2289
|
-
#
|
2290
|
-
#
|
2291
|
-
#
|
2292
|
-
#
|
2293
|
-
#
|
2294
|
-
#
|
2361
|
+
# Optional. When set to `true`, the request will be validated (including IAM
|
2362
|
+
# checks), but no service will be updated. An `OK` response indicates that
|
2363
|
+
# the request is valid, while an error response indicates that the request is
|
2364
|
+
# invalid.
|
2365
|
+
#
|
2366
|
+
# If the request is valid, a subsequent request to update the service could
|
2367
|
+
# still fail for one of the following reasons:
|
2368
|
+
#
|
2369
|
+
# * The state of your cloud resources changed; for example, you lost a
|
2370
|
+
# required IAM permission
|
2371
|
+
# * An error occurred during update of the service
|
2372
|
+
#
|
2373
|
+
# Defaults to `false`.
|
2295
2374
|
#
|
2296
2375
|
# @yield [response, operation] Access the result along with the RPC operation
|
2297
2376
|
# @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
|