Class ListFindingsRequest.Builder (2.3.2) 

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

Request message for listing findings.

Protobuf type google.cloud.securitycenter.v1beta1.ListFindingsRequest

Inheritance

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListFindingsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

build()

public ListFindingsRequest build()
Returns
TypeDescription
ListFindingsRequest

buildPartial()

public ListFindingsRequest buildPartial()
Returns
TypeDescription
ListFindingsRequest

clear()

public ListFindingsRequest.Builder clear()
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListFindingsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

clearFieldMask()

public ListFindingsRequest.Builder clearFieldMask()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFindingsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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,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.

string order_by = 3;

Returns
TypeDescription
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 = 7;

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

Returns
TypeDescription
ListFindingsRequest.Builder

This builder for chaining.

clearParent()

public ListFindingsRequest.Builder clearParent()

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list 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
ListFindingsRequest.Builder

This builder for chaining.

clearReadTime()

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

clone()

public ListFindingsRequest.Builder clone()
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFindingsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListFindingsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFieldMask()

public FieldMask getFieldMask()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FieldMask

The fieldMask.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Builder

getFieldMaskOrBuilder()

public FieldMaskOrBuilder getFieldMaskOrBuilder()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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 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 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.

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

string order_by = 3;

Returns
TypeDescription
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,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.

string order_by = 3;

Returns
TypeDescription
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 = 7;

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

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list 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 ByteString getParentBytes()

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list 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 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.

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

hasFieldMask()

public boolean hasFieldMask()

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the fieldMask field is set.

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

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFieldMask(FieldMask value)

public ListFindingsRequest.Builder mergeFieldMask(FieldMask value)

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListFindingsRequest.Builder

mergeFrom(ListFindingsRequest other)

public ListFindingsRequest.Builder mergeFrom(ListFindingsRequest other)
Parameter
NameDescription
otherListFindingsRequest
Returns
TypeDescription
ListFindingsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFindingsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListFindingsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

mergeReadTime(Timestamp value)

public ListFindingsRequest.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
NameDescription
valueTimestamp
Returns
TypeDescription
ListFindingsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFindingsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListFindingsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

setFieldMask(FieldMask value)

public ListFindingsRequest.Builder setFieldMask(FieldMask value)

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListFindingsRequest.Builder

setFieldMask(FieldMask.Builder builderForValue)

public ListFindingsRequest.Builder setFieldMask(FieldMask.Builder builderForValue)

Optional. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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 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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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 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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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,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.

string order_by = 3;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
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,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.

string order_by = 3;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
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 = 7;

Parameter
NameDescription
valueint

The pageSize to set.

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

Parameter
NameDescription
valueString

The pageToken to set.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListFindingsRequest.Builder

This builder for chaining.

setParent(String value)

public ListFindingsRequest.Builder setParent(String value)

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list 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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListFindingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFindingsRequest.Builder setParentBytes(ByteString value)

Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list 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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListFindingsRequest.Builder

This builder for chaining.

setReadTime(Timestamp value)

public ListFindingsRequest.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
NameDescription
valueTimestamp
Returns
TypeDescription
ListFindingsRequest.Builder

setReadTime(Timestamp.Builder builderForValue)

public ListFindingsRequest.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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListFindingsRequest.Builder

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

public ListFindingsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFindingsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListFindingsRequest.Builder
Overrides