Struct gapi_grpc::google::cloud::securitycenter::v1::GroupAssetsRequest

pub struct GroupAssetsRequest {
    pub parent: String,
    pub filter: String,
    pub group_by: String,
    pub compare_duration: Option<Duration>,
    pub read_time: Option<Timestamp>,
    pub page_token: String,
    pub page_size: i32,
}

Request message for grouping by assets.

Fields

parent: String

Required. Name of the organization to groupBy. Its format is “organizations/[organization_id], folders/[folder_id], or projects/[project_id]”.

filter: 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 <field> <operator> <value> 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 : ""

group_by: 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

compare_duration: Option<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.

read_time: Option<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.

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

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 GroupAssetsRequest

fn clone(&self) -> GroupAssetsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupAssetsRequest

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

Formats the value using the given formatter.

impl Default for GroupAssetsRequest

fn default() -> GroupAssetsRequest

Returns the “default value” for a type.

impl Message for GroupAssetsRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<GroupAssetsRequest> for GroupAssetsRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for GroupAssetsRequest