google-cloud-security_center_management-v1 1.0.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -230,14 +230,26 @@ module Google
230
230
  universe_domain: @config.universe_domain,
231
231
  channel_args: @config.channel_args,
232
232
  interceptors: @config.interceptors,
233
- channel_pool_config: @config.channel_pool
233
+ channel_pool_config: @config.channel_pool,
234
+ logger: @config.logger
234
235
  )
235
236
 
237
+ @security_center_management_stub.stub_logger&.info do |entry|
238
+ entry.set_system_name
239
+ entry.set_service
240
+ entry.message = "Created client for #{entry.service}"
241
+ entry.set_credentials_fields credentials
242
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
243
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
244
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
245
+ end
246
+
236
247
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
237
248
  config.credentials = credentials
238
249
  config.quota_project = @quota_project_id
239
250
  config.endpoint = @security_center_management_stub.endpoint
240
251
  config.universe_domain = @security_center_management_stub.universe_domain
252
+ config.logger = @security_center_management_stub.logger if config.respond_to? :logger=
241
253
  end
242
254
  end
243
255
 
@@ -248,13 +260,23 @@ module Google
248
260
  #
249
261
  attr_reader :location_client
250
262
 
263
+ ##
264
+ # The logger used for request/response debug logging.
265
+ #
266
+ # @return [Logger]
267
+ #
268
+ def logger
269
+ @security_center_management_stub.logger
270
+ end
271
+
251
272
  # Service calls
252
273
 
253
274
  ##
254
- # Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the
255
- # given parent. This includes resident modules defined at the scope of the
256
- # parent, and inherited modules, inherited from CRM ancestors (no
257
- # descendants).
275
+ # Returns a list of all
276
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}
277
+ # resources for the given parent. This includes resident modules defined at
278
+ # the scope of the parent, and inherited modules, inherited from ancestor
279
+ # organizations, folders, and projects (no descendants).
258
280
  #
259
281
  # @overload list_effective_security_health_analytics_custom_modules(request, options = nil)
260
282
  # Pass arguments to `list_effective_security_health_analytics_custom_modules` via a request object, either of type
@@ -272,17 +294,21 @@ module Google
272
294
  # the default parameter values, pass an empty Hash as a request object (see above).
273
295
  #
274
296
  # @param parent [::String]
275
- # Required. Name of parent to list effective custom modules. specified in one
276
- # of the following formats:
297
+ # Required. Name of parent to list effective custom modules, in one of the
298
+ # following formats:
299
+ #
277
300
  # * `organizations/{organization}/locations/{location}`
278
301
  # * `folders/{folder}/locations/{location}`
279
- # or
280
- # `projects/{project}/locations/{location}`
302
+ # * `projects/{project}/locations/{location}`
281
303
  # @param page_size [::Integer]
282
304
  # Optional. The maximum number of results to return in a single response.
283
305
  # Default is 10, minimum is 1, maximum is 1000.
284
306
  # @param page_token [::String]
285
- # Optional. The value returned by the last call indicating a continuation.
307
+ # Optional. A pagination token returned from a previous request. Provide this
308
+ # token to retrieve the next page of results.
309
+ #
310
+ # When paginating, the rest of the request must match the request that
311
+ # generated the page token.
286
312
  #
287
313
  # @yield [response, operation] Access the result along with the RPC operation
288
314
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule>]
@@ -348,14 +374,15 @@ module Google
348
374
  @security_center_management_stub.call_rpc :list_effective_security_health_analytics_custom_modules, request, options: options do |response, operation|
349
375
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_effective_security_health_analytics_custom_modules, request, response, operation, options
350
376
  yield response, operation if block_given?
351
- return response
377
+ throw :response, response
352
378
  end
353
379
  rescue ::GRPC::BadStatus => e
354
380
  raise ::Google::Cloud::Error.from_error(e)
355
381
  end
356
382
 
357
383
  ##
358
- # Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.
384
+ # Gets details of a single
385
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule EffectiveSecurityHealthAnalyticsCustomModule}.
359
386
  #
360
387
  # @overload get_effective_security_health_analytics_custom_module(request, options = nil)
361
388
  # Pass arguments to `get_effective_security_health_analytics_custom_module` via a request object, either of type
@@ -376,9 +403,9 @@ module Google
376
403
  # Required. The full resource name of the custom module, specified in one of
377
404
  # the following formats:
378
405
  #
379
- # * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
380
- # * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
381
- # * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{effective_security_health_analytics_custom_module}`
406
+ # * `organizations/organization/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
407
+ # * `folders/folder/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
408
+ # * `projects/project/{location}/effectiveSecurityHealthAnalyticsCustomModules/{custom_module}`
382
409
  #
383
410
  # @yield [response, operation] Access the result along with the RPC operation
384
411
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EffectiveSecurityHealthAnalyticsCustomModule]
@@ -439,16 +466,17 @@ module Google
439
466
 
440
467
  @security_center_management_stub.call_rpc :get_effective_security_health_analytics_custom_module, request, options: options do |response, operation|
441
468
  yield response, operation if block_given?
442
- return response
443
469
  end
444
470
  rescue ::GRPC::BadStatus => e
445
471
  raise ::Google::Cloud::Error.from_error(e)
446
472
  end
447
473
 
448
474
  ##
449
- # Returns a list of all SecurityHealthAnalyticsCustomModules for the given
450
- # parent. This includes resident modules defined at the scope of the parent,
451
- # and inherited modules, inherited from CRM ancestors (no descendants).
475
+ # Returns a list of all
476
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
477
+ # resources for the given parent. This includes resident modules defined at
478
+ # the scope of the parent, and inherited modules, inherited from ancestor
479
+ # organizations, folders, and projects (no descendants).
452
480
  #
453
481
  # @overload list_security_health_analytics_custom_modules(request, options = nil)
454
482
  # Pass arguments to `list_security_health_analytics_custom_modules` via a request object, either of type
@@ -466,8 +494,8 @@ module Google
466
494
  # the default parameter values, pass an empty Hash as a request object (see above).
467
495
  #
468
496
  # @param parent [::String]
469
- # Required. Name of parent organization, folder, or project in which to list
470
- # custom modules, specified in one of the following formats:
497
+ # Required. Name of the parent organization, folder, or project in which to
498
+ # list custom modules, in one of the following formats:
471
499
  #
472
500
  # * `organizations/{organization}/locations/{location}`
473
501
  # * `folders/{folder}/locations/{location}`
@@ -476,7 +504,11 @@ module Google
476
504
  # Optional. The maximum number of results to return in a single response.
477
505
  # Default is 10, minimum is 1, maximum is 1000.
478
506
  # @param page_token [::String]
479
- # Optional. A token identifying a page of results the server should return.
507
+ # Optional. A pagination token returned from a previous request. Provide this
508
+ # token to retrieve the next page of results.
509
+ #
510
+ # When paginating, the rest of the request must match the request that
511
+ # generated the page token.
480
512
  #
481
513
  # @yield [response, operation] Access the result along with the RPC operation
482
514
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
@@ -542,15 +574,17 @@ module Google
542
574
  @security_center_management_stub.call_rpc :list_security_health_analytics_custom_modules, request, options: options do |response, operation|
543
575
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_security_health_analytics_custom_modules, request, response, operation, options
544
576
  yield response, operation if block_given?
545
- return response
577
+ throw :response, response
546
578
  end
547
579
  rescue ::GRPC::BadStatus => e
548
580
  raise ::Google::Cloud::Error.from_error(e)
549
581
  end
550
582
 
551
583
  ##
552
- # Returns a list of all resident SecurityHealthAnalyticsCustomModules under
553
- # the given CRM parent and all of the parent's CRM descendants.
584
+ # Returns a list of all resident
585
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
586
+ # resources under the given organization, folder, or project and all of its
587
+ # descendants.
554
588
  #
555
589
  # @overload list_descendant_security_health_analytics_custom_modules(request, options = nil)
556
590
  # Pass arguments to `list_descendant_security_health_analytics_custom_modules` via a request object, either of type
@@ -569,7 +603,7 @@ module Google
569
603
  #
570
604
  # @param parent [::String]
571
605
  # Required. Name of the parent organization, folder, or project in which to
572
- # list custom modules, specified in one of the following formats:
606
+ # list custom modules, in one of the following formats:
573
607
  #
574
608
  # * `organizations/{organization}/locations/{location}`
575
609
  # * `folders/{folder}/locations/{location}`
@@ -578,7 +612,11 @@ module Google
578
612
  # Optional. The maximum number of results to return in a single response.
579
613
  # Default is 10, minimum is 1, maximum is 1000.
580
614
  # @param page_token [::String]
581
- # Optional. A token identifying a page of results the server should return.
615
+ # Optional. A pagination token returned from a previous request. Provide this
616
+ # token to retrieve the next page of results.
617
+ #
618
+ # When paginating, the rest of the request must match the request that
619
+ # generated the page token.
582
620
  #
583
621
  # @yield [response, operation] Access the result along with the RPC operation
584
622
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule>]
@@ -644,14 +682,15 @@ module Google
644
682
  @security_center_management_stub.call_rpc :list_descendant_security_health_analytics_custom_modules, request, options: options do |response, operation|
645
683
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_descendant_security_health_analytics_custom_modules, request, response, operation, options
646
684
  yield response, operation if block_given?
647
- return response
685
+ throw :response, response
648
686
  end
649
687
  rescue ::GRPC::BadStatus => e
650
688
  raise ::Google::Cloud::Error.from_error(e)
651
689
  end
652
690
 
653
691
  ##
654
- # Retrieves a SecurityHealthAnalyticsCustomModule.
692
+ # Retrieves a
693
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}.
655
694
  #
656
695
  # @overload get_security_health_analytics_custom_module(request, options = nil)
657
696
  # Pass arguments to `get_security_health_analytics_custom_module` via a request object, either of type
@@ -669,7 +708,8 @@ module Google
669
708
  # the default parameter values, pass an empty Hash as a request object (see above).
670
709
  #
671
710
  # @param name [::String]
672
- # Required. Name of the resource
711
+ # Required. Name of the resource, in the format
712
+ # `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`.
673
713
  #
674
714
  # @yield [response, operation] Access the result along with the RPC operation
675
715
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
@@ -730,17 +770,18 @@ module Google
730
770
 
731
771
  @security_center_management_stub.call_rpc :get_security_health_analytics_custom_module, request, options: options do |response, operation|
732
772
  yield response, operation if block_given?
733
- return response
734
773
  end
735
774
  rescue ::GRPC::BadStatus => e
736
775
  raise ::Google::Cloud::Error.from_error(e)
737
776
  end
738
777
 
739
778
  ##
740
- # Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the
741
- # given CRM parent, and also creates inherited
742
- # SecurityHealthAnalyticsCustomModules for all CRM descendants of the given
743
- # parent. These modules are enabled by default.
779
+ # Creates a resident
780
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
781
+ # at the scope of the given organization, folder, or project, and also
782
+ # creates inherited `SecurityHealthAnalyticsCustomModule` resources for all
783
+ # folders and projects that are descendants of the given parent. These
784
+ # modules are enabled by default.
744
785
  #
745
786
  # @overload create_security_health_analytics_custom_module(request, options = nil)
746
787
  # Pass arguments to `create_security_health_analytics_custom_module` via a request object, either of type
@@ -759,22 +800,27 @@ module Google
759
800
  #
760
801
  # @param parent [::String]
761
802
  # Required. Name of the parent organization, folder, or project of the
762
- # module, specified in one of the following formats:
803
+ # module, in one of the following formats:
763
804
  #
764
805
  # * `organizations/{organization}/locations/{location}`
765
806
  # * `folders/{folder}/locations/{location}`
766
807
  # * `projects/{project}/locations/{location}`
767
808
  # @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
768
- # Required. The resource being created
809
+ # Required. The resource being created.
769
810
  # @param validate_only [::Boolean]
770
- # Optional. When set to true, only validations (including IAM checks) will
771
- # done for the request (no module will be created). An OK response indicates
772
- # the request is valid while an error response indicates the request is
773
- # invalid. Note that a subsequent request to actually create the module could
774
- # still fail because:
775
- # 1. the state could have changed (e.g. IAM permission lost) or
776
- # 2. A failure occurred during creation of the module.
777
- # Defaults to false.
811
+ # Optional. When set to `true`, the request will be validated (including IAM
812
+ # checks), but no module will be created. An `OK` response indicates that the
813
+ # request is valid, while an error response indicates that the request is
814
+ # invalid.
815
+ #
816
+ # If the request is valid, a subsequent request to create the module could
817
+ # still fail for one of the following reasons:
818
+ #
819
+ # * The state of your cloud resources changed; for example, you lost a
820
+ # required IAM permission
821
+ # * An error occurred during creation of the module
822
+ #
823
+ # Defaults to `false`.
778
824
  #
779
825
  # @yield [response, operation] Access the result along with the RPC operation
780
826
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
@@ -835,18 +881,19 @@ module Google
835
881
 
836
882
  @security_center_management_stub.call_rpc :create_security_health_analytics_custom_module, request, options: options do |response, operation|
837
883
  yield response, operation if block_given?
838
- return response
839
884
  end
840
885
  rescue ::GRPC::BadStatus => e
841
886
  raise ::Google::Cloud::Error.from_error(e)
842
887
  end
843
888
 
844
889
  ##
845
- # Updates the SecurityHealthAnalyticsCustomModule under the given name based
846
- # on the given update mask. Updating the enablement state is supported on
847
- # both resident and inherited modules (though resident modules cannot have an
848
- # enablement state of "inherited"). Updating the display name and custom
849
- # config of a module is supported on resident modules only.
890
+ # Updates the
891
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
892
+ # under the given name based on the given update mask. Updating the
893
+ # enablement state is supported on both resident and inherited modules
894
+ # (though resident modules cannot have an enablement state of "inherited").
895
+ # Updating the display name and custom configuration of a module is supported
896
+ # on resident modules only.
850
897
  #
851
898
  # @overload update_security_health_analytics_custom_module(request, options = nil)
852
899
  # Pass arguments to `update_security_health_analytics_custom_module` via a request object, either of type
@@ -864,20 +911,29 @@ module Google
864
911
  # the default parameter values, pass an empty Hash as a request object (see above).
865
912
  #
866
913
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
867
- # Required. The list of fields to be updated. The only fields that can be
868
- # updated are `enablement_state` and `custom_config`. If empty or set to the
869
- # wildcard value `*`, both `enablement_state` and `custom_config` are
870
- # updated.
914
+ # Required. The fields to update. The following values are valid:
915
+ #
916
+ # * `custom_config`
917
+ # * `enablement_state`
918
+ #
919
+ # If you omit this field or set it to the wildcard value `*`, then all
920
+ # eligible fields are updated.
871
921
  # @param security_health_analytics_custom_module [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule, ::Hash]
872
- # Required. The resource being updated
922
+ # Required. The resource being updated.
873
923
  # @param validate_only [::Boolean]
874
- # Optional. When set to true, only validations (including IAM checks) will
875
- # done for the request (module will not be updated). An OK response indicates
876
- # the request is valid while an error response indicates the request is
877
- # invalid. Note that a subsequent request to actually update the module could
878
- # still fail because 1. the state could have changed (e.g. IAM permission
879
- # lost) or
880
- # 2. A failure occurred while trying to update the module.
924
+ # Optional. When set to `true`, the request will be validated (including IAM
925
+ # checks), but no module will be updated. An `OK` response indicates that the
926
+ # request is valid, while an error response indicates that the request is
927
+ # invalid.
928
+ #
929
+ # If the request is valid, a subsequent request to update the module could
930
+ # still fail for one of the following reasons:
931
+ #
932
+ # * The state of your cloud resources changed; for example, you lost a
933
+ # required IAM permission
934
+ # * An error occurred during creation of the module
935
+ #
936
+ # Defaults to `false`.
881
937
  #
882
938
  # @yield [response, operation] Access the result along with the RPC operation
883
939
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule]
@@ -938,16 +994,16 @@ module Google
938
994
 
939
995
  @security_center_management_stub.call_rpc :update_security_health_analytics_custom_module, request, options: options do |response, operation|
940
996
  yield response, operation if block_given?
941
- return response
942
997
  end
943
998
  rescue ::GRPC::BadStatus => e
944
999
  raise ::Google::Cloud::Error.from_error(e)
945
1000
  end
946
1001
 
947
1002
  ##
948
- # Deletes the specified SecurityHealthAnalyticsCustomModule and all of its
949
- # descendants in the CRM hierarchy. This method is only supported for
950
- # resident custom modules.
1003
+ # Deletes the specified
1004
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
1005
+ # and all of its descendants in the resource hierarchy. This method is only
1006
+ # supported for resident custom modules.
951
1007
  #
952
1008
  # @overload delete_security_health_analytics_custom_module(request, options = nil)
953
1009
  # Pass arguments to `delete_security_health_analytics_custom_module` via a request object, either of type
@@ -965,21 +1021,26 @@ module Google
965
1021
  # the default parameter values, pass an empty Hash as a request object (see above).
966
1022
  #
967
1023
  # @param name [::String]
968
- # Required. The resource name of the SHA custom module.
969
- #
970
- # Its format is:
1024
+ # Required. The resource name of the SHA custom module, in one of the
1025
+ # following formats:
971
1026
  #
972
- # * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
973
- # * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
974
- # * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}`.
1027
+ # * `organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
1028
+ # * `folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
1029
+ # * `projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}`
975
1030
  # @param validate_only [::Boolean]
976
- # Optional. When set to true, only validations (including IAM checks) will
977
- # done for the request (module will not be deleted). An OK response indicates
978
- # the request is valid while an error response indicates the request is
979
- # invalid. Note that a subsequent request to actually delete the module could
980
- # still fail because 1. the state could have changed (e.g. IAM permission
981
- # lost) or
982
- # 2. A failure occurred while trying to delete the module.
1031
+ # Optional. When set to `true`, the request will be validated (including IAM
1032
+ # checks), but no module will be deleted. An `OK` response indicates that the
1033
+ # request is valid, while an error response indicates that the request is
1034
+ # invalid.
1035
+ #
1036
+ # If the request is valid, a subsequent request to delete the module could
1037
+ # still fail for one of the following reasons:
1038
+ #
1039
+ # * The state of your cloud resources changed; for example, you lost a
1040
+ # required IAM permission
1041
+ # * An error occurred during deletion of the module
1042
+ #
1043
+ # Defaults to `false`.
983
1044
  #
984
1045
  # @yield [response, operation] Access the result along with the RPC operation
985
1046
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1040,14 +1101,15 @@ module Google
1040
1101
 
1041
1102
  @security_center_management_stub.call_rpc :delete_security_health_analytics_custom_module, request, options: options do |response, operation|
1042
1103
  yield response, operation if block_given?
1043
- return response
1044
1104
  end
1045
1105
  rescue ::GRPC::BadStatus => e
1046
1106
  raise ::Google::Cloud::Error.from_error(e)
1047
1107
  end
1048
1108
 
1049
1109
  ##
1050
- # Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
1110
+ # Simulates the result of using a
1111
+ # {::Google::Cloud::SecurityCenterManagement::V1::SecurityHealthAnalyticsCustomModule SecurityHealthAnalyticsCustomModule}
1112
+ # to check a resource.
1051
1113
  #
1052
1114
  # @overload simulate_security_health_analytics_custom_module(request, options = nil)
1053
1115
  # Pass arguments to `simulate_security_health_analytics_custom_module` via a request object, either of type
@@ -1066,10 +1128,9 @@ module Google
1066
1128
  #
1067
1129
  # @param parent [::String]
1068
1130
  # Required. The relative resource name of the organization, project, or
1069
- # folder. For more information about relative resource names, see [Relative
1070
- # Resource
1071
- # Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name)
1072
- # Example: `organizations/{organization_id}`.
1131
+ # folder. For more information about relative resource names, see [AIP-122:
1132
+ # Resource names](https://google.aip.dev/122). Example:
1133
+ # `organizations/{organization_id}`.
1073
1134
  # @param custom_config [::Google::Cloud::SecurityCenterManagement::V1::CustomConfig, ::Hash]
1074
1135
  # Required. The custom configuration that you need to test.
1075
1136
  # @param resource [::Google::Cloud::SecurityCenterManagement::V1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource, ::Hash]
@@ -1134,7 +1195,6 @@ module Google
1134
1195
 
1135
1196
  @security_center_management_stub.call_rpc :simulate_security_health_analytics_custom_module, request, options: options do |response, operation|
1136
1197
  yield response, operation if block_given?
1137
- return response
1138
1198
  end
1139
1199
  rescue ::GRPC::BadStatus => e
1140
1200
  raise ::Google::Cloud::Error.from_error(e)
@@ -1161,16 +1221,21 @@ module Google
1161
1221
  # the default parameter values, pass an empty Hash as a request object (see above).
1162
1222
  #
1163
1223
  # @param parent [::String]
1164
- # Required. Name of parent to list effective custom modules. Its format is
1165
- # `organizations/{organization}/locations/{location}`,
1166
- # `folders/{folder}/locations/{location}`,
1167
- # or
1168
- # `projects/{project}/locations/{location}`
1224
+ # Required. Name of parent to list effective custom modules, in one of the
1225
+ # following formats:
1226
+ #
1227
+ # * `organizations/{organization}/locations/{location}`
1228
+ # * `folders/{folder}/locations/{location}`
1229
+ # * `projects/{project}/locations/{location}`
1169
1230
  # @param page_size [::Integer]
1170
1231
  # Optional. The maximum number of results to return in a single response.
1171
1232
  # Default is 10, minimum is 1, maximum is 1000.
1172
1233
  # @param page_token [::String]
1173
- # Optional. The value returned by the last call indicating a continuation
1234
+ # Optional. A pagination token returned from a previous request. Provide this
1235
+ # token to retrieve the next page of results.
1236
+ #
1237
+ # When paginating, the rest of the request must match the request that
1238
+ # generated the page token.
1174
1239
  #
1175
1240
  # @yield [response, operation] Access the result along with the RPC operation
1176
1241
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule>]
@@ -1236,20 +1301,25 @@ module Google
1236
1301
  @security_center_management_stub.call_rpc :list_effective_event_threat_detection_custom_modules, request, options: options do |response, operation|
1237
1302
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_effective_event_threat_detection_custom_modules, request, response, operation, options
1238
1303
  yield response, operation if block_given?
1239
- return response
1304
+ throw :response, response
1240
1305
  end
1241
1306
  rescue ::GRPC::BadStatus => e
1242
1307
  raise ::Google::Cloud::Error.from_error(e)
1243
1308
  end
1244
1309
 
1245
1310
  ##
1246
- # Gets an effective ETD custom module. Retrieves the effective module at the
1247
- # given level. The difference between an EffectiveCustomModule and a
1248
- # CustomModule is that the fields for an EffectiveCustomModule are computed
1249
- # from ancestors if needed. For example, the enablement_state for a
1250
- # CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the
1251
- # enablement_state for an EffectiveCustomModule is always computed to ENABLED
1252
- # or DISABLED (the effective enablement_state).
1311
+ # Gets the effective Event Threat Detection custom module at the given level.
1312
+ #
1313
+ # The difference between an
1314
+ # {::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule EffectiveEventThreatDetectionCustomModule}
1315
+ # and an
1316
+ # {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule EventThreatDetectionCustomModule}
1317
+ # is that the fields for an `EffectiveEventThreatDetectionCustomModule` are
1318
+ # computed from ancestors if needed. For example, the enablement state for an
1319
+ # `EventThreatDetectionCustomModule` can be `ENABLED`, `DISABLED`, or
1320
+ # `INHERITED`. In contrast, the enablement state for an
1321
+ # `EffectiveEventThreatDetectionCustomModule` is always computed as `ENABLED`
1322
+ # or `DISABLED`.
1253
1323
  #
1254
1324
  # @overload get_effective_event_threat_detection_custom_module(request, options = nil)
1255
1325
  # Pass arguments to `get_effective_event_threat_detection_custom_module` via a request object, either of type
@@ -1267,13 +1337,12 @@ module Google
1267
1337
  # the default parameter values, pass an empty Hash as a request object (see above).
1268
1338
  #
1269
1339
  # @param name [::String]
1270
- # Required. The resource name of the ETD custom module.
1271
- #
1272
- # Its format is:
1340
+ # Required. The resource name of the Event Threat Detection custom module, in
1341
+ # one of the following formats:
1273
1342
  #
1274
- # * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1275
- # * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1276
- # * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}`.
1343
+ # * `organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1344
+ # * `folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1345
+ # * `projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{custom_module}`
1277
1346
  #
1278
1347
  # @yield [response, operation] Access the result along with the RPC operation
1279
1348
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EffectiveEventThreatDetectionCustomModule]
@@ -1334,16 +1403,15 @@ module Google
1334
1403
 
1335
1404
  @security_center_management_stub.call_rpc :get_effective_event_threat_detection_custom_module, request, options: options do |response, operation|
1336
1405
  yield response, operation if block_given?
1337
- return response
1338
1406
  end
1339
1407
  rescue ::GRPC::BadStatus => e
1340
1408
  raise ::Google::Cloud::Error.from_error(e)
1341
1409
  end
1342
1410
 
1343
1411
  ##
1344
- # Lists all Event Threat Detection custom modules for the given
1345
- # Resource Manager parent. This includes resident modules defined at the
1346
- # scope of the parent along with modules inherited from ancestors.
1412
+ # Lists all Event Threat Detection custom modules for the given organization,
1413
+ # folder, or project. This includes resident modules defined at the scope of
1414
+ # the parent along with modules inherited from ancestors.
1347
1415
  #
1348
1416
  # @overload list_event_threat_detection_custom_modules(request, options = nil)
1349
1417
  # Pass arguments to `list_event_threat_detection_custom_modules` via a request object, either of type
@@ -1361,23 +1429,22 @@ module Google
1361
1429
  # the default parameter values, pass an empty Hash as a request object (see above).
1362
1430
  #
1363
1431
  # @param parent [::String]
1364
- # Required. Name of parent to list custom modules. Its format is
1365
- # `organizations/{organization}/locations/{location}`,
1366
- # `folders/{folder}/locations/{location}`,
1367
- # or
1368
- # `projects/{project}/locations/{location}`
1432
+ # Required. Name of parent to list custom modules, in one of the following
1433
+ # formats:
1434
+ #
1435
+ # * `organizations/{organization}/locations/{location}`
1436
+ # * `folders/{folder}/locations/{location}`
1437
+ # * `projects/{project}/locations/{location}`
1369
1438
  # @param page_size [::Integer]
1370
1439
  # Optional. The maximum number of modules to return. The service may return
1371
- # fewer than this value. If unspecified, at most 10 configs will be returned.
1440
+ # fewer than this value. If unspecified, at most 10 modules will be returned.
1372
1441
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
1373
1442
  # @param page_token [::String]
1374
- # Optional. A page token, received from a previous
1375
- # `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the
1376
- # subsequent page.
1443
+ # Optional. A pagination token returned from a previous request. Provide this
1444
+ # token to retrieve the next page of results.
1377
1445
  #
1378
- # When paginating, all other parameters provided to
1379
- # `ListEventThreatDetectionCustomModules` must match the call that provided
1380
- # the page token.
1446
+ # When paginating, the rest of the request must match the request that
1447
+ # generated the page token.
1381
1448
  #
1382
1449
  # @yield [response, operation] Access the result along with the RPC operation
1383
1450
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
@@ -1443,15 +1510,15 @@ module Google
1443
1510
  @security_center_management_stub.call_rpc :list_event_threat_detection_custom_modules, request, options: options do |response, operation|
1444
1511
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_event_threat_detection_custom_modules, request, response, operation, options
1445
1512
  yield response, operation if block_given?
1446
- return response
1513
+ throw :response, response
1447
1514
  end
1448
1515
  rescue ::GRPC::BadStatus => e
1449
1516
  raise ::Google::Cloud::Error.from_error(e)
1450
1517
  end
1451
1518
 
1452
1519
  ##
1453
- # Lists all resident Event Threat Detection custom modules under the
1454
- # given Resource Manager parent and its descendants.
1520
+ # Lists all resident Event Threat Detection custom modules for the given
1521
+ # organization, folder, or project and its descendants.
1455
1522
  #
1456
1523
  # @overload list_descendant_event_threat_detection_custom_modules(request, options = nil)
1457
1524
  # Pass arguments to `list_descendant_event_threat_detection_custom_modules` via a request object, either of type
@@ -1469,17 +1536,22 @@ module Google
1469
1536
  # the default parameter values, pass an empty Hash as a request object (see above).
1470
1537
  #
1471
1538
  # @param parent [::String]
1472
- # Required. Name of parent to list custom modules. Its format is
1473
- # `organizations/{organization}/locations/{location}`,
1474
- # `folders/{folder}/locations/{location}`,
1475
- # or
1476
- # `projects/{project}/locations/{location}`
1539
+ # Required. Name of parent to list custom modules, in one of the following
1540
+ # formats:
1541
+ #
1542
+ # * `organizations/{organization}/locations/{location}`
1543
+ # * `folders/{folder}/locations/{location}`
1544
+ # * `projects/{project}/locations/{location}`
1477
1545
  # @param page_size [::Integer]
1478
1546
  # Optional. The maximum number of modules to return. The service may return
1479
1547
  # fewer than this value. If unspecified, at most 10 configs will be returned.
1480
1548
  # The maximum value is 1000; values above 1000 will be coerced to 1000.
1481
1549
  # @param page_token [::String]
1482
- # Optional. A token identifying a page of results the server should return.
1550
+ # Optional. A pagination token returned from a previous request. Provide this
1551
+ # token to retrieve the next page of results.
1552
+ #
1553
+ # When paginating, the rest of the request must match the request that
1554
+ # generated the page token.
1483
1555
  #
1484
1556
  # @yield [response, operation] Access the result along with the RPC operation
1485
1557
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule>]
@@ -1545,7 +1617,7 @@ module Google
1545
1617
  @security_center_management_stub.call_rpc :list_descendant_event_threat_detection_custom_modules, request, options: options do |response, operation|
1546
1618
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_descendant_event_threat_detection_custom_modules, request, response, operation, options
1547
1619
  yield response, operation if block_given?
1548
- return response
1620
+ throw :response, response
1549
1621
  end
1550
1622
  rescue ::GRPC::BadStatus => e
1551
1623
  raise ::Google::Cloud::Error.from_error(e)
@@ -1570,13 +1642,12 @@ module Google
1570
1642
  # the default parameter values, pass an empty Hash as a request object (see above).
1571
1643
  #
1572
1644
  # @param name [::String]
1573
- # Required. The resource name of the ETD custom module.
1645
+ # Required. The resource name of the Event Threat Detection custom module, in
1646
+ # one of the following formats:
1574
1647
  #
1575
- # Its format is:
1576
- #
1577
- # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1578
- # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1579
- # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1648
+ # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1649
+ # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1650
+ # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1580
1651
  #
1581
1652
  # @yield [response, operation] Access the result along with the RPC operation
1582
1653
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
@@ -1637,7 +1708,6 @@ module Google
1637
1708
 
1638
1709
  @security_center_management_stub.call_rpc :get_event_threat_detection_custom_module, request, options: options do |response, operation|
1639
1710
  yield response, operation if block_given?
1640
- return response
1641
1711
  end
1642
1712
  rescue ::GRPC::BadStatus => e
1643
1713
  raise ::Google::Cloud::Error.from_error(e)
@@ -1645,9 +1715,9 @@ module Google
1645
1715
 
1646
1716
  ##
1647
1717
  # Creates a resident Event Threat Detection custom module at the scope of the
1648
- # given Resource Manager parent, and also creates inherited custom modules
1649
- # for all descendants of the given parent. These modules are enabled by
1650
- # default.
1718
+ # given organization, folder, or project, and creates inherited custom
1719
+ # modules for all descendants of the given parent. These modules are enabled
1720
+ # by default.
1651
1721
  #
1652
1722
  # @overload create_event_threat_detection_custom_module(request, options = nil)
1653
1723
  # Pass arguments to `create_event_threat_detection_custom_module` via a request object, either of type
@@ -1665,23 +1735,29 @@ module Google
1665
1735
  # the default parameter values, pass an empty Hash as a request object (see above).
1666
1736
  #
1667
1737
  # @param parent [::String]
1668
- # Required. Name of parent for the module. Its format is
1669
- # `organizations/{organization}/locations/{location}`,
1670
- # `folders/{folder}/locations/{location}`,
1671
- # or
1672
- # `projects/{project}/locations/{location}`
1738
+ # Required. Name of parent for the module, in one of the following formats:
1739
+ #
1740
+ # * `organizations/{organization}/locations/{location}`
1741
+ # * `folders/{folder}/locations/{location}`
1742
+ # * `projects/{project}/locations/{location}`
1673
1743
  # @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
1674
1744
  # Required. The module to create. The
1675
- # event_threat_detection_custom_module.name will be ignored and server
1676
- # generated.
1745
+ # {::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule#name EventThreatDetectionCustomModule.name}
1746
+ # field is ignored; Security Command Center generates the name.
1677
1747
  # @param validate_only [::Boolean]
1678
- # Optional. When set to true, only validations (including IAM checks) will
1679
- # done for the request (no module will be created). An OK response indicates
1680
- # the request is valid while an error response indicates the request is
1681
- # invalid. Note that a subsequent request to actually create the module could
1682
- # still fail because 1. the state could have changed (e.g. IAM permission
1683
- # lost) or
1684
- # 2. A failure occurred during creation of the module.
1748
+ # Optional. When set to `true`, the request will be validated (including IAM
1749
+ # checks), but no module will be created. An `OK` response indicates that the
1750
+ # request is valid, while an error response indicates that the request is
1751
+ # invalid.
1752
+ #
1753
+ # If the request is valid, a subsequent request to create the module could
1754
+ # still fail for one of the following reasons:
1755
+ #
1756
+ # * The state of your cloud resources changed; for example, you lost a
1757
+ # required IAM permission
1758
+ # * An error occurred during creation of the module
1759
+ #
1760
+ # Defaults to `false`.
1685
1761
  #
1686
1762
  # @yield [response, operation] Access the result along with the RPC operation
1687
1763
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
@@ -1742,7 +1818,6 @@ module Google
1742
1818
 
1743
1819
  @security_center_management_stub.call_rpc :create_event_threat_detection_custom_module, request, options: options do |response, operation|
1744
1820
  yield response, operation if block_given?
1745
- return response
1746
1821
  end
1747
1822
  rescue ::GRPC::BadStatus => e
1748
1823
  raise ::Google::Cloud::Error.from_error(e)
@@ -1772,21 +1847,23 @@ module Google
1772
1847
  # the default parameter values, pass an empty Hash as a request object (see above).
1773
1848
  #
1774
1849
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1775
- # Required. Field mask is used to specify the fields to be overwritten in the
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.
1850
+ # Required. The fields to update. If omitted, then all fields are updated.
1780
1851
  # @param event_threat_detection_custom_module [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule, ::Hash]
1781
- # Required. The module being updated
1852
+ # Required. The module being updated.
1782
1853
  # @param validate_only [::Boolean]
1783
- # Optional. When set to true, only validations (including IAM checks) will
1784
- # done for the request (module will not be updated). An OK response indicates
1785
- # the request is valid while an error response indicates the request is
1786
- # invalid. Note that a subsequent request to actually update the module could
1787
- # still fail because 1. the state could have changed (e.g. IAM permission
1788
- # lost) or
1789
- # 2. A failure occurred while trying to update the module.
1854
+ # Optional. When set to `true`, the request will be validated (including IAM
1855
+ # checks), but no module will be updated. An `OK` response indicates that the
1856
+ # request is valid, while an error response indicates that the request is
1857
+ # invalid.
1858
+ #
1859
+ # If the request is valid, a subsequent request to update the module could
1860
+ # still fail for one of the following reasons:
1861
+ #
1862
+ # * The state of your cloud resources changed; for example, you lost a
1863
+ # required IAM permission
1864
+ # * An error occurred during creation of the module
1865
+ #
1866
+ # Defaults to `false`.
1790
1867
  #
1791
1868
  # @yield [response, operation] Access the result along with the RPC operation
1792
1869
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::EventThreatDetectionCustomModule]
@@ -1847,7 +1924,6 @@ module Google
1847
1924
 
1848
1925
  @security_center_management_stub.call_rpc :update_event_threat_detection_custom_module, request, options: options do |response, operation|
1849
1926
  yield response, operation if block_given?
1850
- return response
1851
1927
  end
1852
1928
  rescue ::GRPC::BadStatus => e
1853
1929
  raise ::Google::Cloud::Error.from_error(e)
@@ -1855,8 +1931,8 @@ module Google
1855
1931
 
1856
1932
  ##
1857
1933
  # Deletes the specified Event Threat Detection custom module and all of its
1858
- # descendants in the Resource Manager hierarchy. This method is only
1859
- # supported for resident custom modules.
1934
+ # descendants in the resource hierarchy. This method is only supported for
1935
+ # resident custom modules.
1860
1936
  #
1861
1937
  # @overload delete_event_threat_detection_custom_module(request, options = nil)
1862
1938
  # Pass arguments to `delete_event_threat_detection_custom_module` via a request object, either of type
@@ -1874,21 +1950,26 @@ module Google
1874
1950
  # the default parameter values, pass an empty Hash as a request object (see above).
1875
1951
  #
1876
1952
  # @param name [::String]
1877
- # Required. The resource name of the ETD custom module.
1878
- #
1879
- # Its format is:
1953
+ # Required. The resource name of the Event Threat Detection custom module, in
1954
+ # one of the following formats:
1880
1955
  #
1881
- # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1882
- # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1883
- # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}`.
1956
+ # * `organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1957
+ # * `folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1958
+ # * `projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{custom_module}`
1884
1959
  # @param validate_only [::Boolean]
1885
- # Optional. When set to true, only validations (including IAM checks) will
1886
- # done for the request (module will not be deleted). An OK response indicates
1887
- # the request is valid while an error response indicates the request is
1888
- # invalid. Note that a subsequent request to actually delete the module could
1889
- # still fail because 1. the state could have changed (e.g. IAM permission
1890
- # lost) or
1891
- # 2. A failure occurred while trying to delete the module.
1960
+ # Optional. When set to `true`, the request will be validated (including IAM
1961
+ # checks), but no module will be deleted. An `OK` response indicates that the
1962
+ # request is valid, while an error response indicates that the request is
1963
+ # invalid.
1964
+ #
1965
+ # If the request is valid, a subsequent request to delete the module could
1966
+ # still fail for one of the following reasons:
1967
+ #
1968
+ # * The state of your cloud resources changed; for example, you lost a
1969
+ # required IAM permission
1970
+ # * An error occurred during creation of the module
1971
+ #
1972
+ # Defaults to `false`.
1892
1973
  #
1893
1974
  # @yield [response, operation] Access the result along with the RPC operation
1894
1975
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -1949,7 +2030,6 @@ module Google
1949
2030
 
1950
2031
  @security_center_management_stub.call_rpc :delete_event_threat_detection_custom_module, request, options: options do |response, operation|
1951
2032
  yield response, operation if block_given?
1952
- return response
1953
2033
  end
1954
2034
  rescue ::GRPC::BadStatus => e
1955
2035
  raise ::Google::Cloud::Error.from_error(e)
@@ -1974,16 +2054,15 @@ module Google
1974
2054
  # the default parameter values, pass an empty Hash as a request object (see above).
1975
2055
  #
1976
2056
  # @param parent [::String]
1977
- # Required. Resource name of the parent to validate the Custom Module under.
1978
- #
1979
- # Its format is:
2057
+ # Required. Resource name of the parent to validate the custom modules under,
2058
+ # in one of the following formats:
1980
2059
  #
1981
- # * `organizations/{organization}/locations/{location}`.
2060
+ # * `organizations/{organization}/locations/{location}`
1982
2061
  # @param raw_text [::String]
1983
2062
  # Required. The raw text of the module's contents. Used to generate error
1984
2063
  # messages.
1985
2064
  # @param type [::String]
1986
- # Required. The type of the module (e.g. CONFIGURABLE_BAD_IP).
2065
+ # Required. The type of the module. For example, `CONFIGURABLE_BAD_IP`.
1987
2066
  #
1988
2067
  # @yield [response, operation] Access the result along with the RPC operation
1989
2068
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::ValidateEventThreatDetectionCustomModuleResponse]
@@ -2044,7 +2123,6 @@ module Google
2044
2123
 
2045
2124
  @security_center_management_stub.call_rpc :validate_event_threat_detection_custom_module, request, options: options do |response, operation|
2046
2125
  yield response, operation if block_given?
2047
- return response
2048
2126
  end
2049
2127
  rescue ::GRPC::BadStatus => e
2050
2128
  raise ::Google::Cloud::Error.from_error(e)
@@ -2069,24 +2147,23 @@ module Google
2069
2147
  # the default parameter values, pass an empty Hash as a request object (see above).
2070
2148
  #
2071
2149
  # @param name [::String]
2072
- # Required. The Security Command Center service to retrieve.
2073
- #
2074
- # Formats:
2150
+ # Required. The Security Command Center service to retrieve, in one of the
2151
+ # following formats:
2075
2152
  #
2076
- # * organizations/\\{organization}/locations/\\{location}/securityCenterServices/\\{service}
2077
- # * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
2078
- # * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
2153
+ # * organizations/\\{organization}/locations/\\{location}/securityCenterServices/\\{service}
2154
+ # * folders/\\{folder}/locations/\\{location}/securityCenterServices/\\{service}
2155
+ # * projects/\\{project}/locations/\\{location}/securityCenterServices/\\{service}
2079
2156
  #
2080
- # The possible values for id \\{service} are:
2157
+ # The following values are valid for `{service}`:
2081
2158
  #
2082
- # * container-threat-detection
2083
- # * event-threat-detection
2084
- # * security-health-analytics
2085
- # * vm-threat-detection
2086
- # * web-security-scanner
2159
+ # * `container-threat-detection`
2160
+ # * `event-threat-detection`
2161
+ # * `security-health-analytics`
2162
+ # * `vm-threat-detection`
2163
+ # * `web-security-scanner`
2087
2164
  # @param show_eligible_modules_only [::Boolean]
2088
- # Flag that, when set, will be used to filter the ModuleSettings that are
2089
- # in scope. The default setting is that all modules will be shown.
2165
+ # Set to `true` to show only modules that are in scope. By default, all
2166
+ # modules are shown.
2090
2167
  #
2091
2168
  # @yield [response, operation] Access the result along with the RPC operation
2092
2169
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
@@ -2147,7 +2224,6 @@ module Google
2147
2224
 
2148
2225
  @security_center_management_stub.call_rpc :get_security_center_service, request, options: options do |response, operation|
2149
2226
  yield response, operation if block_given?
2150
- return response
2151
2227
  end
2152
2228
  rescue ::GRPC::BadStatus => e
2153
2229
  raise ::Google::Cloud::Error.from_error(e)
@@ -2173,21 +2249,24 @@ module Google
2173
2249
  # the default parameter values, pass an empty Hash as a request object (see above).
2174
2250
  #
2175
2251
  # @param parent [::String]
2176
- # Required. The name of the parent to list Security Command Center services.
2252
+ # Required. The name of the parent to list Security Command Center services,
2253
+ # in one of the following formats:
2177
2254
  #
2178
- # Formats:
2179
- #
2180
- # * organizations/\\{organization}/locations/\\{location}
2181
- # * folders/\\{folder}/locations/\\{location}
2182
- # * projects/\\{project}/locations/\\{location}
2255
+ # * `organizations/{organization}/locations/{location}`
2256
+ # * `folders/{folder}/locations/{location}`
2257
+ # * `projects/{project}/locations/{location}`
2183
2258
  # @param page_size [::Integer]
2184
2259
  # Optional. The maximum number of results to return in a single response.
2185
2260
  # Default is 10, minimum is 1, maximum is 1000.
2186
2261
  # @param page_token [::String]
2187
- # Optional. The value returned by the last call indicating a continuation.
2262
+ # Optional. A pagination token returned from a previous request. Provide this
2263
+ # token to retrieve the next page of results.
2264
+ #
2265
+ # When paginating, the rest of the request must match the request that
2266
+ # generated the page token.
2188
2267
  # @param show_eligible_modules_only [::Boolean]
2189
- # Flag that, when set, will be used to filter the ModuleSettings that are
2190
- # in scope. The default setting is that all modules will be shown.
2268
+ # Flag that, when set, is used to filter the module settings that are shown.
2269
+ # The default setting is that all modules are shown.
2191
2270
  #
2192
2271
  # @yield [response, operation] Access the result along with the RPC operation
2193
2272
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService>]
@@ -2253,7 +2332,7 @@ module Google
2253
2332
  @security_center_management_stub.call_rpc :list_security_center_services, request, options: options do |response, operation|
2254
2333
  response = ::Gapic::PagedEnumerable.new @security_center_management_stub, :list_security_center_services, request, response, operation, options
2255
2334
  yield response, operation if block_given?
2256
- return response
2335
+ throw :response, response
2257
2336
  end
2258
2337
  rescue ::GRPC::BadStatus => e
2259
2338
  raise ::Google::Cloud::Error.from_error(e)
@@ -2280,18 +2359,26 @@ module Google
2280
2359
  # @param security_center_service [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService, ::Hash]
2281
2360
  # Required. The updated service.
2282
2361
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2283
- # Required. The list of fields to be updated. Possible values:
2362
+ # Required. The fields to update. Accepts the following values:
2284
2363
  #
2285
- # * "intended_enablement_state"
2286
- # * "modules"
2364
+ # * `intended_enablement_state`
2365
+ # * `modules`
2366
+ #
2367
+ # If omitted, then all eligible fields are updated.
2287
2368
  # @param validate_only [::Boolean]
2288
- # Optional. When set to true, only validations (including IAM checks) will be
2289
- # done for the request (service will not be updated). An OK response
2290
- # indicates that the request is valid, while an error response indicates that
2291
- # the request is invalid. Note that a subsequent request to actually update
2292
- # the service could still fail for one of the following reasons:
2293
- # - The state could have changed (e.g. IAM permission lost).
2294
- # - A failure occurred while trying to delete the module.
2369
+ # Optional. When set to `true`, the request will be validated (including IAM
2370
+ # checks), but no service will be updated. An `OK` response indicates that
2371
+ # the request is valid, while an error response indicates that the request is
2372
+ # invalid.
2373
+ #
2374
+ # If the request is valid, a subsequent request to update the service could
2375
+ # still fail for one of the following reasons:
2376
+ #
2377
+ # * The state of your cloud resources changed; for example, you lost a
2378
+ # required IAM permission
2379
+ # * An error occurred during update of the service
2380
+ #
2381
+ # Defaults to `false`.
2295
2382
  #
2296
2383
  # @yield [response, operation] Access the result along with the RPC operation
2297
2384
  # @yieldparam response [::Google::Cloud::SecurityCenterManagement::V1::SecurityCenterService]
@@ -2352,7 +2439,6 @@ module Google
2352
2439
 
2353
2440
  @security_center_management_stub.call_rpc :update_security_center_service, request, options: options do |response, operation|
2354
2441
  yield response, operation if block_given?
2355
- return response
2356
2442
  end
2357
2443
  rescue ::GRPC::BadStatus => e
2358
2444
  raise ::Google::Cloud::Error.from_error(e)
@@ -2441,6 +2527,11 @@ module Google
2441
2527
  # default endpoint URL. The default value of nil uses the environment
2442
2528
  # universe (usually the default "googleapis.com" universe).
2443
2529
  # @return [::String,nil]
2530
+ # @!attribute [rw] logger
2531
+ # A custom logger to use for request/response debug logging, or the value
2532
+ # `:default` (the default) to construct a default logger, or `nil` to
2533
+ # explicitly disable logging.
2534
+ # @return [::Logger,:default,nil]
2444
2535
  #
2445
2536
  class Configuration
2446
2537
  extend ::Gapic::Config
@@ -2465,6 +2556,7 @@ module Google
2465
2556
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2466
2557
  config_attr :quota_project, nil, ::String, nil
2467
2558
  config_attr :universe_domain, nil, ::String, nil
2559
+ config_attr :logger, :default, ::Logger, nil, :default
2468
2560
 
2469
2561
  # @private
2470
2562
  def initialize parent_config = nil