public final class GroupFindingsRequest extends GeneratedMessageV3 implements GroupFindingsRequestOrBuilder
Request message for grouping by findings.
Protobuf type google.cloud.securitycenter.v2.GroupFindingsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GROUP_BY_FIELD_NUMBER
public static final int GROUP_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GroupFindingsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GroupFindingsRequest.Builder newBuilder()
newBuilder(GroupFindingsRequest prototype)
public static GroupFindingsRequest.Builder newBuilder(GroupFindingsRequest prototype)
public static GroupFindingsRequest parseDelimitedFrom(InputStream input)
public static GroupFindingsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GroupFindingsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GroupFindingsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GroupFindingsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GroupFindingsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GroupFindingsRequest parseFrom(CodedInputStream input)
public static GroupFindingsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GroupFindingsRequest parseFrom(InputStream input)
public static GroupFindingsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GroupFindingsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GroupFindingsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GroupFindingsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public GroupFindingsRequest getDefaultInstanceForType()
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
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:
=, :
- security_marks.marks:
=, :
- resource:
- resource.name:
=, :
- resource.parent_name:
=, :
- resource.parent_display_name:
=, :
- resource.project_name:
=, :
- resource.project_display_name:
=, :
- resource.type:
=, :
string filter = 2;
| Returns |
| 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
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:
=, :
- security_marks.marks:
=, :
- resource:
- resource.name:
=, :
- resource.parent_name:
=, :
- resource.parent_display_name:
=, :
- resource.project_name:
=, :
- resource.project_display_name:
=, :
- resource.type:
=, :
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: "parent,resource_name".
The following fields are supported:
- resource_name
- category
- state
- parent
- severity
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: "parent,resource_name".
The following fields are supported:
- resource_name
- category
- state
- parent
- severity
string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for groupBy.
|
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 GroupFindingsResponse; indicates
that this is a continuation of a prior GroupFindings 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 GroupFindingsResponse; indicates
that this is a continuation of a prior GroupFindings 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. Name of the source to groupBy. If no location is specified,
finding is assumed to be in global.
The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
+
organizations/[organization_id]/sources/[source_id]/locations/[location_id]folders/[folder_id]/sources/[source_id]folders/[folder_id]/sources/[source_id]/locations/[location_id]projects/[project_id]/sources/[source_id]projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of -. The following
list shows some examples:
organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/[location_id]folders/{folder_id}/sources/-folders/{folder_id}/sources/-/locations/[location_id]projects/{project_id}/sources/-projects/{project_id}/sources/-/locations/[location_id]
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. Name of the source to groupBy. If no location is specified,
finding is assumed to be in global.
The following list shows some examples:
organizations/[organization_id]/sources/[source_id]
+
organizations/[organization_id]/sources/[source_id]/locations/[location_id]folders/[folder_id]/sources/[source_id]folders/[folder_id]/sources/[source_id]/locations/[location_id]projects/[project_id]/sources/[source_id]projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of -. The following
list shows some examples:
organizations/{organization_id}/sources/-
organizations/{organization_id}/sources/-/locations/[location_id]folders/{folder_id}/sources/-folders/{folder_id}/sources/-/locations/[location_id]projects/{project_id}/sources/-projects/{project_id}/sources/-/locations/[location_id]
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<GroupFindingsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GroupFindingsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GroupFindingsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GroupFindingsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
