Class GroupFindingsRequest.Builder (2.54.0) 

public static final class GroupFindingsRequest.Builder extends GeneratedMessageV3.Builder<GroupFindingsRequest.Builder> implements GroupFindingsRequestOrBuilder

Request message for grouping by findings.

Protobuf type google.cloud.securitycenter.v1beta1.GroupFindingsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroupFindingsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GroupFindingsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

build()

public GroupFindingsRequest build()
Returns
Type Description
GroupFindingsRequest

buildPartial()

public GroupFindingsRequest buildPartial()
Returns
Type Description
GroupFindingsRequest

clear()

public GroupFindingsRequest.Builder clear()
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GroupFindingsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

clearFilter()

public GroupFindingsRequest.Builder clearFilter()

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
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

clearGroupBy()

public GroupFindingsRequest.Builder clearGroupBy()

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
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GroupFindingsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

clearPageSize()

public GroupFindingsRequest.Builder clearPageSize()

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
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

clearPageToken()

public GroupFindingsRequest.Builder clearPageToken()

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
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

clearParent()

public GroupFindingsRequest.Builder clearParent()

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
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

clearReadTime()

public GroupFindingsRequest.Builder clearReadTime()

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
Type Description
GroupFindingsRequest.Builder

clone()

public GroupFindingsRequest.Builder clone()
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

getDefaultInstanceForType()

public GroupFindingsRequest getDefaultInstanceForType()
Returns
Type Description
GroupFindingsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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 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
Type Description
String

The filter.

getFilterBytes()

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 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
Type Description
ByteString

The bytes for filter.

getGroupBy()

public 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
Type Description
String

The groupBy.

getGroupByBytes()

public 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
Type Description
ByteString

The bytes for groupBy.

getPageSize()

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

Returns
Type Description
int

The pageSize.

getPageToken()

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getReadTime()

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;

Returns
Type Description
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

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
Type Description
Builder

getReadTimeOrBuilder()

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;

Returns
Type Description
TimestampOrBuilder

hasReadTime()

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;

Returns
Type Description
boolean

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GroupFindingsRequest other)

public GroupFindingsRequest.Builder mergeFrom(GroupFindingsRequest other)
Parameter
Name Description
other GroupFindingsRequest
Returns
Type Description
GroupFindingsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GroupFindingsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroupFindingsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GroupFindingsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

mergeReadTime(Timestamp value)

public GroupFindingsRequest.Builder mergeReadTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
GroupFindingsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GroupFindingsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GroupFindingsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

setFilter(String value)

public GroupFindingsRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public GroupFindingsRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setGroupBy(String value)

public GroupFindingsRequest.Builder setGroupBy(String value)

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];

Parameter
Name Description
value String

The groupBy to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setGroupByBytes(ByteString value)

public GroupFindingsRequest.Builder setGroupByBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for groupBy to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setPageSize(int value)

public GroupFindingsRequest.Builder setPageSize(int value)

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.

int32 page_size = 6;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setPageToken(String value)

public GroupFindingsRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public GroupFindingsRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setParent(String value)

public GroupFindingsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public GroupFindingsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
GroupFindingsRequest.Builder

This builder for chaining.

setReadTime(Timestamp value)

public GroupFindingsRequest.Builder setReadTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
GroupFindingsRequest.Builder

setReadTime(Timestamp.Builder builderForValue)

public GroupFindingsRequest.Builder setReadTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GroupFindingsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GroupFindingsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GroupFindingsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GroupFindingsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GroupFindingsRequest.Builder
Overrides