public final class ListFindingsRequest extends GeneratedMessageV3 implements ListFindingsRequestOrBuilder
Request message for listing findings.Protobuf type
google.cloud.securitycenter.v1.ListFindingsRequest
Modifier and Type | Class and Description |
---|---|
static class |
ListFindingsRequest.Builder
Request message for listing 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 |
FIELD_MASK_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
ORDER_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 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.
|
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.
|
static ListFindingsRequest |
getDefaultInstance() |
ListFindingsRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
FieldMask |
getFieldMask()
A field mask to specify the Finding fields to be listed in the response.
|
FieldMaskOrBuilder |
getFieldMaskOrBuilder()
A field mask to specify the Finding fields to be listed in the response.
|
String |
getFilter()
Expression that defines the filter to apply across findings.
|
ByteString |
getFilterBytes()
Expression that defines the filter to apply across findings.
|
String |
getOrderBy()
Expression that defines what fields and order to use for sorting.
|
ByteString |
getOrderByBytes()
Expression that defines what fields and order to use for sorting.
|
int |
getPageSize()
The maximum number of results to return in a single response.
|
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.
|
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 |
getParent()
Required.
|
ByteString |
getParentBytes()
Required.
|
Parser<ListFindingsRequest> |
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 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.
|
boolean |
hasFieldMask()
A field mask to specify the Finding fields to be listed in the response.
|
int |
hashCode() |
boolean |
hasReadTime()
Time used as a reference point when filtering findings.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ListFindingsRequest.Builder |
newBuilder() |
static ListFindingsRequest.Builder |
newBuilder(ListFindingsRequest prototype) |
ListFindingsRequest.Builder |
newBuilderForType() |
protected ListFindingsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static ListFindingsRequest |
parseDelimitedFrom(InputStream input) |
static ListFindingsRequest |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static ListFindingsRequest |
parseFrom(byte[] data) |
static ListFindingsRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static ListFindingsRequest |
parseFrom(ByteBuffer data) |
static ListFindingsRequest |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static ListFindingsRequest |
parseFrom(ByteString data) |
static ListFindingsRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static ListFindingsRequest |
parseFrom(CodedInputStream input) |
static ListFindingsRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static ListFindingsRequest |
parseFrom(InputStream input) |
static ListFindingsRequest |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<ListFindingsRequest> |
parser() |
ListFindingsRequest.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 ORDER_BY_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
public static final int COMPARE_DURATION_FIELD_NUMBER
public static final int FIELD_MASK_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 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) = { ... }
getParent
in interface ListFindingsRequestOrBuilder
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) = { ... }
getParentBytes
in interface ListFindingsRequestOrBuilder
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;
getFilter
in interface ListFindingsRequestOrBuilder
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;
getFilterBytes
in interface ListFindingsRequestOrBuilder
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;
getOrderBy
in interface ListFindingsRequestOrBuilder
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;
getOrderByBytes
in interface ListFindingsRequestOrBuilder
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 ListFindingsRequestOrBuilder
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 ListFindingsRequestOrBuilder
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 ListFindingsRequestOrBuilder
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;
hasCompareDuration
in interface ListFindingsRequestOrBuilder
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;
getCompareDuration
in interface ListFindingsRequestOrBuilder
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;
getCompareDurationOrBuilder
in interface ListFindingsRequestOrBuilder
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;
hasFieldMask
in interface ListFindingsRequestOrBuilder
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;
getFieldMask
in interface ListFindingsRequestOrBuilder
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;
getFieldMaskOrBuilder
in interface ListFindingsRequestOrBuilder
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;
getPageToken
in interface ListFindingsRequestOrBuilder
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;
getPageTokenBytes
in interface ListFindingsRequestOrBuilder
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;
getPageSize
in interface ListFindingsRequestOrBuilder
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 ListFindingsRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static ListFindingsRequest parseFrom(InputStream input) throws IOException
IOException
public static ListFindingsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ListFindingsRequest parseDelimitedFrom(InputStream input) throws IOException
IOException
public static ListFindingsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static ListFindingsRequest parseFrom(CodedInputStream input) throws IOException
IOException
public static ListFindingsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public ListFindingsRequest.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static ListFindingsRequest.Builder newBuilder()
public static ListFindingsRequest.Builder newBuilder(ListFindingsRequest prototype)
public ListFindingsRequest.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected ListFindingsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static ListFindingsRequest getDefaultInstance()
public static Parser<ListFindingsRequest> parser()
public Parser<ListFindingsRequest> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public ListFindingsRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
Copyright © 2022 Google LLC. All rights reserved.