Class GroupAssetsRequest (1.11.0)

GroupAssetsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for grouping by assets.

Attributes

NameDescription
parent str
Required. Name of the organization to groupBy. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
filter str
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 ``
group_by str
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 google.protobuf.duration_pb2.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 google.protobuf.timestamp_pb2.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 str
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 int
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

Inheritance

builtins.object > proto.message.Message > GroupAssetsRequest