Class ListFindingsRequest.Builder (2.84.0) 

public static final class ListFindingsRequest.Builder extends GeneratedMessageV3.Builder<ListFindingsRequest.Builder> implements ListFindingsRequestOrBuilder

Request message for listing findings.

Protobuf type google.cloud.securitycenter.v2.ListFindingsRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListFindingsRequest build()
Returns
Type Description
ListFindingsRequest

buildPartial()

public ListFindingsRequest buildPartial()
Returns
Type Description
ListFindingsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFieldMask()

public ListFindingsRequest.Builder clearFieldMask()

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;

Returns
Type Description
ListFindingsRequest.Builder

clearFilter()

public ListFindingsRequest.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 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

  • 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: =, :
    • security_marks.marks: =, :
    • 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;

Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListFindingsRequest.Builder clearOrderBy()

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,parent". 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,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

string order_by = 3;

Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

clearPageSize()

public ListFindingsRequest.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 = 9;

Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

clearPageToken()

public ListFindingsRequest.Builder clearPageToken()

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;

Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

clearParent()

public ListFindingsRequest.Builder clearParent()

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]

  • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-

  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}

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

Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListFindingsRequest getDefaultInstanceForType()
Returns
Type Description
ListFindingsRequest

getDescriptorForType()

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

getFieldMask()

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;

Returns
Type Description
FieldMask

The fieldMask.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

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;

Returns
Type Description
Builder

getFieldMaskOrBuilder()

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;

Returns
Type Description
FieldMaskOrBuilder

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

  • 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: =, :
    • security_marks.marks: =, :
    • 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;

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

  • 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: =, :
    • security_marks.marks: =, :
    • 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;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

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,parent". 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,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

string order_by = 3;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

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,parent". 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,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

string order_by = 3;

Returns
Type Description
ByteString

The bytes for orderBy.

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

Returns
Type Description
int

The pageSize.

getPageToken()

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;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

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;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]

  • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-

  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}

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 the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]

  • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-

  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}

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

Returns
Type Description
ByteString

The bytes for parent.

hasFieldMask()

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;

Returns
Type Description
boolean

Whether the fieldMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFieldMask(FieldMask value)

public ListFindingsRequest.Builder mergeFieldMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListFindingsRequest.Builder

mergeFrom(ListFindingsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldMask(FieldMask value)

public ListFindingsRequest.Builder setFieldMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListFindingsRequest.Builder

setFieldMask(FieldMask.Builder builderForValue)

public ListFindingsRequest.Builder setFieldMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListFindingsRequest.Builder

setFilter(String value)

public ListFindingsRequest.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 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

  • 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: =, :
    • security_marks.marks: =, :
    • 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;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFindingsRequest.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 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

  • 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: =, :
    • security_marks.marks: =, :
    • 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;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setOrderBy(String value)

public ListFindingsRequest.Builder setOrderBy(String value)

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,parent". 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,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

string order_by = 3;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListFindingsRequest.Builder setOrderByBytes(ByteString value)

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,parent". 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,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.

The following fields are supported: name parent state category resource_name event_time security_marks.marks

string order_by = 3;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFindingsRequest.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 = 9;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFindingsRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFindingsRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setParent(String value)

public ListFindingsRequest.Builder setParent(String value)

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]

  • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-

  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListFindingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFindingsRequest.Builder setParentBytes(ByteString value)

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]

  • projects/[project_id]/sources/[source_id]/locations/[location_id]

    To list across all sources provide a source_id of -. The following list shows some examples:

  • organizations/{organization_id}/sources/-

  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}

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
ListFindingsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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