public interface GroupAssetsRequestOrBuilder extends MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
Duration |
getCompareDuration()
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.
|
DurationOrBuilder |
getCompareDurationOrBuilder()
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.
|
String |
getFilter()
Expression that defines the filter to apply across assets.
|
ByteString |
getFilterBytes()
Expression that defines the filter to apply across assets.
|
String |
getGroupBy()
Required.
|
ByteString |
getGroupByBytes()
Required.
|
int |
getPageSize()
The maximum number of results to return in a single response.
|
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.
|
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 |
getParent()
Required.
|
ByteString |
getParentBytes()
Required.
|
Timestamp |
getReadTime()
Time used as a reference point when filtering assets.
|
TimestampOrBuilder |
getReadTimeOrBuilder()
Time used as a reference point when filtering assets.
|
boolean |
hasCompareDuration()
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.
|
boolean |
hasReadTime()
Time used as a reference point when filtering assets.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofisInitializedString getParent()
Required. Name of the organization to groupBy. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
ByteString getParentBytes()
Required. Name of the organization to groupBy. Its format is "organizations/[organization_id], folders/[folder_id], or projects/[project_id]".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
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 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_name_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 : ""`
string filter = 2;ByteString getFilterBytes()
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_name_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 : ""`
string filter = 2;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_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
string group_by = 3 [(.google.api.field_behavior) = REQUIRED];ByteString getGroupByBytes()
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
string group_by = 3 [(.google.api.field_behavior) = REQUIRED];boolean hasCompareDuration()
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`.
.google.protobuf.Duration compare_duration = 4;Duration getCompareDuration()
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`.
.google.protobuf.Duration compare_duration = 4;DurationOrBuilder getCompareDurationOrBuilder()
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`.
.google.protobuf.Duration compare_duration = 4;boolean hasReadTime()
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;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;TimestampOrBuilder getReadTimeOrBuilder()
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;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;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;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;Copyright © 2022 Google LLC. All rights reserved.