com.google.cloud.securitycenter.v1.ListFindingsRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-securitycenter-v1 Show documentation
Show all versions of proto-google-cloud-securitycenter-v1 Show documentation
PROTO library for proto-google-cloud-securitycenter-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/securitycenter/v1/securitycenter_service.proto
// Protobuf Java Version: 3.25.3
package com.google.cloud.securitycenter.v1;
public interface ListFindingsRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.ListFindingsRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The parent.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* 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;
*
* @return The filter.
*/
java.lang.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;
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* 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;
*
* @return The orderBy.
*/
java.lang.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;
*
* @return The bytes for orderBy.
*/
com.google.protobuf.ByteString getOrderByBytes();
/**
*
*
*
* 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;
*
* @return Whether the readTime field is set.
*/
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;
*
* @return The readTime.
*/
com.google.protobuf.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;
*/
com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the compareDuration field is set.
*/
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;
*
* @return The compareDuration.
*/
com.google.protobuf.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;
*/
com.google.protobuf.DurationOrBuilder getCompareDurationOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the fieldMask field is set.
*/
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;
*
* @return The fieldMask.
*/
com.google.protobuf.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;
*/
com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder();
/**
*
*
*
* 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;
*
* @return The pageToken.
*/
java.lang.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;
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
*
* The maximum number of results to return in a single response. Default is
* 10, minimum is 1, maximum is 1000.
*
*
* int32 page_size = 9;
*
* @return The pageSize.
*/
int getPageSize();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy