google-cloud-cloud_security_compliance-v1 0.1.0 → 0.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.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +4 -4
  3. data/README.md +4 -4
  4. data/lib/google/cloud/cloud_security_compliance/v1/audit/client.rb +859 -0
  5. data/lib/google/cloud/cloud_security_compliance/v1/audit/credentials.rb +47 -0
  6. data/lib/google/cloud/cloud_security_compliance/v1/audit/operations.rb +841 -0
  7. data/lib/google/cloud/cloud_security_compliance/v1/audit/paths.rb +110 -0
  8. data/lib/google/cloud/cloud_security_compliance/v1/audit/rest/client.rb +796 -0
  9. data/lib/google/cloud/cloud_security_compliance/v1/audit/rest/operations.rb +925 -0
  10. data/lib/google/cloud/cloud_security_compliance/v1/audit/rest/service_stub.rb +387 -0
  11. data/lib/google/cloud/cloud_security_compliance/v1/audit/rest.rb +54 -0
  12. data/lib/google/cloud/cloud_security_compliance/v1/audit.rb +56 -0
  13. data/lib/google/cloud/cloud_security_compliance/v1/bindings_override.rb +1 -1
  14. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/client.rb +608 -0
  15. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/credentials.rb +47 -0
  16. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/paths.rb +72 -0
  17. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/rest/client.rb +559 -0
  18. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/rest/service_stub.rb +234 -0
  19. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service/rest.rb +54 -0
  20. data/lib/google/cloud/cloud_security_compliance/v1/cm_enrollment_service.rb +56 -0
  21. data/lib/google/cloud/cloud_security_compliance/v1/config/client.rb +133 -102
  22. data/lib/google/cloud/cloud_security_compliance/v1/config/rest/client.rb +113 -99
  23. data/lib/google/cloud/cloud_security_compliance/v1/deployment/client.rb +80 -41
  24. data/lib/google/cloud/cloud_security_compliance/v1/deployment/operations.rb +20 -3
  25. data/lib/google/cloud/cloud_security_compliance/v1/deployment/rest/client.rb +60 -38
  26. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/client.rb +940 -0
  27. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/credentials.rb +47 -0
  28. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/paths.rb +142 -0
  29. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/rest/client.rb +870 -0
  30. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/rest/service_stub.rb +456 -0
  31. data/lib/google/cloud/cloud_security_compliance/v1/monitoring/rest.rb +53 -0
  32. data/lib/google/cloud/cloud_security_compliance/v1/monitoring.rb +55 -0
  33. data/lib/google/cloud/cloud_security_compliance/v1/rest.rb +4 -1
  34. data/lib/google/cloud/cloud_security_compliance/v1/version.rb +1 -1
  35. data/lib/google/cloud/cloud_security_compliance/v1.rb +5 -2
  36. data/lib/google/cloud/cloudsecuritycompliance/v1/audit_pb.rb +70 -0
  37. data/lib/google/cloud/cloudsecuritycompliance/v1/audit_services_pb.rb +51 -0
  38. data/lib/google/cloud/cloudsecuritycompliance/v1/cm_enrollment_service_pb.rb +54 -0
  39. data/lib/google/cloud/cloudsecuritycompliance/v1/cm_enrollment_service_services_pb.rb +54 -0
  40. data/lib/google/cloud/cloudsecuritycompliance/v1/common_pb.rb +4 -1
  41. data/lib/google/cloud/cloudsecuritycompliance/v1/config_pb.rb +1 -1
  42. data/lib/google/cloud/cloudsecuritycompliance/v1/config_services_pb.rb +58 -55
  43. data/lib/google/cloud/cloudsecuritycompliance/v1/deployment_services_pb.rb +9 -6
  44. data/lib/google/cloud/cloudsecuritycompliance/v1/monitoring_pb.rb +74 -0
  45. data/lib/google/cloud/cloudsecuritycompliance/v1/monitoring_services_pb.rb +53 -0
  46. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/audit.rb +413 -0
  47. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/cm_enrollment_service.rb +108 -0
  48. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb +210 -181
  49. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/config.rb +69 -57
  50. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/deployment.rb +180 -139
  51. data/proto_docs/google/cloud/cloudsecuritycompliance/v1/monitoring.rb +527 -0
  52. data/proto_docs/google/type/interval.rb +45 -0
  53. metadata +34 -1
@@ -227,9 +227,10 @@ module Google
227
227
  # Service calls
228
228
 
229
229
  ##
230
- # Lists all Frameworks (both Built-in and Custom) available within a given
231
- # parent resource. This method supports pagination.
232
- # The latest major version of each Framework is returned.
230
+ # Lists the frameworks (both built-in and custom) that are available within
231
+ # the parent resource. The latest major version of each framework is
232
+ # returned.
233
+ # This method supports pagination.
233
234
  #
234
235
  # @overload list_frameworks(request, options = nil)
235
236
  # Pass arguments to `list_frameworks` via a request object, either of type
@@ -249,7 +250,7 @@ module Google
249
250
  # @param parent [::String]
250
251
  # Required. The parent resource name, in the format
251
252
  # `organizations/{organization}/locations/{location}`.
252
- # Only global location is supported.
253
+ # The only supported location is `global`.
253
254
  # @param page_size [::Integer]
254
255
  # Optional. The maximum number of frameworks to return. The default value is
255
256
  # `500`.
@@ -324,13 +325,11 @@ module Google
324
325
  end
325
326
 
326
327
  ##
327
- # Gets details of a single Framework.
328
- # This method retrieves a Framework resource, which can be either Built-in or
329
- # Custom, identified by its name.
328
+ # Gets details about a framework.
329
+ # This method retrieves the latest major version of the framework.
330
330
  #
331
- # By default, the latest major version of the Framework is returned.
332
- # A specific major version can be retrieved by specifying the
333
- # `major_revision_id` in the request.
331
+ # To retrieve a specific major version, include `major_revision_id` in
332
+ # the request.
334
333
  #
335
334
  # @overload get_framework(request, options = nil)
336
335
  # Pass arguments to `get_framework` via a request object, either of type
@@ -348,12 +347,12 @@ module Google
348
347
  # the default parameter values, pass an empty Hash as a request object (see above).
349
348
  #
350
349
  # @param name [::String]
351
- # Required. The name of the framework to retrieve.
352
- # Format:
353
- # organizations/\\{organization}/locations/\\{location}/frameworks/\\{framework_id}
350
+ # Required. The name of the framework to retrieve, in the format
351
+ # `organizations/{organization}/locations/{location}/frameworks/{framework_id}`
352
+ # The only supported location is `global`.
354
353
  # @param major_revision_id [::Integer]
355
- # Optional. The Framework major version to retrieve. If not specified, the
356
- # most recently updated revision_id is retrieved.
354
+ # Optional. The framework major version to retrieve. If not specified, the
355
+ # most recently updated `revision_id` is retrieved.
357
356
  # @yield [result, operation] Access the result along with the TransportOperation object
358
357
  # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::Framework]
359
358
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -413,9 +412,9 @@ module Google
413
412
  end
414
413
 
415
414
  ##
416
- # Creates a new Framework with type `Custom` under a given parent resource.
417
- # Frameworks with type `Built-in` are managed by Google and cannot be created
418
- # through this API.
415
+ # Creates a custom framework in a given parent resource.
416
+ # You can't create built-in frameworks because those are managed by
417
+ # Google.
419
418
  #
420
419
  # @overload create_framework(request, options = nil)
421
420
  # Pass arguments to `create_framework` via a request object, either of type
@@ -435,12 +434,12 @@ module Google
435
434
  # @param parent [::String]
436
435
  # Required. The parent resource name, in the format
437
436
  # `organizations/{organization}/locations/{location}`.
437
+ # The only supported location is `global`.
438
438
  # @param framework_id [::String]
439
- # Required. ID of the framework.
440
- # This is not the full name of the framework.
441
- # This is the last part of the full name of the framework.
439
+ # Required. The identifier (ID) of the framework. The ID is not the full name
440
+ # of the framework; it's the last part of the full name of the framework.
442
441
  # @param framework [::Google::Cloud::CloudSecurityCompliance::V1::Framework, ::Hash]
443
- # Required. The resource being created
442
+ # Required. The resource being created.
444
443
  # @yield [result, operation] Access the result along with the TransportOperation object
445
444
  # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::Framework]
446
445
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -500,17 +499,18 @@ module Google
500
499
  end
501
500
 
502
501
  ##
503
- # Updates a single Framework.
504
- # This method allows for partial updates of a Framework resource. The fields
505
- # to be updated are specified using the `update_mask`.
502
+ # Updates a custom framework.
503
+ # This method allows for partial updates of a framework. Use the
504
+ # `update_mask` to specify which fields to update. Consider the following:
506
505
  #
507
- # - If an `update_mask` is provided, only the fields specified in the mask
508
- # will be updated.
509
- # - If no `update_mask` is provided, all fields present in the request's
510
- # `framework` body will be used to overwrite the existing resource.
506
+ # - If you provide an `update_mask`, only the fields that are specified
507
+ # in the mask are updated.
508
+ # - If you don't provide an `update_mask`, all the fields that are present
509
+ # in the request's `framework` body are used to overwrite the existing
510
+ # resource.
511
511
  #
512
- # This operation can only be performed on Frameworks with type `CUSTOM`.
513
- # A successful update will result in a new version of the Framework.
512
+ # You can only update frameworks with the `CUSTOM` type.
513
+ # A successful update creates a new version of the framework.
514
514
  #
515
515
  # @overload update_framework(request, options = nil)
516
516
  # Pass arguments to `update_framework` via a request object, either of type
@@ -528,14 +528,13 @@ module Google
528
528
  # the default parameter values, pass an empty Hash as a request object (see above).
529
529
  #
530
530
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
531
- # Optional. Field mask is used to specify the fields to be overwritten in the
532
- # Framework resource by the update.
533
- # The fields specified in the update_mask are relative to the resource, not
534
- # the full request. A field will be overwritten if it is in the mask. If the
535
- # user does not provide a mask then all fields present in the request will be
536
- # overwritten.
531
+ # Optional. A field mask is used to specify the fields to be overwritten in
532
+ # the framework resource by the update. The fields specified in the
533
+ # `update_mask` are relative to the resource, not the full request. A field
534
+ # is overwritten if it is in the mask. If you don't provide a mask then all
535
+ # fields present in the request will be overwritten.
537
536
  # @param framework [::Google::Cloud::CloudSecurityCompliance::V1::Framework, ::Hash]
538
- # Required. The resource being updated
537
+ # Required. The resource that is being updated.
539
538
  # @param major_revision_id [::Integer]
540
539
  # Optional. The major version ID of the framework to update.
541
540
  # @yield [result, operation] Access the result along with the TransportOperation object
@@ -597,14 +596,13 @@ module Google
597
596
  end
598
597
 
599
598
  ##
600
- # Deletes a single Custom Framework, including all its minor and
601
- # minor revisions.
599
+ # Deletes a custom framework, including all its major and
600
+ # minor revisions. Consider the following:
602
601
  #
603
- # - This operation can only be performed on Frameworks with type `CUSTOM`.
604
- # Built-in Frameworks cannot be deleted.
605
- # - The Framework cannot be deleted if it is currently deployed on any
606
- # resource.
607
- # - This action is permanent and cannot be undone.
602
+ # - You can't delete built-in frameworks. You can only delete frameworks
603
+ # with type `CUSTOM`.
604
+ # - You can't delete frameworks that are deployed to a resource.
605
+ # - You can't restore a deleted framework. This action is permanent.
608
606
  #
609
607
  # @overload delete_framework(request, options = nil)
610
608
  # Pass arguments to `delete_framework` via a request object, either of type
@@ -622,8 +620,9 @@ module Google
622
620
  # the default parameter values, pass an empty Hash as a request object (see above).
623
621
  #
624
622
  # @param name [::String]
625
- # Required. Name of the resource, in the format
623
+ # Required. The name of the resource, in the format
626
624
  # `organizations/{organization}/locations/{location}/frameworks/{framework}`.
625
+ # The only supported location is `global`.
627
626
  # @yield [result, operation] Access the result along with the TransportOperation object
628
627
  # @yieldparam result [::Google::Protobuf::Empty]
629
628
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -683,9 +682,10 @@ module Google
683
682
  end
684
683
 
685
684
  ##
686
- # Lists all CloudControls (both Built-in and Custom) available within a given
687
- # parent resource. This method supports pagination.
688
- # The latest major version of each CloudControl is returned.
685
+ # Lists the cloud controls (both built-in and custom) that are available
686
+ # in a given parent resource. The latest major version of each cloud control
687
+ # is returned.
688
+ # This method supports pagination.
689
689
  #
690
690
  # @overload list_cloud_controls(request, options = nil)
691
691
  # Pass arguments to `list_cloud_controls` via a request object, either of type
@@ -705,19 +705,21 @@ module Google
705
705
  # @param parent [::String]
706
706
  # Required. The parent resource name, in the format
707
707
  # `organizations/{organization}/locations/{location}`.
708
+ # The only supported location is `global`.
708
709
  # @param page_size [::Integer]
709
- # Optional. The maximum number of CloudControls to return. The default value
710
+ # Optional. The maximum number of cloud controls to return. The default value
710
711
  # is `500`.
711
712
  #
712
713
  # If you exceed the maximum value of `1000`, then the service uses the
713
714
  # maximum value.
714
715
  # @param page_token [::String]
715
- # Optional. A pagination token returned from a previous request to list
716
- # CloudControls. Provide this token to retrieve the next page of results.
716
+ # Optional. A pagination token that's returned from a previous request to
717
+ # list cloud controls. Provide this token to retrieve the next page of
718
+ # results.
717
719
  #
718
- # When paginating, parent provided to
719
- # ListCloudControls request must match the call that provided the page
720
- # token.
720
+ # When paginating, the parent that you provide to the
721
+ # {::Google::Cloud::CloudSecurityCompliance::V1::Config::Rest::Client#list_cloud_controls ListCloudControls}
722
+ # request must match the call that provided the page token.
721
723
  # @yield [result, operation] Access the result along with the TransportOperation object
722
724
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControl>]
723
725
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -783,13 +785,13 @@ module Google
783
785
  end
784
786
 
785
787
  ##
786
- # Gets details of a single CloudControl.
787
- # This method retrieves a CloudControl resource, which can be either Built-in
788
- # or Custom, identified by its name.
788
+ # Gets details about a cloud control.
789
+ # This method retrieves the latest major version of a cloud control that
790
+ # you identify by name.
789
791
  #
790
- # By default, the latest major version of the CloudControl is returned.
791
- # A specific major version can be retrieved by specifying the
792
- # `major_revision_id` in the request.
792
+ # By default, the latest major version of the cloud control is returned.
793
+ # To retrieve a specific major version, include `major_revision_id` in
794
+ # the request.
793
795
  #
794
796
  # @overload get_cloud_control(request, options = nil)
795
797
  # Pass arguments to `get_cloud_control` via a request object, either of type
@@ -801,14 +803,18 @@ module Google
801
803
  # @param options [::Gapic::CallOptions, ::Hash]
802
804
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
803
805
  #
804
- # @overload get_cloud_control(name: nil)
806
+ # @overload get_cloud_control(name: nil, major_revision_id: nil)
805
807
  # Pass arguments to `get_cloud_control` via keyword arguments. Note that at
806
808
  # least one keyword argument is required. To specify no parameters, or to keep all
807
809
  # the default parameter values, pass an empty Hash as a request object (see above).
808
810
  #
809
811
  # @param name [::String]
810
- # Required. The name of the cloudcontrol to retrieve in the format:
811
- # organizations/\\{organization}/locations/\\{location}/cloudControls/\\{cloud_control}
812
+ # Required. The name of the cloud control to retrieve, in the format
813
+ # `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`.
814
+ # The only supported location is `global`.
815
+ # @param major_revision_id [::Integer]
816
+ # Optional. The major version of the cloud control to retrieve. If not
817
+ # specified, the most recently updated `revision_id` is retrieved.
812
818
  # @yield [result, operation] Access the result along with the TransportOperation object
813
819
  # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::CloudControl]
814
820
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -868,9 +874,10 @@ module Google
868
874
  end
869
875
 
870
876
  ##
871
- # Creates a new CloudControl with type `Custom` under a given parent
872
- # resource. `Built-in` CloudControls are managed by Google and cannot be
873
- # created through this API.
877
+ # Creates a custom cloud control in a given parent
878
+ # resource.
879
+ # You can't create built-in cloud controls because those are managed by
880
+ # Google.
874
881
  #
875
882
  # @overload create_cloud_control(request, options = nil)
876
883
  # Pass arguments to `create_cloud_control` via a request object, either of type
@@ -890,12 +897,13 @@ module Google
890
897
  # @param parent [::String]
891
898
  # Required. The parent resource name, in the format
892
899
  # `organizations/{organization}/locations/{location}`.
900
+ # The only supported location is `global`.
893
901
  # @param cloud_control_id [::String]
894
- # Required. ID of the CloudControl.
895
- # This is the last segment of the CloudControl resource name.
896
- # Format: `^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$`.
902
+ # Required. The identifier for the cloud control, which is the last segment
903
+ # of the cloud control name. The format is
904
+ # `^[a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$`.
897
905
  # @param cloud_control [::Google::Cloud::CloudSecurityCompliance::V1::CloudControl, ::Hash]
898
- # Required. The resource being created
906
+ # Required. The cloud control that's being created.
899
907
  # @yield [result, operation] Access the result along with the TransportOperation object
900
908
  # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::CloudControl]
901
909
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -955,16 +963,18 @@ module Google
955
963
  end
956
964
 
957
965
  ##
958
- # Updates a single CloudControl.
959
- # This method allows for partial updates of a Custom CloudControl resource.
960
- # Built-in CloudControls cannot be updated.
966
+ # Updates a custom cloud control.
967
+ # This method allows for partial updates of a cloud control. Use the
968
+ # `update_mask` to specify which fields to update. Consider the following:
961
969
  #
962
- # - If an `update_mask` is provided, only the fields specified in the mask
963
- # will be updated.
964
- # - If no `update_mask` is provided, all fields present in the request's
965
- # `cloud_control` body will be used to overwrite the existing resource.
970
+ # - If you provide an `update_mask`, only the fields that are specified
971
+ # in the mask are updated.
972
+ # - If you don't provide an `update_mask`, all the fields that are present
973
+ # in the request's `cloud_control` body are used to overwrite the existing
974
+ # resource.
966
975
  #
967
- # A successful update will result in a new version of the CloudControl.
976
+ # You can only update cloud controls with the `CUSTOM` type.
977
+ # A successful update creates a new version of the cloud control.
968
978
  #
969
979
  # @overload update_cloud_control(request, options = nil)
970
980
  # Pass arguments to `update_cloud_control` via a request object, either of type
@@ -982,19 +992,22 @@ module Google
982
992
  # the default parameter values, pass an empty Hash as a request object (see above).
983
993
  #
984
994
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
985
- # Optional. Field mask is used to specify the fields to be overwritten in the
986
- # CloudControl resource by the update.
987
- # The fields specified in the update_mask are relative to the resource, not
988
- # the full request. A field will be overwritten if it is in the mask. If the
989
- # user does not provide a mask then all fields present in the request will be
990
- # overwritten. The fields that can be updated are:
991
- # 1. Display_name
992
- # 2. Description
993
- # 3. Parameters
994
- # 4. Rules
995
- # 5. ParameterSpec.
995
+ # Optional. Use a field mask to specify the fields to be overwritten in the
996
+ # cloud control during the update.
997
+ # The fields that you specify in the `update_mask` are relative to the
998
+ # cloud control, not the full request. A field is overwritten if it is in
999
+ # the mask. If you don't provide a mask, all fields in the request
1000
+ # are updated.
1001
+ #
1002
+ # You can update the following fields:
1003
+ #
1004
+ # - Display name
1005
+ # - Description
1006
+ # - Parameters
1007
+ # - Rules
1008
+ # - Parameter specification
996
1009
  # @param cloud_control [::Google::Cloud::CloudSecurityCompliance::V1::CloudControl, ::Hash]
997
- # Required. The resource being updated
1010
+ # Required. The cloud control that you're updating.
998
1011
  # @yield [result, operation] Access the result along with the TransportOperation object
999
1012
  # @yieldparam result [::Google::Cloud::CloudSecurityCompliance::V1::CloudControl]
1000
1013
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1054,14 +1067,14 @@ module Google
1054
1067
  end
1055
1068
 
1056
1069
  ##
1057
- # Deletes a single Custom CloudControl, including all its
1058
- # major and minor revisions.
1070
+ # Deletes a custom cloud control, including all its
1071
+ # major and minor revisions. Consider the following:
1059
1072
  #
1060
- # - This operation can only be performed on CloudControls with type `CUSTOM`.
1061
- # Built-in CloudControls cannot be deleted.
1062
- # - The CloudControl cannot be deleted if any of its revisions are currently
1063
- # referenced by any Framework.
1064
- # - This action is permanent and cannot be undone.
1073
+ # - You can't delete built-in cloud controls. You can only delete cloud
1074
+ # controls with type `CUSTOM`.
1075
+ # - You can't delete cloud controls if any of the versions are referenced
1076
+ # by a framework.
1077
+ # - You can't restore a deleted cloud control. This action is permanent.
1065
1078
  #
1066
1079
  # @overload delete_cloud_control(request, options = nil)
1067
1080
  # Pass arguments to `delete_cloud_control` via a request object, either of type
@@ -1079,8 +1092,9 @@ module Google
1079
1092
  # the default parameter values, pass an empty Hash as a request object (see above).
1080
1093
  #
1081
1094
  # @param name [::String]
1082
- # Required. Name of the resource, in the format
1095
+ # Required. The name of the cloud control to delete, in the format
1083
1096
  # `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`.
1097
+ # The only supported location is `global`.
1084
1098
  # @yield [result, operation] Access the result along with the TransportOperation object
1085
1099
  # @yieldparam result [::Google::Protobuf::Empty]
1086
1100
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -239,7 +239,10 @@ module Google
239
239
  # Service calls
240
240
 
241
241
  ##
242
- # Creates a new FrameworkDeployment in a given parent resource.
242
+ # Creates a framework deployment in a given parent resource. A
243
+ # framework deployment lets you assign a particular framework version to an
244
+ # organization, folder, or project so that you can control and monitor
245
+ # those resources using the framework's cloud controls.
243
246
  #
244
247
  # @overload create_framework_deployment(request, options = nil)
245
248
  # Pass arguments to `create_framework_deployment` via a request object, either of type
@@ -257,15 +260,15 @@ module Google
257
260
  # the default parameter values, pass an empty Hash as a request object (see above).
258
261
  #
259
262
  # @param parent [::String]
260
- # Required. The parent resource of the FrameworkDeployment in the format:
261
- # organizations/\\{organization}/locations/\\{location}
262
- # Only global location is supported.
263
+ # Required. The parent resource of the framework deployment in the format
264
+ # `organizations/{organization}/locations/{location}`.
265
+ # Only the global location is supported.
263
266
  # @param framework_deployment_id [::String]
264
- # Optional. User provided identifier. It should be unique in scope of a
265
- # parent. This is optional and if not provided, a random UUID will be
267
+ # Optional. An identifier for the framework deployment that's unique in scope
268
+ # of the parent. If you don't specify a value, then a random UUID is
266
269
  # generated.
267
270
  # @param framework_deployment [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment, ::Hash]
268
- # Required. The FrameworkDeployment to be created.
271
+ # Required. The framework deployment that you're creating.
269
272
  #
270
273
  # @yield [response, operation] Access the result along with the RPC operation
271
274
  # @yieldparam response [::Gapic::Operation]
@@ -341,7 +344,7 @@ module Google
341
344
  end
342
345
 
343
346
  ##
344
- # Deletes a single FrameworkDeployment.
347
+ # Deletes a framework deployment.
345
348
  #
346
349
  # @overload delete_framework_deployment(request, options = nil)
347
350
  # Pass arguments to `delete_framework_deployment` via a request object, either of type
@@ -359,15 +362,16 @@ module Google
359
362
  # the default parameter values, pass an empty Hash as a request object (see above).
360
363
  #
361
364
  # @param name [::String]
362
- # Required. name of the FrameworkDeployment to be deleted in the following
363
- # format:
364
- # organizations/\\{organization}/locations/\\{location}/frameworkDeployments/\\{framework_deployment_id}
365
+ # Required. The name of the framework deployment that you want to delete,
366
+ # in the format
367
+ # `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
368
+ # The only supported location is `global`.
365
369
  # @param etag [::String]
366
370
  # Optional. An opaque identifier for the current version of the resource.
367
371
  #
368
372
  # If you provide this value, then it must match the existing value. If the
369
373
  # values don't match, then the request fails with an
370
- # [ABORTED][google.rpc.Code.ABORTED] error.
374
+ # [`ABORTED`][google.rpc.Code.ABORTED] error.
371
375
  #
372
376
  # If you omit this value, then the resource is deleted regardless of its
373
377
  # current `etag` value.
@@ -446,7 +450,7 @@ module Google
446
450
  end
447
451
 
448
452
  ##
449
- # Gets details of a single FrameworkDeployment.
453
+ # Gets details about a framework deployment.
450
454
  #
451
455
  # @overload get_framework_deployment(request, options = nil)
452
456
  # Pass arguments to `get_framework_deployment` via a request object, either of type
@@ -464,8 +468,9 @@ module Google
464
468
  # the default parameter values, pass an empty Hash as a request object (see above).
465
469
  #
466
470
  # @param name [::String]
467
- # Required. FrameworkDeployment name in the following format:
468
- # organizations/\\{organization}/locations/\\{location}/frameworkDeployments/\\{framework_deployment_id}
471
+ # Required. The name of the framework deployment, in the format
472
+ # `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
473
+ # The only supported location is `global`.
469
474
  #
470
475
  # @yield [response, operation] Access the result along with the RPC operation
471
476
  # @yieldparam response [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment]
@@ -532,7 +537,7 @@ module Google
532
537
  end
533
538
 
534
539
  ##
535
- # Lists FrameworkDeployments in a given parent resource.
540
+ # Lists the framework deployments in a given parent resource.
536
541
  #
537
542
  # @overload list_framework_deployments(request, options = nil)
538
543
  # Pass arguments to `list_framework_deployments` via a request object, either of type
@@ -550,19 +555,27 @@ module Google
550
555
  # the default parameter values, pass an empty Hash as a request object (see above).
551
556
  #
552
557
  # @param parent [::String]
553
- # Required. parent resource of the FrameworkDeployment in the format:
554
- # organizations/\\{organization}/locations/\\{location}
555
- # Only global location is supported.
558
+ # Required. The parent resource of the framework deployment, in the format
559
+ # `organizations/{organization}/locations/{location}`.
560
+ # The only supported location is `global`.
556
561
  # @param page_size [::Integer]
557
- # Optional. Requested page size. Server may return fewer items than
558
- # requested. If unspecified, server will pick an appropriate default.
562
+ # Optional. The requested page size. The server might return fewer items than
563
+ # requested.
564
+ # If unspecified, the server picks an appropriate default.
559
565
  # @param page_token [::String]
560
- # Optional. A token identifying a page of results the server should return.
566
+ # Optional. A token that identifies a page of results the server should
567
+ # return.
561
568
  # @param filter [::String]
562
- # Optional. Filter to be applied on the resource, defined by EBNF grammar
563
- # https://google.aip.dev/assets/misc/ebnf-filtering.txt.
569
+ # Optional. The filter to be applied on the resource, as defined by
570
+ # [AIP-160: Filtering](https://google.aip.dev/160).
564
571
  # @param order_by [::String]
565
- # Optional. Sort results. Supported are "name", "name desc" or "" (unsorted).
572
+ # Optional. The sort order for the results. The following values are
573
+ # supported:
574
+ #
575
+ # * `name`
576
+ # * `name desc`
577
+ #
578
+ # If you do not specify a value, then the results are not sorted.
566
579
  #
567
580
  # @yield [response, operation] Access the result along with the RPC operation
568
581
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::FrameworkDeployment>]
@@ -635,7 +648,7 @@ module Google
635
648
  end
636
649
 
637
650
  ##
638
- # Gets details of a single CloudControlDeployment.
651
+ # Gets details about a cloud control deployment.
639
652
  #
640
653
  # @overload get_cloud_control_deployment(request, options = nil)
641
654
  # Pass arguments to `get_cloud_control_deployment` via a request object, either of type
@@ -653,8 +666,9 @@ module Google
653
666
  # the default parameter values, pass an empty Hash as a request object (see above).
654
667
  #
655
668
  # @param name [::String]
656
- # Required. CloudControlDeployment name in the following format:
657
- # organizations/\\{organization}/locations/\\{location}/cloudControlDeployments/\\{cloud_control_deployment_id}
669
+ # Required. The name for the cloud control deployment, in the format
670
+ # `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}`.
671
+ # The only supported location is `global`.
658
672
  #
659
673
  # @yield [response, operation] Access the result along with the RPC operation
660
674
  # @yieldparam response [::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeployment]
@@ -721,7 +735,7 @@ module Google
721
735
  end
722
736
 
723
737
  ##
724
- # Lists CloudControlDeployments in a given parent resource.
738
+ # Lists the cloud conrol deployments in a given parent resource.
725
739
  #
726
740
  # @overload list_cloud_control_deployments(request, options = nil)
727
741
  # Pass arguments to `list_cloud_control_deployments` via a request object, either of type
@@ -739,19 +753,27 @@ module Google
739
753
  # the default parameter values, pass an empty Hash as a request object (see above).
740
754
  #
741
755
  # @param parent [::String]
742
- # Required. parent resource of the CloudControlDeployment in the format:
743
- # organizations/\\{organization}/locations/\\{location}
744
- # Only global location is supported.
756
+ # Required. The parent resource for the cloud control deployment, in the
757
+ # format `organizations/{organization}/locations/{location}`. The only
758
+ # supported location is `global`.
745
759
  # @param page_size [::Integer]
746
- # Optional. Requested page size. Server may return fewer items than
747
- # requested. If unspecified, server will pick an appropriate default.
760
+ # Optional. The requested page size. The server might return fewer items than
761
+ # you requested.
762
+ # If unspecified, the server picks an appropriate default.
748
763
  # @param page_token [::String]
749
- # Optional. A token identifying a page of results the server should return.
764
+ # Optional. A token that identifies the page of results that the server
765
+ # should return.
750
766
  # @param filter [::String]
751
- # Optional. Filter to be applied on the resource, defined by EBNF grammar
752
- # https://google.aip.dev/assets/misc/ebnf-filtering.txt.
767
+ # Optional. The filter to apply on the resource, as defined by
768
+ # [AIP-160: Filtering](https://google.aip.dev/160).
753
769
  # @param order_by [::String]
754
- # Optional. Sort results. Supported are "name", "name desc" or "" (unsorted).
770
+ # Optional. The sort order for the results. The following values are
771
+ # supported:
772
+ #
773
+ # * `name`
774
+ # * `name desc`
775
+ #
776
+ # If you do not specify a value, then the results are not sorted.
755
777
  #
756
778
  # @yield [response, operation] Access the result along with the RPC operation
757
779
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::CloudSecurityCompliance::V1::CloudControlDeployment>]
@@ -858,8 +880,6 @@ module Google
858
880
  # @return [::String,nil]
859
881
  # @!attribute [rw] credentials
860
882
  # Credentials to send with calls. You may provide any of the following types:
861
- # * (`String`) The path to a service account key file in JSON format
862
- # * (`Hash`) A service account key as a Hash
863
883
  # * (`Google::Auth::Credentials`) A googleauth credentials object
864
884
  # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
865
885
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -868,7 +888,26 @@ module Google
868
888
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
869
889
  # * (`nil`) indicating no credentials
870
890
  #
871
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
891
+ # @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
892
+ # is deprecated. Providing an unvalidated credential configuration to
893
+ # Google APIs can compromise the security of your systems and data.
894
+ #
895
+ # @example
896
+ #
897
+ # # The recommended way to provide credentials is to use the `make_creds` method
898
+ # # on the appropriate credentials class for your environment.
899
+ #
900
+ # require "googleauth"
901
+ #
902
+ # credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
903
+ # json_key_io: ::File.open("/path/to/keyfile.json")
904
+ # )
905
+ #
906
+ # client = ::Google::Cloud::CloudSecurityCompliance::V1::Deployment::Client.new do |config|
907
+ # config.credentials = credentials
908
+ # end
909
+ #
910
+ # @note Warning: If you accept a credential configuration (JSON file or Hash) from an
872
911
  # external source for authentication to Google Cloud, you must validate it before
873
912
  # providing it to a Google API client library. Providing an unvalidated credential
874
913
  # configuration to Google APIs can compromise the security of your systems and data.