# frozen_string_literal: true # Copyright 2020 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 # Request message for creating a finding. # @!attribute [rw] parent # @return [::String] # Required. Resource name of the new finding's parent. Its format should be # "organizations/[organization_id]/sources/[source_id]". # @!attribute [rw] finding_id # @return [::String] # Required. Unique identifier provided by the client within the parent scope. # It must be alphanumeric and less than or equal to 32 characters and # 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. class CreateFindingRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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]". # @!attribute [rw] config_id # @return [::String] # Required. # Unique identifier provided by the client within the parent scope. # It must be between 1 and 128 characters, and contains alphanumeric # 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. class CreateNotificationConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for creating a source. # @!attribute [rw] parent # @return [::String] # Required. Resource name of the new source's parent. Its format should be # "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. class CreateSourceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for deleting a notification config. # @!attribute [rw] name # @return [::String] # Required. Name of the notification config to delete. Its format is # "organizations/[organization_id]/notificationConfigs/[config_id]". class DeleteNotificationConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for getting a notification config. # @!attribute [rw] name # @return [::String] # Required. Name of the notification config to get. Its format is # "organizations/[organization_id]/notificationConfigs/[config_id]". class GetNotificationConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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". class GetOrganizationSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for getting a source. # @!attribute [rw] name # @return [::String] # Required. Relative resource name of the source. Its format is # "organizations/[organization_id]/source/[source_id]". class GetSourceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for grouping by assets. # @!attribute [rw] parent # @return [::String] # Required. Name of the organization to groupBy. Its format is # "organizations/[organization_id]". # @!attribute [rw] filter # @return [::String] # Expression that defines the filter to apply across assets. # The expression is a list of zero or more restrictions combined via logical # operators `AND` and `OR`. # Parentheses are supported, and `OR` has higher precedence than `AND`. # # Restrictions have the form ` ` and may have a `-` # character in front of them to indicate negation. The fields map to those # defined in the Asset resource. Examples include: # # * name # * security_center_properties.resource_name # * resource_properties.a_property # * security_marks.marks.marka # # The supported operators are: # # * `=` for all value types. # * `>`, `<`, `>=`, `<=` for integer values. # * `:`, meaning substring matching, for strings. # # The supported value types are: # # * string literals in quotes. # * integer literals without quotes. # * boolean literals `true` and `false` without quotes. # # The following field and operator combinations are supported: # # * name: `=` # * update_time: `=`, `>`, `<`, `>=`, `<=` # # Usage: This should be milliseconds since epoch or an RFC3339 string. # Examples: # `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` # # * iam_policy.policy_blob: `=`, `:` # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # * security_marks.marks: `=`, `:` # * security_center_properties.resource_name: `=`, `:` # * security_center_properties.resource_display_name: `=`, `:` # * security_center_properties.resource_type: `=`, `:` # * security_center_properties.resource_parent: `=`, `:` # * security_center_properties.resource_parent_display_name: `=`, `:` # * security_center_properties.resource_project: `=`, `:` # * security_center_properties.resource_project_display_name: `=`, `:` # * 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 : ""` # @!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: # "security_center_properties.resource_project,security_center_properties.project". # # The following fields are supported when compare_duration is not set: # # * security_center_properties.resource_project # * security_center_properties.resource_project_display_name # * security_center_properties.resource_type # * security_center_properties.resource_parent # * security_center_properties.resource_parent_display_name # # The following fields are supported when compare_duration is set: # # * security_center_properties.resource_type # * security_center_properties.resource_project_display_name # * security_center_properties.resource_parent_display_name # @!attribute [rw] compare_duration # @return [::Google::Protobuf::Duration] # When compare_duration is set, the GroupResult's "state_change" property is # updated to indicate whether the asset was added, removed, or remained # present during the compare_duration period of time that precedes the # read_time. This is the time between (read_time - compare_duration) and # read_time. # # The state change value is derived based on the presence of the asset at the # two points in time. Intermediate state changes between the two times don't # affect the result. For example, the results aren't affected if the asset is # removed and re-created again. # # Possible "state_change" values when compare_duration is specified: # # * "ADDED": indicates that the asset was not present at the start of # compare_duration, but present at reference_time. # * "REMOVED": indicates that the asset was present at the start of # compare_duration, but not present at reference_time. # * "ACTIVE": indicates that the asset was present at both the # start and the end of the time period defined by # compare_duration and reference_time. # # 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. # # If this field is set then `state_change` must be a specified field in # `group_by`. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used as a reference point when filtering assets. The filter is limited # 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. # @!attribute [rw] page_token # @return [::String] # The value returned by the last `GroupAssetsResponse`; indicates # that this is a continuation of a prior `GroupAssets` call, and that the # system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class GroupAssetsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for grouping by assets. # @!attribute [rw] group_by_results # @return [::Array<::Google::Cloud::SecurityCenter::V1::GroupResult>] # Group results. There exists an element for each existing unique # combination of property/values. The element contains a count for the number # of times those specific property/values appear. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used for executing the groupBy request. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. # @!attribute [rw] total_size # @return [::Integer] # The total number of results matching the query. class GroupAssetsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for grouping by findings. # @!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/- # @!attribute [rw] filter # @return [::String] # Expression that defines the filter to apply across findings. # The expression is a list of one or more restrictions combined via logical # operators `AND` and `OR`. # Parentheses are supported, and `OR` has higher precedence than `AND`. # # Restrictions have the form ` ` and may have a `-` # character in front of them to indicate negation. Examples include: # # * name # * source_properties.a_property # * security_marks.marks.marka # # The supported operators are: # # * `=` for all value types. # * `>`, `<`, `>=`, `<=` for integer values. # * `:`, meaning substring matching, for strings. # # The supported value types are: # # * string literals in quotes. # * integer literals without quotes. # * boolean literals `true` and `false` without quotes. # # The following field and operator combinations are supported: # # * name: `=` # * parent: `=`, `:` # * resource_name: `=`, `:` # * state: `=`, `:` # * category: `=`, `:` # * external_uri: `=`, `:` # * event_time: `=`, `>`, `<`, `>=`, `<=` # * severity: `=`, `:` # # Usage: This should be milliseconds since epoch or an RFC3339 string. # Examples: # `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 : ""` # @!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". # # The following fields are supported: # # * resource_name # * category # * state # * parent # * severity # # The following fields are supported when compare_duration is set: # # * state_change # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used as a reference point when filtering findings. The filter is # limited to findings 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. # @!attribute [rw] compare_duration # @return [::Google::Protobuf::Duration] # When compare_duration is set, the GroupResult's "state_change" attribute is # updated to indicate whether the finding had its state changed, the # finding's state remained unchanged, or if the finding was added during the # compare_duration period of time that precedes the read_time. This is the # time between (read_time - compare_duration) and read_time. # # The state_change value is derived based on the presence and state of the # finding at the two points in time. Intermediate state changes between the # two times don't affect the result. For example, the results aren't affected # if the finding is made inactive and then active again. # # Possible "state_change" values when compare_duration is specified: # # * "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. # # If this field is set then `state_change` must be a specified field in # `group_by`. # @!attribute [rw] page_token # @return [::String] # The value returned by the last `GroupFindingsResponse`; indicates # that this is a continuation of a prior `GroupFindings` call, and # that the system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class GroupFindingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for group by findings. # @!attribute [rw] group_by_results # @return [::Array<::Google::Cloud::SecurityCenter::V1::GroupResult>] # Group results. There exists an element for each existing unique # combination of property/values. The element contains a count for the number # of times those specific property/values appear. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used for executing the groupBy request. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. # @!attribute [rw] total_size # @return [::Integer] # The total number of results matching the query. class GroupFindingsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Result containing the properties and count of a groupBy request. # @!attribute [rw] properties # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}] # Properties matching the groupBy fields in the request. # @!attribute [rw] count # @return [::Integer] # Total count of resources for the given properties. class GroupResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::Google::Protobuf::Value] class PropertiesEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # Request message for listing notification configs. # @!attribute [rw] parent # @return [::String] # Required. Name of the organization to list notification configs. # Its format is "organizations/[organization_id]". # @!attribute [rw] page_token # @return [::String] # The value returned by the last `ListNotificationConfigsResponse`; indicates # that this is a continuation of a prior `ListNotificationConfigs` call, and # that the system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class ListNotificationConfigsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for listing notification configs. # @!attribute [rw] notification_configs # @return [::Array<::Google::Cloud::SecurityCenter::V1::NotificationConfig>] # Notification configs belonging to the requested parent. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. class ListNotificationConfigsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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]". # @!attribute [rw] page_token # @return [::String] # The value returned by the last `ListSourcesResponse`; indicates # that this is a continuation of a prior `ListSources` call, and # that the system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class ListSourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for listing sources. # @!attribute [rw] sources # @return [::Array<::Google::Cloud::SecurityCenter::V1::Source>] # Sources belonging to the requested parent. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. class ListSourcesResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for listing assets. # @!attribute [rw] parent # @return [::String] # Required. Name of the organization assets should belong to. Its format is # "organizations/[organization_id]". # @!attribute [rw] filter # @return [::String] # Expression that defines the filter to apply across assets. # The expression is a list of zero or more restrictions combined via logical # operators `AND` and `OR`. # Parentheses are supported, and `OR` has higher precedence than `AND`. # # Restrictions have the form ` ` and may have a `-` # character in front of them to indicate negation. The fields map to those # defined in the Asset resource. Examples include: # # * name # * security_center_properties.resource_name # * resource_properties.a_property # * security_marks.marks.marka # # The supported operators are: # # * `=` for all value types. # * `>`, `<`, `>=`, `<=` for integer values. # * `:`, meaning substring matching, for strings. # # The supported value types are: # # * string literals in quotes. # * integer literals without quotes. # * boolean literals `true` and `false` without quotes. # # The following are the allowed field and operator combinations: # # * name: `=` # * update_time: `=`, `>`, `<`, `>=`, `<=` # # Usage: This should be milliseconds since epoch or an RFC3339 string. # Examples: # `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` # # * iam_policy.policy_blob: `=`, `:` # * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # * security_marks.marks: `=`, `:` # * security_center_properties.resource_name: `=`, `:` # * security_center_properties.resource_display_name: `=`, `:` # * security_center_properties.resource_type: `=`, `:` # * security_center_properties.resource_parent: `=`, `:` # * security_center_properties.resource_parent_display_name: `=`, `:` # * security_center_properties.resource_project: `=`, `:` # * security_center_properties.resource_project_display_name: `=`, `:` # * 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 : ""` # @!attribute [rw] order_by # @return [::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 # example: "name,resource_properties.a_property". The default sorting order # is ascending. To specify descending order for a field, a suffix " desc" # should be appended to the field name. For example: "name # desc,resource_properties.a_property". Redundant space characters in the # syntax are insignificant. "name desc,resource_properties.a_property" and " # name desc , resource_properties.a_property " are equivalent. # # The following fields are supported: # name # update_time # resource_properties # security_marks.marks # security_center_properties.resource_name # security_center_properties.resource_display_name # security_center_properties.resource_parent # security_center_properties.resource_parent_display_name # security_center_properties.resource_project # security_center_properties.resource_project_display_name # security_center_properties.resource_type # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used as a reference point when filtering assets. The filter is limited # 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. # @!attribute [rw] compare_duration # @return [::Google::Protobuf::Duration] # When compare_duration is set, the ListAssetsResult's "state_change" # attribute is updated to indicate whether the asset was added, removed, or # remained present during the compare_duration period of time that precedes # the read_time. This is the time between (read_time - compare_duration) and # read_time. # # The state_change value is derived based on the presence of the asset at the # two points in time. Intermediate state changes between the two times don't # affect the result. For example, the results aren't affected if the asset is # removed and re-created again. # # Possible "state_change" values when compare_duration is specified: # # * "ADDED": indicates that the asset was not present at the start of # compare_duration, but present at read_time. # * "REMOVED": indicates that the asset was present at the start of # compare_duration, but not present at read_time. # * "ACTIVE": indicates that the asset was present at both the # start and the end of the time period defined by # compare_duration and 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 assets present at # read_time. # @!attribute [rw] field_mask # @return [::Google::Protobuf::FieldMask] # 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 # that this is a continuation of a prior `ListAssets` call, and # that the system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class ListAssetsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for listing assets. # @!attribute [rw] list_assets_results # @return [::Array<::Google::Cloud::SecurityCenter::V1::ListAssetsResponse::ListAssetsResult>] # Assets matching the list request. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used for executing the list request. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. # @!attribute [rw] total_size # @return [::Integer] # The total number of assets matching the query. class ListAssetsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Result containing the Asset and its State. # @!attribute [rw] asset # @return [::Google::Cloud::SecurityCenter::V1::Asset] # Asset matching the search request. # @!attribute [rw] state_change # @return [::Google::Cloud::SecurityCenter::V1::ListAssetsResponse::ListAssetsResult::StateChange] # State change of the asset between the points in time. class ListAssetsResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The change in state of the asset. # # When querying across two points in time this describes # the change between the two points: ADDED, REMOVED, or ACTIVE. # If there was no compare_duration supplied in the request the state change # will be: UNUSED module StateChange # State change is unused, this is the canonical default for this enum. UNUSED = 0 # Asset was added between the points in time. ADDED = 1 # Asset was removed between the points in time. REMOVED = 2 # Asset was present at both point(s) in time. ACTIVE = 3 end end end # Request message for listing findings. # @!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/- # @!attribute [rw] filter # @return [::String] # Expression that defines the filter to apply across findings. # The expression is a list of one or more restrictions combined via logical # operators `AND` and `OR`. # Parentheses are supported, and `OR` has higher precedence than `AND`. # # Restrictions have the form ` ` and may have a `-` # character in front of them to indicate negation. Examples include: # # * name # * source_properties.a_property # * security_marks.marks.marka # # The supported operators are: # # * `=` for all value types. # * `>`, `<`, `>=`, `<=` for integer values. # * `:`, meaning substring matching, for strings. # # The supported value types are: # # * string literals in quotes. # * integer literals without quotes. # * boolean literals `true` and `false` without quotes. # # The following field and operator combinations are supported: # # * name: `=` # * parent: `=`, `:` # * resource_name: `=`, `:` # * state: `=`, `:` # * category: `=`, `:` # * external_uri: `=`, `:` # * event_time: `=`, `>`, `<`, `>=`, `<=` # * severity: `=`, `:` # # Usage: This should be milliseconds since epoch or an RFC3339 string. # Examples: # `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 : ""` # @!attribute [rw] order_by # @return [::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 # example: "name,resource_properties.a_property". The default sorting order # is ascending. To specify descending order for a field, a suffix " desc" # should be appended to the field name. For example: "name # desc,source_properties.a_property". Redundant space characters in the # syntax are insignificant. "name desc,source_properties.a_property" and " # name desc , source_properties.a_property " are equivalent. # # The following fields are supported: # name # parent # state # category # resource_name # event_time # source_properties # security_marks.marks # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used as a reference point when filtering findings. The filter is # limited to findings 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. # @!attribute [rw] compare_duration # @return [::Google::Protobuf::Duration] # When compare_duration is set, the ListFindingsResult's "state_change" # attribute is updated to indicate whether the finding had its state changed, # the finding's state remained unchanged, or if the finding was added in any # state during the compare_duration period of time that precedes the # read_time. This is the time between (read_time - compare_duration) and # read_time. # # The state_change value is derived based on the presence and state of the # finding at the two points in time. Intermediate state changes between the # two times don't affect the result. For example, the results aren't affected # if the finding is made inactive and then active again. # # Possible "state_change" values when compare_duration is specified: # # * "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. # @!attribute [rw] field_mask # @return [::Google::Protobuf::FieldMask] # 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 # that this is a continuation of a prior `ListFindings` call, and # that the system should return the next page of data. # @!attribute [rw] page_size # @return [::Integer] # The maximum number of results to return in a single response. Default is # 10, minimum is 1, maximum is 1000. class ListFindingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Response message for listing findings. # @!attribute [rw] list_findings_results # @return [::Array<::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult>] # Findings matching the list request. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Time used for executing the list request. # @!attribute [rw] next_page_token # @return [::String] # Token to retrieve the next page of results, or empty if there are no more # results. # @!attribute [rw] total_size # @return [::Integer] # The total number of findings matching the query. class ListFindingsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Result containing the Finding and its StateChange. # @!attribute [rw] finding # @return [::Google::Cloud::SecurityCenter::V1::Finding] # Finding matching the search request. # @!attribute [rw] state_change # @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::StateChange] # State change of the finding between the points in time. # @!attribute [r] resource # @return [::Google::Cloud::SecurityCenter::V1::ListFindingsResponse::ListFindingsResult::Resource] # Output only. Resource that is associated with this finding. class ListFindingsResult include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Information related to the Google Cloud resource that is # associated with this finding. # @!attribute [rw] name # @return [::String] # The full resource name of the resource. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # @!attribute [rw] project_name # @return [::String] # The full resource name of project that the resource belongs to. # @!attribute [rw] project_display_name # @return [::String] # The human readable name of project that the resource belongs to. # @!attribute [rw] parent_name # @return [::String] # The full resource name of resource's parent. # @!attribute [rw] parent_display_name # @return [::String] # The human readable name of resource's parent. class Resource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The change in state of the finding. # # When querying across two points in time this describes # the change in the finding between the two points: CHANGED, UNCHANGED, # ADDED, or REMOVED. Findings can not be deleted, so REMOVED implies that # the finding at timestamp does not match the filter specified, but it did # at timestamp - compare_duration. If there was no compare_duration # supplied in the request the state change will be: UNUSED module StateChange # State change is unused, this is the canonical default for this enum. UNUSED = 0 # The finding has changed state in some way between the points in time # and existed at both points. CHANGED = 1 # The finding has not changed state between the points in time and # existed at both points. UNCHANGED = 2 # The finding was created between the points in time. ADDED = 3 # The finding at timestamp does not match the filter specified, but it # did at timestamp - compare_duration. REMOVED = 4 end end end # Request message for updating a finding's state. # @!attribute [rw] name # @return [::String] # Required. The relative resource name of the finding. See: # https://cloud.google.com/apis/design/resource_names#relative_resource_name # Example: # "organizations/\\{organization_id}/sources/\\{source_id}/finding/\\{finding_id}". # @!attribute [rw] state # @return [::Google::Cloud::SecurityCenter::V1::Finding::State] # Required. The desired State of the finding. # @!attribute [rw] start_time # @return [::Google::Protobuf::Timestamp] # Required. The time at which the updated state takes effect. class SetFindingStateRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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]". class RunAssetDiscoveryRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # 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. # # 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 # characters in length. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The FieldMask to use when updating the finding resource. This field should # not be specified when creating a finding. # # When updating a finding, an empty mask is treated as updating all mutable # fields and replacing source_properties. Individual source_properties can # be added/updated by using "source_properties." in the field # mask. class UpdateFindingRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for updating a notification config. # @!attribute [rw] notification_config # @return [::Google::Cloud::SecurityCenter::V1::NotificationConfig] # Required. The notification config to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The FieldMask to use when updating the notification config. # # If empty all mutable fields will be updated. class UpdateNotificationConfigRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for updating an organization's settings. # @!attribute [rw] organization_settings # @return [::Google::Cloud::SecurityCenter::V1::OrganizationSettings] # Required. The organization settings resource to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The FieldMask to use when updating the settings resource. # # If empty all mutable fields will be updated. class UpdateOrganizationSettingsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for updating a source. # @!attribute [rw] source # @return [::Google::Cloud::SecurityCenter::V1::Source] # Required. The source resource to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The FieldMask to use when updating the source resource. # # If empty all mutable fields will be updated. class UpdateSourceRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for updating a SecurityMarks resource. # @!attribute [rw] security_marks # @return [::Google::Cloud::SecurityCenter::V1::SecurityMarks] # Required. The security marks resource to update. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] # The FieldMask to use when updating the security marks resource. # # The field mask must not contain duplicate fields. # If empty or set to "marks", all marks will be replaced. Individual # marks can be updated using "marks.". # @!attribute [rw] start_time # @return [::Google::Protobuf::Timestamp] # The time at which the updated SecurityMarks take effect. # If not set uses current server time. Updates will be applied to the # SecurityMarks that are active immediately preceding this time. class UpdateSecurityMarksRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end