public final class ListFindingsRequest extends GeneratedMessageV3 implements ListFindingsRequestOrBuilder
Request message for listing findings.
Protobuf type google.cloud.securitycenter.v1.ListFindingsRequest
Static Fields
COMPARE_DURATION_FIELD_NUMBER
public static final int COMPARE_DURATION_FIELD_NUMBER
Field Value
FIELD_MASK_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListFindingsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListFindingsRequest.Builder newBuilder()
Returns
newBuilder(ListFindingsRequest prototype)
public static ListFindingsRequest.Builder newBuilder(ListFindingsRequest prototype)
Parameter
Returns
public static ListFindingsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListFindingsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListFindingsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListFindingsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListFindingsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFindingsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFindingsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListFindingsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFindingsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListFindingsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListFindingsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListFindingsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListFindingsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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.
|
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;
getDefaultInstanceForType()
public ListFindingsRequest getDefaultInstanceForType()
Returns
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;
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;
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 and false 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 and false 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;
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;
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;
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) = { ... }
getParserForType()
public Parser<ListFindingsRequest> getParserForType()
Returns
Overrides
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListFindingsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListFindingsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListFindingsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
