Package com.google.cloud.securitycenter.v1p1beta1

Interface GroupFindingsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    GroupFindingsRequest, GroupFindingsRequest.Builder
    public interface GroupFindingsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.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.
      com.google.protobuf.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.
      String getFilter()
      Expression that defines the filter to apply across findings.
      com.google.protobuf.ByteString getFilterBytes()
      Expression that defines the filter to apply across findings.
      String getGroupBy()
      Required.
      com.google.protobuf.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.
      com.google.protobuf.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.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.Timestamp getReadTime()
      Time used as a reference point when filtering findings.
      com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
      Time used as a reference point when filtering findings.
      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.
      boolean hasReadTime()
      Time used as a reference point when filtering findings.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        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) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.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) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        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;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.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;
        Returns:
        The bytes for filter.

      • getGroupBy

        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];
        Returns:
        The groupBy.

      • getGroupByBytes

        com.google.protobuf.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];
        Returns:
        The bytes for groupBy.

      • hasReadTime

        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;
        Returns:
        Whether the readTime field is set.

      • getReadTime

        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;
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        com.google.protobuf.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;

      • hasCompareDuration

        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;
        Returns:
        Whether the compareDuration field is set.

      • getCompareDuration

        com.google.protobuf.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;
        Returns:
        The compareDuration.

      • getCompareDurationOrBuilder

        com.google.protobuf.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;

      • getPageToken

        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:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.

      • getPageSize

        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;
        Returns:
        The pageSize.