Interface GroupAssetsRequestOrBuilder (2.47.0)

public interface GroupAssetsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCompareDuration()

public abstract Duration getCompareDuration()

When compare_duration is set, the Asset's "state" 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 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" values when compare_duration is specified:

"ADDED": indicates that the asset was not present before 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.

This field is ignored if state is not a field in group_by.

.google.protobuf.Duration compare_duration = 4;

Returns
Type	Description
`Duration`	The compareDuration.

getCompareDurationOrBuilder()

public abstract DurationOrBuilder getCompareDurationOrBuilder()

Possible "state" values when compare_duration is specified:

"ADDED": indicates that the asset was not present before 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.

This field is ignored if state is not a field in group_by.

.google.protobuf.Duration compare_duration = 4;

Returns
Type	Description
`DurationOrBuilder`

getFilter()

public abstract String getFilter()

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 not 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.

For example, resource_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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.

For example, resource_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
Type	Description
`ByteString`	The bytes for filter.

getGroupBy()

public abstract String getGroupBy()

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_type
security_center_properties.resource_parent

The following fields are supported when compare_duration is set:
security_center_properties.resource_type

string group_by = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The groupBy.

getGroupByBytes()

public abstract ByteString getGroupByBytes()

The following fields are supported when compare_duration is not set:

security_center_properties.resource_project
security_center_properties.resource_type
security_center_properties.resource_parent

The following fields are supported when compare_duration is set:
security_center_properties.resource_type

string group_by = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for groupBy.

getPageSize()

public abstract int getPageSize()

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

int32 page_size = 8;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 7;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 7;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]".

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]".

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getReadTime()

public abstract Timestamp getReadTime()

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.

.google.protobuf.Timestamp read_time = 5;

Returns
Type	Description
`Timestamp`	The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

.google.protobuf.Timestamp read_time = 5;

Returns
Type	Description
`TimestampOrBuilder`

hasCompareDuration()

public abstract boolean hasCompareDuration()

Possible "state" values when compare_duration is specified:

"ADDED": indicates that the asset was not present before 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.

This field is ignored if state is not a field in group_by.

.google.protobuf.Duration compare_duration = 4;

Returns
Type	Description
`boolean`	Whether the compareDuration field is set.

hasReadTime()

public abstract boolean hasReadTime()

.google.protobuf.Timestamp read_time = 5;

Returns
Type	Description
`boolean`	Whether the readTime field is set.