Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings
See: Cloud Security Command Center API Reference for securitycenter.organizations.sources.findings.list
.
Synopsis
- type OrganizationsSourcesFindingsListResource = "v1" :> (Capture "parent" Text :> ("findings" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "fieldMask" GFieldMask :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "compareDuration" GDuration :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListFindingsResponse)))))))))))))))
- organizationsSourcesFindingsList :: Text -> OrganizationsSourcesFindingsList
- data OrganizationsSourcesFindingsList
- osflParent :: Lens' OrganizationsSourcesFindingsList Text
- osflXgafv :: Lens' OrganizationsSourcesFindingsList (Maybe Xgafv)
- osflReadTime :: Lens' OrganizationsSourcesFindingsList (Maybe UTCTime)
- osflUploadProtocol :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflOrderBy :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflAccessToken :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflUploadType :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflFieldMask :: Lens' OrganizationsSourcesFindingsList (Maybe GFieldMask)
- osflFilter :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflPageToken :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
- osflPageSize :: Lens' OrganizationsSourcesFindingsList (Maybe Int32)
- osflCompareDuration :: Lens' OrganizationsSourcesFindingsList (Maybe Scientific)
- osflCallback :: Lens' OrganizationsSourcesFindingsList (Maybe Text)
REST Resource
type OrganizationsSourcesFindingsListResource = "v1" :> (Capture "parent" Text :> ("findings" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "readTime" DateTime' :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "fieldMask" GFieldMask :> (QueryParam "filter" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "compareDuration" GDuration :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListFindingsResponse))))))))))))))) Source #
A resource alias for securitycenter.organizations.sources.findings.list
method which the
OrganizationsSourcesFindingsList
request conforms to.
Creating a Request
organizationsSourcesFindingsList Source #
Creates a value of OrganizationsSourcesFindingsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data OrganizationsSourcesFindingsList Source #
Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/123/sources/-/findings
See: organizationsSourcesFindingsList
smart constructor.
Instances
Request Lenses
osflParent :: Lens' OrganizationsSourcesFindingsList Text Source #
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/123/sources/-
osflReadTime :: Lens' OrganizationsSourcesFindingsList (Maybe UTCTime) Source #
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.
osflUploadProtocol :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
osflOrderBy :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
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
osflAccessToken :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
OAuth access token.
osflUploadType :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
osflFieldMask :: Lens' OrganizationsSourcesFindingsList (Maybe GFieldMask) Source #
Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
osflFilter :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
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 | `>`, `<`, `>=`, `<=` security_marks | '=', ':' source_properties | '=', ':', `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string.
osflPageToken :: Lens' OrganizationsSourcesFindingsList (Maybe Text) Source #
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.
osflPageSize :: Lens' OrganizationsSourcesFindingsList (Maybe Int32) Source #
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
osflCompareDuration :: Lens' OrganizationsSourcesFindingsList (Maybe Scientific) Source #
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 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. 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.