- 2.60.0 (latest)
- 2.59.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.1
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.1
- 2.6.0
- 2.5.6
- 2.3.2
public static final class GroupAssetsRequest.Builder extends GeneratedMessageV3.Builder<GroupAssetsRequest.Builder> implements GroupAssetsRequestOrBuilder
Request message for grouping by assets.
Protobuf type google.cloud.securitycenter.v1.GroupAssetsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroupAssetsRequest.BuilderImplements
GroupAssetsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GroupAssetsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
build()
public GroupAssetsRequest build()
Returns | |
---|---|
Type | Description |
GroupAssetsRequest |
buildPartial()
public GroupAssetsRequest buildPartial()
Returns | |
---|---|
Type | Description |
GroupAssetsRequest |
clear()
public GroupAssetsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
clearCompareDuration()
public GroupAssetsRequest.Builder clearCompareDuration()
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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public GroupAssetsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
clearFilter()
public GroupAssetsRequest.Builder clearFilter()
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
andfalse
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 : ""
string filter = 2;
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
clearGroupBy()
public GroupAssetsRequest.Builder clearGroupBy()
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];
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GroupAssetsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
clearPageSize()
public GroupAssetsRequest.Builder clearPageSize()
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 |
GroupAssetsRequest.Builder |
This builder for chaining. |
clearPageToken()
public GroupAssetsRequest.Builder clearPageToken()
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 |
GroupAssetsRequest.Builder |
This builder for chaining. |
clearParent()
public GroupAssetsRequest.Builder clearParent()
Required. The name of the parent to group the assets by. 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) = { ... }
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
clearReadTime()
public GroupAssetsRequest.Builder clearReadTime()
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 |
GroupAssetsRequest.Builder |
clone()
public GroupAssetsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
getCompareDuration()
public 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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Returns | |
---|---|
Type | Description |
Duration |
The compareDuration. |
getCompareDurationBuilder()
public Duration.Builder getCompareDurationBuilder()
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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Returns | |
---|---|
Type | Description |
Builder |
getCompareDurationOrBuilder()
public 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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getDefaultInstanceForType()
public GroupAssetsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
GroupAssetsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public 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
andfalse
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 : ""
string filter = 2;
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public 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
andfalse
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 : ""
string filter = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getGroupBy()
public 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];
Returns | |
---|---|
Type | Description |
String |
The groupBy. |
getGroupByBytes()
public 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];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for groupBy. |
getPageSize()
public 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 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 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 String getParent()
Required. The name of the parent to group the assets by. 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) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The name of the parent to group the assets by. 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
getReadTime()
public 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. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()
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 |
Builder |
getReadTimeOrBuilder()
public 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;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
hasCompareDuration()
public 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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Returns | |
---|---|
Type | Description |
boolean |
Whether the compareDuration field is set. |
hasReadTime()
public 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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the readTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCompareDuration(Duration value)
public GroupAssetsRequest.Builder mergeCompareDuration(Duration value)
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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
mergeFrom(GroupAssetsRequest other)
public GroupAssetsRequest.Builder mergeFrom(GroupAssetsRequest other)
Parameter | |
---|---|
Name | Description |
other |
GroupAssetsRequest |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GroupAssetsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public GroupAssetsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
mergeReadTime(Timestamp value)
public GroupAssetsRequest.Builder mergeReadTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GroupAssetsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setCompareDuration(Duration value)
public GroupAssetsRequest.Builder setCompareDuration(Duration value)
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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setCompareDuration(Duration.Builder builderForValue)
public GroupAssetsRequest.Builder setCompareDuration(Duration.Builder builderForValue)
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 ingroup_by
.
.google.protobuf.Duration compare_duration = 4;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public GroupAssetsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setFilter(String value)
public GroupAssetsRequest.Builder setFilter(String value)
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
andfalse
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 : ""
string filter = 2;
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public GroupAssetsRequest.Builder setFilterBytes(ByteString value)
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
andfalse
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 : ""
string filter = 2;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setGroupBy(String value)
public GroupAssetsRequest.Builder setGroupBy(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The groupBy to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setGroupByBytes(ByteString value)
public GroupAssetsRequest.Builder setGroupByBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for groupBy to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public GroupAssetsRequest.Builder setPageSize(int value)
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
int32 page_size = 8;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public GroupAssetsRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public GroupAssetsRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setParent(String value)
public GroupAssetsRequest.Builder setParent(String value)
Required. The name of the parent to group the assets by. 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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public GroupAssetsRequest.Builder setParentBytes(ByteString value)
Required. The name of the parent to group the assets by. 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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
This builder for chaining. |
setReadTime(Timestamp value)
public GroupAssetsRequest.Builder setReadTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setReadTime(Timestamp.Builder builderForValue)
public GroupAssetsRequest.Builder setReadTime(Timestamp.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GroupAssetsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final GroupAssetsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
GroupAssetsRequest.Builder |