- 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 ListFindingsRequest.Builder extends GeneratedMessageV3.Builder<ListFindingsRequest.Builder> implements ListFindingsRequestOrBuilder
Request message for listing findings.
Protobuf type google.cloud.securitycenter.v1.ListFindingsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFindingsRequest.BuilderImplements
ListFindingsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListFindingsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListFindingsRequest.Builder |
build()
public ListFindingsRequest build()
Type | Description |
ListFindingsRequest |
buildPartial()
public ListFindingsRequest buildPartial()
Type | Description |
ListFindingsRequest |
clear()
public ListFindingsRequest.Builder clear()
Type | Description |
ListFindingsRequest.Builder |
clearCompareDuration()
public ListFindingsRequest.Builder clearCompareDuration()
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Type | Description |
ListFindingsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListFindingsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
ListFindingsRequest.Builder |
clearFieldMask()
public ListFindingsRequest.Builder clearFieldMask()
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Type | Description |
ListFindingsRequest.Builder |
clearFilter()
public ListFindingsRequest.Builder clearFilter()
Expression that defines the filter to apply across findings.
The expression is a list of one 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. Examples include:
- name
- source_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:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,source_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
string filter = 2;
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListFindingsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
ListFindingsRequest.Builder |
clearOrderBy()
public ListFindingsRequest.Builder clearOrderBy()
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
string order_by = 3;
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
clearPageSize()
public ListFindingsRequest.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 = 9;
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListFindingsRequest.Builder clearPageToken()
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
string page_token = 8;
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
clearParent()
public ListFindingsRequest.Builder clearParent()
Required. Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across all sources
provide a source_id of -
. For example:
organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
clearReadTime()
public ListFindingsRequest.Builder clearReadTime()
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Type | Description |
ListFindingsRequest.Builder |
clone()
public ListFindingsRequest.Builder clone()
Type | Description |
ListFindingsRequest.Builder |
getCompareDuration()
public Duration getCompareDuration()
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Type | Description |
Duration | The compareDuration. |
getCompareDurationBuilder()
public Duration.Builder getCompareDurationBuilder()
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Type | Description |
Builder |
getCompareDurationOrBuilder()
public DurationOrBuilder getCompareDurationOrBuilder()
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Type | Description |
DurationOrBuilder |
getDefaultInstanceForType()
public ListFindingsRequest getDefaultInstanceForType()
Type | Description |
ListFindingsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getFieldMask()
public FieldMask getFieldMask()
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Type | Description |
FieldMask | The fieldMask. |
getFieldMaskBuilder()
public FieldMask.Builder getFieldMaskBuilder()
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Type | Description |
Builder |
getFieldMaskOrBuilder()
public FieldMaskOrBuilder getFieldMaskOrBuilder()
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Type | Description |
FieldMaskOrBuilder |
getFilter()
public String getFilter()
Expression that defines the filter to apply across findings.
The expression is a list of one 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. Examples include:
- name
- source_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:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,source_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
string filter = 2;
Type | Description |
String | The filter. |
getFilterBytes()
public ByteString getFilterBytes()
Expression that defines the filter to apply across findings.
The expression is a list of one 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. Examples include:
- name
- source_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:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,source_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
string filter = 2;
Type | Description |
ByteString | The bytes for filter. |
getOrderBy()
public String getOrderBy()
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
string order_by = 3;
Type | Description |
String | The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
string order_by = 3;
Type | Description |
ByteString | The bytes for orderBy. |
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 = 9;
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
string page_token = 8;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
string page_token = 8;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent()
Required. Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across all sources
provide a source_id of -
. For example:
organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across all sources
provide a source_id of -
. For example:
organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getReadTime()
public Timestamp getReadTime()
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Type | Description |
Timestamp | The readTime. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder()
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Type | Description |
Builder |
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder()
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Type | Description |
TimestampOrBuilder |
hasCompareDuration()
public boolean hasCompareDuration()
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Type | Description |
boolean | Whether the compareDuration field is set. |
hasFieldMask()
public boolean hasFieldMask()
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Type | Description |
boolean | Whether the fieldMask field is set. |
hasReadTime()
public boolean hasReadTime()
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Type | Description |
boolean | Whether the readTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeCompareDuration(Duration value)
public ListFindingsRequest.Builder mergeCompareDuration(Duration value)
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Name | Description |
value | Duration |
Type | Description |
ListFindingsRequest.Builder |
mergeFieldMask(FieldMask value)
public ListFindingsRequest.Builder mergeFieldMask(FieldMask value)
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Name | Description |
value | FieldMask |
Type | Description |
ListFindingsRequest.Builder |
mergeFrom(ListFindingsRequest other)
public ListFindingsRequest.Builder mergeFrom(ListFindingsRequest other)
Name | Description |
other | ListFindingsRequest |
Type | Description |
ListFindingsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListFindingsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListFindingsRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public ListFindingsRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
ListFindingsRequest.Builder |
mergeReadTime(Timestamp value)
public ListFindingsRequest.Builder mergeReadTime(Timestamp value)
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Name | Description |
value | Timestamp |
Type | Description |
ListFindingsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListFindingsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListFindingsRequest.Builder |
setCompareDuration(Duration value)
public ListFindingsRequest.Builder setCompareDuration(Duration value)
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Name | Description |
value | Duration |
Type | Description |
ListFindingsRequest.Builder |
setCompareDuration(Duration.Builder builderForValue)
public ListFindingsRequest.Builder setCompareDuration(Duration.Builder builderForValue)
When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state 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 and state of the finding 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 finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
.google.protobuf.Duration compare_duration = 5;
Name | Description |
builderForValue | Builder |
Type | Description |
ListFindingsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListFindingsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListFindingsRequest.Builder |
setFieldMask(FieldMask value)
public ListFindingsRequest.Builder setFieldMask(FieldMask value)
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Name | Description |
value | FieldMask |
Type | Description |
ListFindingsRequest.Builder |
setFieldMask(FieldMask.Builder builderForValue)
public ListFindingsRequest.Builder setFieldMask(FieldMask.Builder builderForValue)
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.
.google.protobuf.FieldMask field_mask = 7;
Name | Description |
builderForValue | Builder |
Type | Description |
ListFindingsRequest.Builder |
setFilter(String value)
public ListFindingsRequest.Builder setFilter(String value)
Expression that defines the filter to apply across findings.
The expression is a list of one 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. Examples include:
- name
- source_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:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,source_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
string filter = 2;
Name | Description |
value | String The filter to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListFindingsRequest.Builder setFilterBytes(ByteString value)
Expression that defines the filter to apply across findings.
The expression is a list of one 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. Examples include:
- name
- source_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:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,source_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
string filter = 2;
Name | Description |
value | ByteString The bytes for filter to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public ListFindingsRequest.Builder setOrderBy(String value)
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
string order_by = 3;
Name | Description |
value | String The orderBy to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public ListFindingsRequest.Builder setOrderByBytes(ByteString value)
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks
string order_by = 3;
Name | Description |
value | ByteString The bytes for orderBy to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListFindingsRequest.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 = 9;
Name | Description |
value | int The pageSize to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListFindingsRequest.Builder setPageToken(String value)
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
string page_token = 8;
Name | Description |
value | String The pageToken to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListFindingsRequest.Builder setPageTokenBytes(ByteString value)
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
string page_token = 8;
Name | Description |
value | ByteString The bytes for pageToken to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListFindingsRequest.Builder setParent(String value)
Required. Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across all sources
provide a source_id of -
. For example:
organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListFindingsRequest.Builder setParentBytes(ByteString value)
Required. Name of the source the findings belong to. Its format is
"organizations/[organization_id]/sources/[source_id],
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]". To list across all sources
provide a source_id of -
. For example:
organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or
projects/{projects_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
ListFindingsRequest.Builder | This builder for chaining. |
setReadTime(Timestamp value)
public ListFindingsRequest.Builder setReadTime(Timestamp value)
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Name | Description |
value | Timestamp |
Type | Description |
ListFindingsRequest.Builder |
setReadTime(Timestamp.Builder builderForValue)
public ListFindingsRequest.Builder setReadTime(Timestamp.Builder builderForValue)
Time used as a reference point when filtering findings. The filter is limited to findings 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 = 4;
Name | Description |
builderForValue | Builder |
Type | Description |
ListFindingsRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListFindingsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
ListFindingsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListFindingsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListFindingsRequest.Builder |