public final class GroupFindingsRequest extends GeneratedMessageV3 implements GroupFindingsRequestOrBuilder
Request message for grouping by findings.Protobuf type
google.cloud.securitycenter.v1p1beta1.GroupFindingsRequest
Modifier and Type | Class and Description |
---|---|
static class |
GroupFindingsRequest.Builder
Request message for grouping by findings.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
AbstractMessageLite.InternalOneOfEnum
Modifier and Type | Field and Description |
---|---|
static int |
COMPARE_DURATION_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
GROUP_BY_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
READ_TIME_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
Duration |
getCompareDuration()
When compare_duration is set, the GroupResult'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 during the
compare_duration period of time that precedes the read_time.
|
DurationOrBuilder |
getCompareDurationOrBuilder()
When compare_duration is set, the GroupResult'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 during the
compare_duration period of time that precedes the read_time.
|
static GroupFindingsRequest |
getDefaultInstance() |
GroupFindingsRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
String |
getFilter()
Expression that defines the filter to apply across findings.
|
ByteString |
getFilterBytes()
Expression that defines the filter to apply across findings.
|
String |
getGroupBy()
Required.
|
ByteString |
getGroupByBytes()
Required.
|
int |
getPageSize()
The maximum number of results to return in a single response.
|
String |
getPageToken()
The value returned by the last `GroupFindingsResponse`; indicates
that this is a continuation of a prior `GroupFindings` call, and
that the system should return the next page of data.
|
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 |
getParent()
Required.
|
ByteString |
getParentBytes()
Required.
|
Parser<GroupFindingsRequest> |
getParserForType() |
Timestamp |
getReadTime()
Time used as a reference point when filtering findings.
|
TimestampOrBuilder |
getReadTimeOrBuilder()
Time used as a reference point when filtering findings.
|
int |
getSerializedSize() |
UnknownFieldSet |
getUnknownFields() |
boolean |
hasCompareDuration()
When compare_duration is set, the GroupResult'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 during the
compare_duration period of time that precedes the read_time.
|
int |
hashCode() |
boolean |
hasReadTime()
Time used as a reference point when filtering findings.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static GroupFindingsRequest.Builder |
newBuilder() |
static GroupFindingsRequest.Builder |
newBuilder(GroupFindingsRequest prototype) |
GroupFindingsRequest.Builder |
newBuilderForType() |
protected GroupFindingsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static GroupFindingsRequest |
parseDelimitedFrom(InputStream input) |
static GroupFindingsRequest |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static GroupFindingsRequest |
parseFrom(byte[] data) |
static GroupFindingsRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static GroupFindingsRequest |
parseFrom(ByteBuffer data) |
static GroupFindingsRequest |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static GroupFindingsRequest |
parseFrom(ByteString data) |
static GroupFindingsRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static GroupFindingsRequest |
parseFrom(CodedInputStream input) |
static GroupFindingsRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static GroupFindingsRequest |
parseFrom(InputStream input) |
static GroupFindingsRequest |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<GroupFindingsRequest> |
parser() |
GroupFindingsRequest.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int PARENT_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int GROUP_BY_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
public static final int COMPARE_DURATION_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class GeneratedMessageV3
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public String getParent()
Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent
in interface GroupFindingsRequestOrBuilder
public ByteString getParentBytes()
Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes
in interface GroupFindingsRequestOrBuilder
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: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * 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 : ""`
string filter = 2;
getFilter
in interface GroupFindingsRequestOrBuilder
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: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` * 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 : ""`
string filter = 2;
getFilterBytes
in interface GroupFindingsRequestOrBuilder
public String getGroupBy()
Required. Expression that defines what assets fields to use for grouping (including `state_change`). 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 The following fields are supported when compare_duration is set: * state_change
string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
getGroupBy
in interface GroupFindingsRequestOrBuilder
public ByteString getGroupByBytes()
Required. Expression that defines what assets fields to use for grouping (including `state_change`). 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 The following fields are supported when compare_duration is set: * state_change
string group_by = 3 [(.google.api.field_behavior) = REQUIRED];
getGroupByBytes
in interface GroupFindingsRequestOrBuilder
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;
hasReadTime
in interface GroupFindingsRequestOrBuilder
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;
getReadTime
in interface GroupFindingsRequestOrBuilder
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;
getReadTimeOrBuilder
in interface GroupFindingsRequestOrBuilder
public boolean hasCompareDuration()
When compare_duration is set, the GroupResult'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 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. If this field is set then `state_change` must be a specified field in `group_by`.
.google.protobuf.Duration compare_duration = 5;
hasCompareDuration
in interface GroupFindingsRequestOrBuilder
public Duration getCompareDuration()
When compare_duration is set, the GroupResult'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 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. If this field is set then `state_change` must be a specified field in `group_by`.
.google.protobuf.Duration compare_duration = 5;
getCompareDuration
in interface GroupFindingsRequestOrBuilder
public DurationOrBuilder getCompareDurationOrBuilder()
When compare_duration is set, the GroupResult'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 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. If this field is set then `state_change` must be a specified field in `group_by`.
.google.protobuf.Duration compare_duration = 5;
getCompareDurationOrBuilder
in interface GroupFindingsRequestOrBuilder
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;
getPageToken
in interface GroupFindingsRequestOrBuilder
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;
getPageTokenBytes
in interface GroupFindingsRequestOrBuilder
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;
getPageSize
in interface GroupFindingsRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static GroupFindingsRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static GroupFindingsRequest parseFrom(InputStream input) throws IOException
IOException
public static GroupFindingsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static GroupFindingsRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static GroupFindingsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static GroupFindingsRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static GroupFindingsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public GroupFindingsRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static GroupFindingsRequest.Builder newBuilder()
public static GroupFindingsRequest.Builder newBuilder(GroupFindingsRequest prototype)
public GroupFindingsRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected GroupFindingsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static GroupFindingsRequest getDefaultInstance()
public static Parser<GroupFindingsRequest> parser()
public Parser<GroupFindingsRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public GroupFindingsRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.