pub struct FolderSourceFindingListCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Lists an organization or source’s findings. To list across all sources provide a - as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings
A builder for the sources.findings.list method supported by a folder resource.
It is not used directly, but through a FolderMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.folders().sources_findings_list("parent")
.read_time(chrono::Utc::now())
.page_token("dolore")
.page_size(-34)
.order_by("voluptua.")
.filter("amet.")
.field_mask(&Default::default())
.compare_duration(chrono::Duration::seconds(846145))
.doit().await;Implementations§
source§impl<'a, S> FolderSourceFindingListCall<'a, S>
impl<'a, S> FolderSourceFindingListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListFindingsResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListFindingsResponse)>
Perform the operation you have build so far.
sourcepub fn parent(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
pub fn parent(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
Required. Name of the source the findings belong to. Its format is “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/-
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn read_time(
self,
new_value: DateTime<Utc>
) -> FolderSourceFindingListCall<'a, S>
pub fn read_time( self, new_value: DateTime<Utc> ) -> FolderSourceFindingListCall<'a, S>
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.
Sets the read time query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
pub fn page_token(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
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.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> FolderSourceFindingListCall<'a, S>
pub fn page_size(self, new_value: i32) -> FolderSourceFindingListCall<'a, S>
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
Sets the page size query property to the given value.
sourcepub fn order_by(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
pub fn order_by(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
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
Sets the order by query property to the given value.
sourcepub fn filter(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
pub fn filter(self, new_value: &str) -> FolderSourceFindingListCall<'a, S>
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: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: event_time = "2019-06-10T16:07:18-07:00" event_time = 1560208038000 * severity: =, : * workflow_state: =, : * 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 : "" * resource: * resource.name: =, : * resource.parent_name: =, : * resource.parent_display_name: =, : * resource.project_name: =, : * resource.project_display_name: =, : * resource.type: =, : * resource.folders.resource_folder: =, : * resource.display_name: =, :
Sets the filter query property to the given value.
sourcepub fn field_mask(
self,
new_value: FieldMask
) -> FolderSourceFindingListCall<'a, S>
pub fn field_mask( self, new_value: FieldMask ) -> FolderSourceFindingListCall<'a, S>
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
Sets the field mask query property to the given value.
sourcepub fn compare_duration(
self,
new_value: Duration
) -> FolderSourceFindingListCall<'a, S>
pub fn compare_duration( self, new_value: Duration ) -> FolderSourceFindingListCall<'a, S>
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.
Sets the compare duration query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> FolderSourceFindingListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> FolderSourceFindingListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> FolderSourceFindingListCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FolderSourceFindingListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> FolderSourceFindingListCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FolderSourceFindingListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::CloudPlatform.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> FolderSourceFindingListCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FolderSourceFindingListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> FolderSourceFindingListCall<'a, S>
pub fn clear_scopes(self) -> FolderSourceFindingListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).