Interface GroupFindingsRequestOrBuilder (2.7.0)

public interface GroupFindingsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract 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 not 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. For example, source_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract 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 not 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. For example, source_properties.size = 100 is a valid filter string.

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getGroupBy()

public abstract String getGroupBy()

Required. Expression that defines what assets fields to use for grouping (including state). 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

string group_by = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The groupBy.

getGroupByBytes()

public abstract ByteString getGroupByBytes()

Required. Expression that defines what assets fields to use for grouping (including state). 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

string group_by = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for groupBy.

getPageSize()

public abstract 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 = 6;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract 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 = 5;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract 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 = 5;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getReadTime()

public abstract 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
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public abstract 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;

Returns
TypeDescription
TimestampOrBuilder

hasReadTime()

public abstract 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
TypeDescription
boolean

Whether the readTime field is set.