Struct google_api_proto::google::cloud::securitycenter::v2::ListFindingsRequest

pub struct ListFindingsRequest {
    pub parent: String,
    pub filter: String,
    pub order_by: String,
    pub field_mask: Option<FieldMask>,
    pub page_token: String,
    pub page_size: i32,
}

Request message for listing findings.

Fields

parent: String

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

• organizations/\[organization_id\]/sources/\[source_id\]

organizations/\[organization_id\]/sources/\[source_id\]/locations/\[location_id\]

• folders/\[folder_id\]/sources/\[source_id\]
• folders/\[folder_id\]/sources/\[source_id\]/locations/\[location_id\]
• projects/\[project_id\]/sources/\[source_id\]
• projects/\[project_id\]/sources/\[source_id\]/locations/\[location_id\]

To list across all sources provide a source_id of -. The following list shows some examples:

• organizations/{organization_id}/sources/-
• organizations/{organization_id}/sources/-/locations/{location_id}
• folders/{folder_id}/sources/-
• folders/{folder_id}/sources/-locations/{location_id}
• projects/{projects_id}/sources/-
• projects/{projects_id}/sources/-/locations/{location_id}

filter: 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 <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include:

• name
• 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: =, :

• security_marks.marks: =, :

• 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: =, :

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 example: “name,parent”. 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,parent”. Redundant space characters in the syntax are insignificant. “name desc,parent” and “ name desc , parent “ are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

field_mask: Option<FieldMask>

A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.

page_token: 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.

page_size: i32

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Trait Implementations

impl Clone for ListFindingsRequest

fn clone(&self) -> ListFindingsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListFindingsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListFindingsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListFindingsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ListFindingsRequest

fn eq(&self, other: &ListFindingsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListFindingsRequest