google-cloud-security_center-v1 0.3.5 → 0.7.0

data/proto_docs/google/cloud/securitycenter/v1/folder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module SecurityCenter
+      module V1
+        # Message that contains the resource name and display name of a folder
+        # resource.
+        # @!attribute [rw] resource_folder
+        #   @return [::String]
+        #     Full resource name of this folder. See:
+        #     https://cloud.google.com/apis/design/resource_names#full_resource_name
+        # @!attribute [rw] resource_folder_display_name
+        #   @return [::String]
+        #     The user defined display name for this folder.
+        class Folder
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/securitycenter/v1/notification_config.rb

@@ -36,12 +36,12 @@ module Google
         #     The description of the notification config (max of 1024 characters).
         # @!attribute [rw] pubsub_topic
         #   @return [::String]
-        #     The PubSub topic to send notifications to. Its format is
+        #     The Pub/Sub topic to send notifications to. Its format is
         #     "projects/[project_id]/topics/[topic]".
         # @!attribute [r] service_account
         #   @return [::String]
         #     Output only. The service account that needs "pubsub.topics.publish"
-        #     permission to publish to the PubSub topic.
+        #     permission to publish to the Pub/Sub topic.
         # @!attribute [rw] streaming_config
         #   @return [::Google::Cloud::SecurityCenter::V1::NotificationConfig::StreamingConfig]
         #     The config for triggering streaming-based notifications.

data/proto_docs/google/cloud/securitycenter/v1/organization_settings.rb

@@ -49,6 +49,10 @@ module Google
           # @!attribute [rw] inclusion_mode
           #   @return [::Google::Cloud::SecurityCenter::V1::OrganizationSettings::AssetDiscoveryConfig::InclusionMode]
           #     The mode to use for filtering asset discovery.
+          # @!attribute [rw] folder_ids
+          #   @return [::Array<::String>]
+          #     The folder ids to use for filtering asset discovery.
+          #     It consists of only digits, e.g., 756619654966.
           class AssetDiscoveryConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/securitycenter/v1/resource.rb

@@ -38,6 +38,11 @@ module Google
         # @!attribute [rw] parent_display_name
         #   @return [::String]
         #     The human readable name of resource's parent.
+        # @!attribute [r] folders
+        #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
+        #     Output only. Contains a Folder message for each folder in the assets ancestry.
+        #     The first folder is the deepest nested folder, and the last folder is the
+        #     folder directly under the Organization.
         class Resource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/securitycenter/v1/security_marks.rb

@@ -42,6 +42,16 @@ module Google
         #       * Keys must be letters, numbers, underscores, or dashes
         #       * Values have leading and trailing whitespace trimmed, remaining
         #         characters must be between 1 - 4096 characters (inclusive)
+        # @!attribute [rw] canonical_name
+        #   @return [::String]
+        #     The canonical name of the marks.
+        #     Examples:
+        #     "organizations/\\{organization_id}/assets/\\{asset_id}/securityMarks"
+        #     "folders/\\{folder_id}/assets/\\{asset_id}/securityMarks"
+        #     "projects/\\{project_number}/assets/\\{asset_id}/securityMarks"
+        #     "organizations/\\{organization_id}/sources/\\{source_id}/findings/\\{finding_id}/securityMarks"
+        #     "folders/\\{folder_id}/sources/\\{source_id}/findings/\\{finding_id}/securityMarks"
+        #     "projects/\\{project_number}/sources/\\{source_id}/findings/\\{finding_id}/securityMarks"
         class SecurityMarks
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/securitycenter/v1/securitycenter_service.rb

@@ -33,8 +33,8 @@ module Google
         #     greater than 0 characters in length.
         # @!attribute [rw] finding
         #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
-        #     Required. The Finding being created. The name and security_marks will be
-        #     ignored as they are both output only fields on this resource.
+        #     Required. The Finding being created. The name and security_marks will be ignored as
+        #     they are both output only fields on this resource.
         class CreateFindingRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -43,8 +43,8 @@ module Google
         # Request message for creating a notification config.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. Resource name of the new notification config's parent. Its format
-        #     is "organizations/[organization_id]".
+        #     Required. Resource name of the new notification config's parent. Its format is
+        #     "organizations/[organization_id]".
         # @!attribute [rw] config_id
         #   @return [::String]
         #     Required.
@@ -53,9 +53,8 @@ module Google
         #     characters, underscores or hyphens only.
         # @!attribute [rw] notification_config
         #   @return [::Google::Cloud::SecurityCenter::V1::NotificationConfig]
-        #     Required. The notification config being created. The name and the service
-        #     account will be ignored as they are both output only fields on this
-        #     resource.
+        #     Required. The notification config being created. The name and the service account
+        #     will be ignored as they are both output only fields on this resource.
         class CreateNotificationConfigRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -68,8 +67,8 @@ module Google
         #     "organizations/[organization_id]".
         # @!attribute [rw] source
         #   @return [::Google::Cloud::SecurityCenter::V1::Source]
-        #     Required. The Source being created, only the display_name and description
-        #     will be used. All other fields will be ignored.
+        #     Required. The Source being created, only the display_name and description will be
+        #     used. All other fields will be ignored.
         class CreateSourceRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -98,8 +97,8 @@ module Google
         # Request message for getting organization settings.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Name of the organization to get organization settings for. Its
-        #     format is "organizations/[organization_id]/organizationSettings".
+        #     Required. Name of the organization to get organization settings for. Its format is
+        #     "organizations/[organization_id]/organizationSettings".
         class GetOrganizationSettingsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -119,7 +118,8 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Name of the organization to groupBy. Its format is
-        #     "organizations/[organization_id]".
+        #     "organizations/[organization_id], folders/[folder_id], or
+        #     projects/[project_id]".
         # @!attribute [rw] filter
         #   @return [::String]
         #     Expression that defines the filter to apply across assets.
@@ -180,15 +180,15 @@ module Google
         #     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 : ""`
+        #     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 : ""`
         # @!attribute [rw] group_by
         #   @return [::String]
-        #     Required. Expression that defines what assets fields to use for grouping.
-        #     The string value should follow SQL syntax: comma separated list of fields.
-        #     For example:
+        #     Required. Expression that defines what assets fields to use for grouping. The string
+        #     value should follow SQL syntax: comma separated list of fields. For
+        #     example:
         #     "security_center_properties.resource_project,security_center_properties.project".
         #
         #     The following fields are supported when compare_duration is not set:
@@ -278,9 +278,12 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Name of the source to groupBy. Its format is
-        #     "organizations/[organization_id]/sources/[source_id]". To groupBy across
-        #     all sources provide a source_id of `-`. For example:
-        #     organizations/\\{organization_id}/sources/-
+        #     "organizations/[organization_id]/sources/[source_id]",
+        #     folders/[folder_id]/sources/[source_id], or
+        #     projects/[project_id]/sources/[source_id]. To groupBy across all sources
+        #     provide a source_id of `-`. For example:
+        #     organizations/\\{organization_id}/sources/-, folders/\\{folder_id}/sources/-,
+        #     or projects/\\{project_id}/sources/-
         # @!attribute [rw] filter
         #   @return [::String]
         #     Expression that defines the filter to apply across findings.
@@ -316,6 +319,7 @@ module Google
         #     * category: `=`, `:`
         #     * external_uri: `=`, `:`
         #     * event_time: `=`, `>`, `<`, `>=`, `<=`
+        #     * severity: `=`, `:`
         #
         #       Usage: This should be milliseconds since epoch or an RFC3339 string.
         #       Examples:
@@ -334,9 +338,9 @@ module Google
         #     property not existing: `-source_properties.my_property : ""`
         # @!attribute [rw] group_by
         #   @return [::String]
-        #     Required. Expression that defines what assets fields to use for grouping
-        #     (including `state_change`). The string value should follow SQL syntax:
-        #     comma separated list of fields. For example: "parent,resource_name".
+        #     Required. Expression that defines what assets fields to use for grouping (including
+        #     `state_change`). The string value should follow SQL syntax: comma separated
+        #     list of fields. For example: "parent,resource_name".
         #
         #     The following fields are supported:
         #
@@ -344,6 +348,7 @@ module Google
         #     * category
         #     * state
         #     * parent
+        #     * severity
         #
         #     The following fields are supported when compare_duration is set:
         #
@@ -479,8 +484,9 @@ module Google
         # Request message for listing sources.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. Resource name of the parent of sources to list. Its format should
-        #     be "organizations/[organization_id]".
+        #     Required. Resource name of the parent of sources to list. Its format should be
+        #     "organizations/[organization_id], folders/[folder_id], or
+        #     projects/[project_id]".
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The value returned by the last `ListSourcesResponse`; indicates
@@ -512,7 +518,8 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Name of the organization assets should belong to. Its format is
-        #     "organizations/[organization_id]".
+        #     "organizations/[organization_id], folders/[folder_id], or
+        #     projects/[project_id]".
         # @!attribute [rw] filter
         #   @return [::String]
         #     Expression that defines the filter to apply across assets.
@@ -634,8 +641,9 @@ module Google
         #     read_time.
         # @!attribute [rw] field_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Optional. A field mask to specify the ListAssetsResult fields to be listed
-        #     in the response. An empty field mask will list all fields.
+        #     A field mask to specify the ListAssetsResult fields to be listed in the
+        #     response.
+        #     An empty field mask will list all fields.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The value returned by the last `ListAssetsResponse`; indicates
@@ -705,9 +713,12 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Name of the source the findings belong to. Its format is
-        #     "organizations/[organization_id]/sources/[source_id]". To list across all
-        #     sources provide a source_id of `-`. For example:
-        #     organizations/\\{organization_id}/sources/-
+        #     "organizations/[organization_id]/sources/[source_id],
+        #     folders/[folder_id]/sources/[source_id], or
+        #     projects/[project_id]/sources/[source_id]". To list across all sources
+        #     provide a source_id of `-`. For example:
+        #     organizations/\\{organization_id}/sources/-, folders/\\{folder_id}/sources/- or
+        #     projects/\\{projects_id}/sources/-
         # @!attribute [rw] filter
         #   @return [::String]
         #     Expression that defines the filter to apply across findings.
@@ -736,13 +747,14 @@ module Google
         #
         #     The following field and operator combinations are supported:
         #
-        #     name: `=`
-        #     parent: `=`, `:`
-        #     resource_name: `=`, `:`
-        #     state: `=`, `:`
-        #     category: `=`, `:`
-        #     external_uri: `=`, `:`
-        #     event_time: `=`, `>`, `<`, `>=`, `<=`
+        #     * name: `=`
+        #     * parent: `=`, `:`
+        #     * resource_name: `=`, `:`
+        #     * state: `=`, `:`
+        #     * category: `=`, `:`
+        #     * external_uri: `=`, `:`
+        #     * event_time: `=`, `>`, `<`, `>=`, `<=`
+        #     * severity: `=`, `:`
         #
         #       Usage: This should be milliseconds since epoch or an RFC3339 string.
         #       Examples:
@@ -819,8 +831,8 @@ module Google
         #     read_time.
         # @!attribute [rw] field_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Optional. A field mask to specify the Finding fields to be listed in the
-        #     response. An empty field mask will list all fields.
+        #     A field mask to specify the Finding fields to be listed in the response.
+        #     An empty field mask will list all fields.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The value returned by the last `ListFindingsResponse`; indicates
@@ -860,7 +872,7 @@ module Google
           # @!attribute [rw] state_change
           #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange]
           #     State change of the finding between the points in time.
-          # @!attribute [rw] resource
+          # @!attribute [r] resource
           #   @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource]
           #     Output only. Resource that is associated with this finding.
           class ListFindingsResult
@@ -885,6 +897,11 @@ module Google
             # @!attribute [rw] parent_display_name
             #   @return [::String]
             #     The human readable name of resource's parent.
+            # @!attribute [rw] folders
+            #   @return [::Array<::Google::Cloud::SecurityCenter::V1::Folder>]
+            #     Contains a Folder message for each folder in the assets ancestry.
+            #     The first folder is the deepest nested folder, and the last folder is
+            #     the folder directly under the Organization.
             class Resource
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -941,8 +958,8 @@ module Google
         # Request message for running asset discovery for an organization.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. Name of the organization to run asset discovery for. Its format
-        #     is "organizations/[organization_id]".
+        #     Required. Name of the organization to run asset discovery for. Its format is
+        #     "organizations/[organization_id]".
         class RunAssetDiscoveryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -951,8 +968,8 @@ module Google
         # Request message for updating or creating a finding.
         # @!attribute [rw] finding
         #   @return [::Google::Cloud::SecurityCenter::V1::Finding]
-        #     Required. The finding resource to update or create if it does not already
-        #     exist. parent, security_marks, and update_time will be ignored.
+        #     Required. The finding resource to update or create if it does not already exist.
+        #     parent, security_marks, and update_time will be ignored.
         #
         #     In the case of creation, the finding id portion of the name must be
         #     alphanumeric and less than or equal to 32 characters and greater than 0
@@ -993,7 +1010,7 @@ module Google
         #   @return [::Google::Protobuf::FieldMask]
         #     The FieldMask to use when updating the settings resource.
         #
-        #      If empty all mutable fields will be updated.
+        #     If empty all mutable fields will be updated.
         class UpdateOrganizationSettingsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/securitycenter/v1/source.rb

@@ -47,6 +47,14 @@ module Google
         #     scan and detect four common vulnerabilities, including cross-site-scripting
         #     (XSS), Flash injection, mixed content (HTTP in HTTPS), and
         #     outdated or insecure libraries."
+        # @!attribute [rw] canonical_name
+        #   @return [::String]
+        #     The canonical name of the finding. It's either
+        #     "organizations/\\{organization_id}/sources/\\{source_id}",
+        #     "folders/\\{folder_id}/sources/\\{source_id}" or
+        #     "projects/\\{project_number}/sources/\\{source_id}",
+        #     depending on the closest CRM ancestor of the resource associated with the
+        #     finding.
         class Source
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()