google-cloud-security_center-v1p1beta1 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6eea35e9e59564148ef0f49aaaa1c560930d8897daca1b012226a543a99ae4
-  data.tar.gz: a82bdf3bfcdb59cd1cb0663d8c0650369e818315d8c9d6974ea9804362eac943
+  metadata.gz: dadbc57ad55b718d6ed4da1fd3383d0b82c30399e34bbeda7dc0914574bde557
+  data.tar.gz: 688672191c8ca856a98a34896d408be5d83caac1b9c2002388402a6fd4d93f5f
 SHA512:
-  metadata.gz: c440f25fed955371da5e93c7874d642036dff625a2d23c8e31a67fc378d38d15cdd6503d3e69b55ad77419a8ce712942272baa23e8da0b4bcff154c716f8a732
-  data.tar.gz: e2a06def055952f6e82ceed0e07eb7fbfe904a3342054b5db8f29249fc8c55eb267961d2eefc191029ba4a090dbfe3a89291603939b5be9ac1303477d9dd8ec0
+  metadata.gz: fe96df31352ca3cc0c73be5ba223023391601919014ee61dc56ad89b002d0c9ee61ddc51753c3f457af1d6138e5f7f578ccebaba9531ce97e6899effc4a1b406
+  data.tar.gz: c0992466627cfb8672ba81e9da101d6dfbbb8f3805402113b02686908fd9e5c98d516ec92fd0c6ab99655b6e6465419656b29ace936f31fe017049fb1bcf2636

data/README.md

@@ -18,6 +18,7 @@ In order to use this library, you first need to go through the following steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/securitycenter.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
 ## Quick Start
@@ -33,6 +34,9 @@ response = client.create_source request
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-security_center-v1p1beta1/latest)
 for class and method documentation.
 
+See also the [Product Documentation](https://cloud.google.com/security-command-center)
+for general usage information.
+
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.

data/lib/google/cloud/security_center/v1p1beta1/security_center/client.rb

@@ -65,15 +65,15 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.rpcs.create_source.timeout = 60.0
+                default_config.rpcs.create_source.timeout = 600.0
 
-                default_config.rpcs.create_finding.timeout = 60.0
+                default_config.rpcs.create_finding.timeout = 600.0
 
-                default_config.rpcs.create_notification_config.timeout = 60.0
+                default_config.rpcs.create_notification_config.timeout = 600.0
 
-                default_config.rpcs.delete_notification_config.timeout = 60.0
+                default_config.rpcs.delete_notification_config.timeout = 600.0
 
-                default_config.rpcs.get_iam_policy.timeout = 60.0
+                default_config.rpcs.get_iam_policy.timeout = 600.0
                 default_config.rpcs.get_iam_policy.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -81,7 +81,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.get_notification_config.timeout = 60.0
+                default_config.rpcs.get_notification_config.timeout = 600.0
                 default_config.rpcs.get_notification_config.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -89,7 +89,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.get_organization_settings.timeout = 60.0
+                default_config.rpcs.get_organization_settings.timeout = 600.0
                 default_config.rpcs.get_organization_settings.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -97,7 +97,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.get_source.timeout = 60.0
+                default_config.rpcs.get_source.timeout = 600.0
                 default_config.rpcs.get_source.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -105,7 +105,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.group_assets.timeout = 60.0
+                default_config.rpcs.group_assets.timeout = 600.0
                 default_config.rpcs.group_assets.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -113,7 +113,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.group_findings.timeout = 60.0
+                default_config.rpcs.group_findings.timeout = 600.0
                 default_config.rpcs.group_findings.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -121,7 +121,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.list_assets.timeout = 60.0
+                default_config.rpcs.list_assets.timeout = 600.0
                 default_config.rpcs.list_assets.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -129,7 +129,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.list_findings.timeout = 60.0
+                default_config.rpcs.list_findings.timeout = 600.0
                 default_config.rpcs.list_findings.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -137,7 +137,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.list_notification_configs.timeout = 60.0
+                default_config.rpcs.list_notification_configs.timeout = 600.0
                 default_config.rpcs.list_notification_configs.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -145,7 +145,7 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.list_sources.timeout = 60.0
+                default_config.rpcs.list_sources.timeout = 600.0
                 default_config.rpcs.list_sources.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -153,13 +153,13 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.run_asset_discovery.timeout = 60.0
+                default_config.rpcs.run_asset_discovery.timeout = 600.0
 
-                default_config.rpcs.set_finding_state.timeout = 60.0
+                default_config.rpcs.set_finding_state.timeout = 600.0
 
-                default_config.rpcs.set_iam_policy.timeout = 60.0
+                default_config.rpcs.set_iam_policy.timeout = 600.0
 
-                default_config.rpcs.test_iam_permissions.timeout = 60.0
+                default_config.rpcs.test_iam_permissions.timeout = 600.0
                 default_config.rpcs.test_iam_permissions.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     60.0,
@@ -167,15 +167,15 @@ module Google
                   retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
                 }
 
-                default_config.rpcs.update_finding.timeout = 60.0
+                default_config.rpcs.update_finding.timeout = 600.0
 
-                default_config.rpcs.update_notification_config.timeout = 60.0
+                default_config.rpcs.update_notification_config.timeout = 600.0
 
-                default_config.rpcs.update_organization_settings.timeout = 60.0
+                default_config.rpcs.update_organization_settings.timeout = 600.0
 
-                default_config.rpcs.update_source.timeout = 60.0
+                default_config.rpcs.update_source.timeout = 600.0
 
-                default_config.rpcs.update_security_marks.timeout = 60.0
+                default_config.rpcs.update_security_marks.timeout = 600.0
 
                 default_config
               end
@@ -242,7 +242,8 @@ module Google
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
-              @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+              @quota_project_id = @config.quota_project
+              @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
@@ -840,7 +841,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload group_assets(parent: nil, filter: nil, group_by: nil, compare_duration: nil, read_time: nil, having: nil, page_token: nil, page_size: nil)
+            # @overload group_assets(parent: nil, filter: nil, group_by: nil, compare_duration: nil, read_time: nil, page_token: nil, page_size: nil)
             #   Pass arguments to `group_assets` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -882,15 +883,15 @@ module Google
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "update_time = \"2019-06-10T16:07:18-07:00\""
-            #         "update_time = 1560208038000"
+            #         `update_time = "2019-06-10T16:07:18-07:00"`
+            #         `update_time = 1560208038000`
             #
             #     * create_time: `=`, `>`, `<`, `>=`, `<=`
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "create_time = \"2019-06-10T16:07:18-07:00\""
-            #         "create_time = 1560208038000"
+            #         `create_time = "2019-06-10T16:07:18-07:00"`
+            #         `create_time = 1560208038000`
             #
             #     * iam_policy.policy_blob: `=`, `:`
             #     * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
@@ -905,6 +906,12 @@ module Google
             #     * security_center_properties.resource_owners: `=`, `:`
             #
             #     For example, `resource_properties.size = 100` is a valid filter string.
+            #
+            #     Use a partial match on the empty string to filter based on a property
+            #     existing: `resource_properties.my_property : ""`
+            #
+            #     Use a negated partial match on the empty string to filter based on a
+            #     property not existing: `-resource_properties.my_property : ""`
             #   @param group_by [::String]
             #     Required. Expression that defines what assets fields to use for grouping.
             #     The string value should follow SQL syntax: comma separated list of fields.
@@ -957,10 +964,6 @@ module Google
             #     to assets existing at the supplied time and their values are those at that
             #     specific time. Absence of this field will default to the API's version of
             #     NOW.
-            #   @param having [::String]
-            #     Filter that specifies what fields to further filter on *after* the query
-            #     filter has been executed. Currently only `state_change` is supported and
-            #     requires compare_duration to be specified.
             #   @param page_token [::String]
             #     The value returned by the last `GroupAssetsResponse`; indicates
             #     that this is a continuation of a prior `GroupAssets` call, and that the
@@ -1032,7 +1035,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload group_findings(parent: nil, filter: nil, group_by: nil, read_time: nil, compare_duration: nil, having: nil, page_token: nil, page_size: nil)
+            # @overload group_findings(parent: nil, filter: nil, group_by: nil, read_time: nil, compare_duration: nil, page_token: nil, page_size: nil)
             #   Pass arguments to `group_findings` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1079,13 +1082,19 @@ module Google
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "event_time = \"2019-06-10T16:07:18-07:00\""
-            #         "event_time = 1560208038000"
+            #         `event_time = "2019-06-10T16:07:18-07:00"`
+            #         `event_time = 1560208038000`
             #
             #     * security_marks.marks: `=`, `:`
             #     * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
             #
             #     For example, `source_properties.size = 100` is a valid filter string.
+            #
+            #     Use a partial match on the empty string to filter based on a property
+            #     existing: `source_properties.my_property : ""`
+            #
+            #     Use a negated partial match on the empty string to filter based on a
+            #     property not existing: `-source_properties.my_property : ""`
             #   @param group_by [::String]
             #     Required. Expression that defines what assets fields to use for grouping
             #     (including `state_change`). The string value should follow SQL syntax:
@@ -1120,12 +1129,18 @@ module Google
             #
             #     Possible "state_change" values when compare_duration is specified:
             #
-            #     * "CHANGED":   indicates that the finding was present at the start of
-            #                      compare_duration, but changed its state at read_time.
-            #     * "UNCHANGED": indicates that the finding was present at the start of
-            #                      compare_duration and did not change state at read_time.
-            #     * "ADDED":     indicates that the finding was not present at the start
-            #                      of compare_duration, but was present at read_time.
+            #     * "CHANGED":   indicates that the finding was present and matched the given
+            #                      filter at the start of compare_duration, but changed its
+            #                      state at read_time.
+            #     * "UNCHANGED": indicates that the finding was present and matched the given
+            #                      filter at the start of compare_duration and did not change
+            #                      state at read_time.
+            #     * "ADDED":     indicates that the finding did not match the given filter or
+            #                      was not present at the start of compare_duration, but was
+            #                      present at read_time.
+            #     * "REMOVED":   indicates that the finding was present and matched the
+            #                      filter at the start of compare_duration, but did not match
+            #                      the filter at read_time.
             #
             #     If compare_duration is not specified, then the only possible state_change
             #     is "UNUSED",  which will be the state_change set for all findings present
@@ -1133,10 +1148,6 @@ module Google
             #
             #     If this field is set then `state_change` must be a specified field in
             #     `group_by`.
-            #   @param having [::String]
-            #     Filter that specifies what fields to further filter on *after* the query
-            #     filter has been executed. Currently only `finding.state` and `state_change`
-            #     are supported and requires compare_duration to be specified.
             #   @param page_token [::String]
             #     The value returned by the last `GroupFindingsResponse`; indicates
             #     that this is a continuation of a prior `GroupFindings` call, and
@@ -1204,7 +1215,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_assets(parent: nil, filter: nil, order_by: nil, read_time: nil, compare_duration: nil, having: nil, field_mask: nil, page_token: nil, page_size: nil)
+            # @overload list_assets(parent: nil, filter: nil, order_by: nil, read_time: nil, compare_duration: nil, field_mask: nil, page_token: nil, page_size: nil)
             #   Pass arguments to `list_assets` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1246,15 +1257,15 @@ module Google
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "update_time = \"2019-06-10T16:07:18-07:00\""
-            #         "update_time = 1560208038000"
+            #         `update_time = "2019-06-10T16:07:18-07:00"`
+            #         `update_time = 1560208038000`
             #
             #     * create_time: `=`, `>`, `<`, `>=`, `<=`
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "create_time = \"2019-06-10T16:07:18-07:00\""
-            #         "create_time = 1560208038000"
+            #         `create_time = "2019-06-10T16:07:18-07:00"`
+            #         `create_time = 1560208038000`
             #
             #     * iam_policy.policy_blob: `=`, `:`
             #     * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
@@ -1269,6 +1280,12 @@ module Google
             #     * security_center_properties.resource_owners: `=`, `:`
             #
             #     For example, `resource_properties.size = 100` is a valid filter string.
+            #
+            #     Use a partial match on the empty string to filter based on a property
+            #     existing: `resource_properties.my_property : ""`
+            #
+            #     Use a negated partial match on the empty string to filter based on a
+            #     property not existing: `-resource_properties.my_property : ""`
             #   @param order_by [::String]
             #     Expression that defines what fields and order to use for sorting. The
             #     string value should follow SQL syntax: comma separated list of fields. For
@@ -1321,10 +1338,6 @@ module Google
             #     If compare_duration is not specified, then the only possible state_change
             #     is "UNUSED",  which will be the state_change set for all assets present at
             #     read_time.
-            #   @param having [::String]
-            #     Filter that specifies what fields to further filter on *after* the query
-            #     filter has been executed. Currently only `state_change` is supported and
-            #     requires compare_duration to be specified.
             #   @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Optional.
             #     A field mask to specify the ListAssetsResult fields to be listed in the
@@ -1400,7 +1413,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_findings(parent: nil, filter: nil, order_by: nil, read_time: nil, compare_duration: nil, having: nil, field_mask: nil, page_token: nil, page_size: nil)
+            # @overload list_findings(parent: nil, filter: nil, order_by: nil, read_time: nil, compare_duration: nil, field_mask: nil, page_token: nil, page_size: nil)
             #   Pass arguments to `list_findings` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1447,13 +1460,19 @@ module Google
             #
             #       Usage: This should be milliseconds since epoch or an RFC3339 string.
             #       Examples:
-            #         "event_time = \"2019-06-10T16:07:18-07:00\""
-            #         "event_time = 1560208038000"
+            #         `event_time = "2019-06-10T16:07:18-07:00"`
+            #         `event_time = 1560208038000`
             #
             #     security_marks.marks: `=`, `:`
             #     source_properties: `=`, `:`, `>`, `<`, `>=`, `<=`
             #
             #     For example, `source_properties.size = 100` is a valid filter string.
+            #
+            #     Use a partial match on the empty string to filter based on a property
+            #     existing: `source_properties.my_property : ""`
+            #
+            #     Use a negated partial match on the empty string to filter based on a
+            #     property not existing: `-source_properties.my_property : ""`
             #   @param order_by [::String]
             #     Expression that defines what fields and order to use for sorting. The
             #     string value should follow SQL syntax: comma separated list of fields. For
@@ -1493,20 +1512,22 @@ module Google
             #
             #     Possible "state_change" values when compare_duration is specified:
             #
-            #     * "CHANGED":   indicates that the finding was present at the start of
-            #                      compare_duration, but changed its state at read_time.
-            #     * "UNCHANGED": indicates that the finding was present at the start of
-            #                      compare_duration and did not change state at read_time.
-            #     * "ADDED":     indicates that the finding was not present at the start
-            #                      of compare_duration, but was present at read_time.
+            #     * "CHANGED":   indicates that the finding was present and matched the given
+            #                      filter at the start of compare_duration, but changed its
+            #                      state at read_time.
+            #     * "UNCHANGED": indicates that the finding was present and matched the given
+            #                      filter at the start of compare_duration and did not change
+            #                      state at read_time.
+            #     * "ADDED":     indicates that the finding did not match the given filter or
+            #                      was not present at the start of compare_duration, but was
+            #                      present at read_time.
+            #     * "REMOVED":   indicates that the finding was present and matched the
+            #                      filter at the start of compare_duration, but did not match
+            #                      the filter at read_time.
             #
             #     If compare_duration is not specified, then the only possible state_change
             #     is "UNUSED", which will be the state_change set for all findings present at
             #     read_time.
-            #   @param having [::String]
-            #     Filter that specifies what fields to further filter on *after* the query
-            #     filter has been executed. Currently only `finding.state` and `state_change`
-            #     are supported and requires compare_duration to be specified.
             #   @param field_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Optional.
             #     A field mask to specify the Finding fields to be listed in the response.
@@ -2086,7 +2107,8 @@ module Google
             end
 
             ##
-            # Updates a notification config.
+            # Updates a notification config. The following update
+            # fields are allowed: description, pubsub_topic, streaming_config.filter
             #
             # @overload update_notification_config(request, options = nil)
             #   Pass arguments to `update_notification_config` via a request object, either of type
@@ -2447,24 +2469,28 @@ module Google
             #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
             #       trigger a retry.
             #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
             #
             class Configuration
               extend ::Gapic::Config
 
-              config_attr :endpoint,     "securitycenter.googleapis.com", String
-              config_attr :credentials,  nil do |value|
+              config_attr :endpoint,      "securitycenter.googleapis.com", ::String
+              config_attr :credentials,   nil do |value|
                 allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
-              config_attr :scope,        nil, ::String, ::Array, nil
-              config_attr :lib_name,     nil, ::String, nil
-              config_attr :lib_version,  nil, ::String, nil
-              config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
-              config_attr :interceptors, nil, ::Array, nil
-              config_attr :timeout,      nil, ::Numeric, nil
-              config_attr :metadata,     nil, ::Hash, nil
-              config_attr :retry_policy, nil, ::Hash, Proc, nil
+              config_attr :scope,         nil, ::String, ::Array, nil
+              config_attr :lib_name,      nil, ::String, nil
+              config_attr :lib_version,   nil, ::String, nil
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr :interceptors,  nil, ::Array, nil
+              config_attr :timeout,       nil, ::Numeric, nil
+              config_attr :metadata,      nil, ::Hash, nil
+              config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+              config_attr :quota_project, nil, ::String, nil
 
               # @private
               def initialize parent_config = nil
@@ -2480,7 +2506,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end