google-cloud-cloud_security_compliance-v1 0.3.0 → 0.4.1

data/proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb

@@ -26,8 +26,12 @@ module Google
         # FedRAMP or NIST.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Identifier. The name of the framework, in the format
-        #     `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.
+        #     Required. Identifier. The name of the framework, in one of the following
+        #     formats:
+        #     `organizations/{organization}/locations/{location}/frameworks/{framework}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworks/{framework}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [r] major_revision_id
         #   @return [::Integer]
@@ -80,8 +84,11 @@ module Google
         # The details of a cloud control.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the cloud control, in the format
-        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud-control}`.
+        #     Required. The name of the cloud control, in one of the following formats:
+        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControls/{cloud_control}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] major_revision_id
         #   @return [::Integer]
@@ -97,8 +104,10 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The reference of a framework, in the format
-        # `organizations/{organization}/locations/{location}/frameworks/{framework}`.
+        # The reference of a framework, in one of the following formats:
+        # - `organizations/{organization}/locations/{location}/frameworks/{framework}`
+        # - `projects/{project}/locations/{location}/frameworks/{framework}`.
+        #
         # The only supported location is `global`.
         # @!attribute [rw] framework
         #   @return [::String]
@@ -131,8 +140,12 @@ module Google
         # use to define your organization's security or compliance intent.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Identifier. The name of the cloud control, in the format
-        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud_control_id}`.
+        #     Required. Identifier. The name of the cloud control, in either of the
+        #     formats:
+        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControls/{cloud_control}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [r] major_revision_id
         #   @return [::Integer]
@@ -324,27 +337,27 @@ module Google
         # The possible parameter value types.
         # @!attribute [rw] string_value
         #   @return [::String]
-        #     A string value.
+        #     Optional. A string value.
         #
         #     Note: The following fields are mutually exclusive: `string_value`, `bool_value`, `string_list_value`, `number_value`, `oneof_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bool_value
         #   @return [::Boolean]
-        #     A boolean value.
+        #     Optional. A boolean value.
         #
         #     Note: The following fields are mutually exclusive: `bool_value`, `string_value`, `string_list_value`, `number_value`, `oneof_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] string_list_value
         #   @return [::Google::Cloud::CloudSecurityCompliance::V1::StringList]
-        #     A repeated string.
+        #     Optional. A repeated string.
         #
         #     Note: The following fields are mutually exclusive: `string_list_value`, `string_value`, `bool_value`, `number_value`, `oneof_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] number_value
         #   @return [::Float]
-        #     A double value.
+        #     Optional. A double value.
         #
         #     Note: The following fields are mutually exclusive: `number_value`, `string_value`, `bool_value`, `string_list_value`, `oneof_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] oneof_value
         #   @return [::Google::Cloud::CloudSecurityCompliance::V1::Parameter]
-        #     Sub-parameter values.
+        #     Optional. Sub-parameter values.
         #
         #     Note: The following fields are mutually exclusive: `oneof_value`, `string_value`, `bool_value`, `string_list_value`, `number_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class ParamValue
@@ -449,6 +462,122 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The regulatory control.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The name of a regulatory control, in one of the following
+        #     formats:
+        #     - `organizations/{organization}/locations/{location}/controls/{control}`
+        #     - `projects/{project}/locations/{location}/controls/{control}`.
+        #
+        #     The only supported location is `global`.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. The friendly name for the regulatory control.
+        # @!attribute [r] description
+        #   @return [::String]
+        #     Output only. The description of the regulatory control.
+        # @!attribute [r] family
+        #   @return [::Google::Cloud::CloudSecurityCompliance::V1::Control::Family]
+        #     Output only. The regulatory group that the control belongs to.
+        # @!attribute [r] control_family
+        #   @return [::Google::Cloud::CloudSecurityCompliance::V1::ControlFamily]
+        #     Output only. The regulatory family that the control belongs to.
+        # @!attribute [r] responsibility_type
+        #   @return [::Google::Cloud::CloudSecurityCompliance::V1::RegulatoryControlResponsibilityType]
+        #     Output only. The entity that's responsible for the control, whether Google,
+        #     you as the customer, or both.
+        # @!attribute [r] google_responsibility_description
+        #   @return [::String]
+        #     Output only. A description of Google's responsibility for the regulatory
+        #     control.
+        # @!attribute [r] google_responsibility_implementation
+        #   @return [::String]
+        #     Output only. A description of Google's responsibility for implementing the
+        #     regulatory control.
+        # @!attribute [r] customer_responsibility_description
+        #   @return [::String]
+        #     Output only. A description of your responsibility for the regulatory
+        #     control.
+        # @!attribute [r] customer_responsibility_implementation
+        #   @return [::String]
+        #     Output only. A description of the your responsibility for implementing the
+        #     regulatory control.
+        # @!attribute [r] shared_responsibility_description
+        #   @return [::String]
+        #     Output only. A description of the responsibility that's shared between
+        #     Google and you in implementing this control.
+        # @!attribute [r] additional_content_uri
+        #   @return [::String]
+        #     Output only. A link to the documentation that's related to this control.
+        # @!attribute [r] related_frameworks
+        #   @return [::Array<::String>]
+        #     Output only. The frameworks that include this control.
+        class Control
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The regulatory control family.
+          module Family
+            # Default value. This value is unused.
+            FAMILY_UNSPECIFIED = 0
+
+            # Access control
+            AC = 1
+
+            # Awareness and araining
+            AT = 2
+
+            # Audit and accountability
+            AU = 3
+
+            # Certification, accreditation, and security assessments
+            CA = 4
+
+            # Configuration management
+            CM = 5
+
+            # Contingency planning
+            CP = 6
+
+            # Identification and authentication
+            IA = 7
+
+            # Incident response
+            IR = 8
+
+            # Maintenance
+            MA = 9
+
+            # Media protection
+            MP = 10
+
+            # Physical and environmental protection
+            PE = 11
+
+            # Security planning
+            PL = 12
+
+            # Personnel aecurity
+            PS = 13
+
+            # Risk assessment
+            RA = 14
+
+            # System services and acquisition
+            SA = 15
+
+            # System and communications protection
+            SC = 16
+
+            # System and information integrity
+            SI = 17
+
+            # Supply chain risk management
+            SR = 18
+          end
+        end
+
         # The regulatory family of the control.
         # @!attribute [rw] family_id
         #   @return [::String]
@@ -561,6 +690,18 @@ module Google
 
           # The business continuity and disaster recovery (BCDR) category.
           CC_CATEGORY_BCDR = 15
+
+          # The admin access category.
+          CC_CATEGORY_ADMIN_ACCESS = 16
+
+          # DRZ (Data Residency).
+          CC_CATEGORY_DATA_RESIDENCY = 17
+
+          # RUR (Resource Usage Restriction).
+          CC_CATEGORY_RESOURCE_USAGE_RESTRICTION = 18
+
+          # SERVICE SPECIFIC
+          CC_CATEGORY_SERVICE_SPECIFIC = 19
         end
 
         # The cloud provider that's associated with the cloud control.

data/proto_docs/google/cloud/cloudsecuritycompliance/v1/config.rb

@@ -24,8 +24,10 @@ module Google
         # Request message for [ListFrameworks][].
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent resource name, in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     Required. The parent resource name, in one of the following formats:
+        #     - `organizations/{organization}/locations/{location}`
+        #     - `projects/{project}/locations/{location}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
@@ -60,8 +62,12 @@ module Google
         # The request message for [GetFramework][].
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the framework to retrieve, in the format
-        #     `organizations/{organization}/locations/{location}/frameworks/{framework_id}`
+        #     Required. The name of the framework to retrieve, in one of the following
+        #     formats:
+        #     `organizations/{organization}/locations/{location}/frameworks/{framework}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworks/{framework}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] major_revision_id
         #   @return [::Integer]
@@ -75,8 +81,10 @@ module Google
         # The request message for [CreateFramework][].
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent resource name, in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     Required. The parent resource name, in one of the following formats:
+        #     - `organizations/{organization}/locations/{location}`
+        #     - `projects/{project}/locations/{location}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] framework_id
         #   @return [::String]
@@ -112,8 +120,11 @@ module Google
         # Request message for [DeleteFramework][].
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the resource, in the format
-        #     `organizations/{organization}/locations/{location}/frameworks/{framework}`.
+        #     Required. The name of the resource, in one of the following formats:
+        #     `organizations/{organization}/locations/{location}/frameworks/{framework}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworks/{framework}`.
+        #
         #     The only supported location is `global`.
         class DeleteFrameworkRequest
           include ::Google::Protobuf::MessageExts
@@ -123,8 +134,10 @@ module Google
         # Request message for [ListCloudControls][].
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent resource name, in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     Required. The parent resource name, in one of the following formats:
+        #     - `organizations/{organization}/locations/{location}`
+        #     - `projects/{project}/locations/{location}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
@@ -163,8 +176,12 @@ module Google
         # The request message for [GetCloudControl][].
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the cloud control to retrieve, in the format
-        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`.
+        #     Required. The name of the cloud control to retrieve, in one of the
+        #     following formats:
+        #     `organizations/{organization}/locations/{location}/cloudControls/{cloud_control}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControls/{cloud_control}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] major_revision_id
         #   @return [::Integer]
@@ -178,8 +195,10 @@ module Google
         # The request message for [CreateCloudControl][].
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent resource name, in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     Required. The parent resource name, in one of the following formats:
+        #     - `organizations/{organization}/locations/{location}`.
+        #     - `projects/{project}/locations/{location}`.
+        #
         #     The only supported location is `global`.
         # @!attribute [rw] cloud_control_id
         #   @return [::String]
@@ -222,8 +241,12 @@ module Google
         # The request message for [DeleteCloudControl][].
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The name of the cloud control to delete, in the format
-        #     `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`.
+        #     Required. The name of the cloud control to delete, in one of the following
+        #     formats:
+        #     `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`
+        #     or
+        #     `projects/{project}/locations/{location}/CloudControls/{CloudControl}`.
+        #
         #     The only supported location is `global`.
         class DeleteCloudControlRequest
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/cloudsecuritycompliance/v1/deployment.rb

@@ -27,7 +27,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Identifier. The name of the framework deployment, in the format
-        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
         #     The only supported location is `global`.
         # @!attribute [rw] target_resource_config
         #   @return [::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig]
@@ -103,7 +105,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Identifier. The name for the cloud control deployment, in the format
-        #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`.
         #     The only supported location is `global`.
         # @!attribute [rw] target_resource_config
         #   @return [::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceConfig]
@@ -241,7 +245,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource of the framework deployment in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     `organizations/{organization}/locations/{location}`
+        #     or
+        #     `projects/{project}/locations/{location}`.
         #     Only the global location is supported.
         # @!attribute [rw] framework_deployment_id
         #   @return [::String]
@@ -261,7 +267,9 @@ module Google
         #   @return [::String]
         #     Required. The name of the framework deployment that you want to delete,
         #     in the format
-        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
         #     The only supported location is `global`.
         # @!attribute [rw] etag
         #   @return [::String]
@@ -282,7 +290,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The name of the framework deployment, in the format
-        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
         #     The only supported location is `global`.
         class GetFrameworkDeploymentRequest
           include ::Google::Protobuf::MessageExts
@@ -293,7 +303,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource of the framework deployment, in the format
-        #     `organizations/{organization}/locations/{location}`.
+        #     `organizations/{organization}/locations/{location}`
+        #     or
+        #     `projects/{project}/locations/{location}`.
         #     The only supported location is `global`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
@@ -339,7 +351,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The name for the cloud control deployment, in the format
-        #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`.
         #     The only supported location is `global`.
         class GetCloudControlDeploymentRequest
           include ::Google::Protobuf::MessageExts
@@ -350,8 +364,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource for the cloud control deployment, in the
-        #     format `organizations/{organization}/locations/{location}`. The only
-        #     supported location is `global`.
+        #     format `organizations/{organization}/locations/{location}` or
+        #     `projects/{project}/locations/{location}`.
+        #     The only supported location is `global`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. The requested page size. The server might return fewer items than
@@ -396,7 +411,9 @@ module Google
         # @!attribute [r] cloud_control_deployment
         #   @return [::String]
         #     Output only. The name of the CloudControlDeployment. The format is
-        #     `organizations/{org}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/cloudControlDeployments/{cloud_control_deployment}`.
         #     The only supported location is `global`.
         class CloudControlDeploymentReference
           include ::Google::Protobuf::MessageExts
@@ -407,7 +424,9 @@ module Google
         # @!attribute [r] framework_deployment
         #   @return [::String]
         #     Output only. The name of the framework deployment, in the format
-        #     `organizations/{org}/locations/{location}/frameworkDeployments/{framework_deployment_id}`.
+        #     `organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment}`
+        #     or
+        #     `projects/{project}/locations/{location}/frameworkDeployments/{framework_deployment}`.
         #     The only supported location is `global`.
         # @!attribute [rw] framework_reference
         #   @return [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkReference]
@@ -417,7 +436,7 @@ module Google
         #     ```
         #     {
         #       framework:
-        #       "organizations/\\{org}/locations/\\{location}/frameworks/\\{framework}",
+        #       "organizations/\\{organization}/locations/\\{location}/frameworks/\\{framework}",
         #       major_revision_id: 1
         #     }
         #     ```
@@ -446,6 +465,9 @@ module Google
           # Deployment is being deleted.
           DEPLOYMENT_STATE_DELETING = 3
 
+          # Deployment is being updated.
+          DEPLOYMENT_STATE_UPDATING = 8
+
           # Deployment has failed. All the changes made by the deployment were
           # successfully rolled back. You can retry or delete a deployment that's
           # in this state.

data/proto_docs/google/cloud/cloudsecuritycompliance/v1/monitoring.rb

@@ -37,6 +37,9 @@ module Google
         # @!attribute [rw] filter
         #   @return [::String]
         #     Optional. The filtering results.
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::CloudSecurityCompliance::V1::FrameworkComplianceSummaryView]
+        #     Optional. Specifies the level of detail to return in the response.
         class ListFrameworkComplianceSummariesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -104,6 +107,9 @@ module Google
         # @!attribute [rw] end_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Optional. The end time of the report.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. The filtering results.
         class FetchFrameworkComplianceReportRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -260,6 +266,12 @@ module Google
         # @!attribute [rw] target_resource_details
         #   @return [::Array<::Google::Cloud::CloudSecurityCompliance::V1::TargetResourceDetails>]
         #     The target resource details for the framework.
+        # @!attribute [r] finding_count
+        #   @return [::Integer]
+        #     Output only. The count of the findings generated against the framework.
+        # @!attribute [r] controls_passing_trend
+        #   @return [::Google::Cloud::CloudSecurityCompliance::V1::Trend]
+        #     Output only. The trend of controls that are passing for the given duration.
         class FrameworkComplianceSummary
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -467,6 +479,19 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The trend of a compliance metric.
+        # @!attribute [r] duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Output only. The duration for the trend.
+        # @!attribute [r] value_percent
+        #   @return [::Float]
+        #     Output only. The trend value as a percentage. The value can be positive or
+        #     negative.
+        class Trend
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The evaluation state of the control.
         module EvaluationState
           # Default value. This value is unused.
@@ -521,6 +546,23 @@ module Google
           # converge, based on attack path simulations (APS).
           CHOKEPOINT = 9
         end
+
+        # Specifies the view of the framework compliance summary to be returned.
+        # New values may be added in the future.
+        module FrameworkComplianceSummaryView
+          # The default / unset value. The API will default to the BASIC view.
+          FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED = 0
+
+          # Includes basic compliance metadata, but omits trend data.
+          FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC = 1
+
+          # Includes all information, including
+          # [finding_count][google.cloud.cloudsecuritycompliance.v1main.FrameworkComplianceSummary.finding_count]
+          # and
+          # [controls_passing_trend][google.cloud.cloudsecuritycompliance.v1main.FrameworkComplianceSummary.controls_passing_trend].
+          # Trend data is provided for the last 30 days.
+          FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL = 2
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-cloud_security_compliance-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Google LLC