com.google.cloud.securitycenter.v1beta1

Interface ListFindingsRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ListFindingsRequest, ListFindingsRequest.Builder

public interface ListFindingsRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
FieldMask	getFieldMask() Optional.
FieldMaskOrBuilder	getFieldMaskOrBuilder() Optional.
String	getFilter() Expression that defines the filter to apply across findings.
ByteString	getFilterBytes() Expression that defines the filter to apply across findings.
String	getOrderBy() Expression that defines what fields and order to use for sorting.
ByteString	getOrderByBytes() Expression that defines what fields and order to use for sorting.
int	getPageSize() The maximum number of results to return in a single response.
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.
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	getParent() Required.
ByteString	getParentBytes() Required.
Timestamp	getReadTime() Time used as a reference point when filtering findings.
TimestampOrBuilder	getReadTimeOrBuilder() Time used as a reference point when filtering findings.
boolean	hasFieldMask() Optional.
boolean	hasReadTime() Time used as a reference point when filtering findings.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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:

The parent.

getParentBytes

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:

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

The filter.

getFilterBytes

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:

The bytes for filter.

getOrderBy

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:

The orderBy.

getOrderByBytes

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:

The bytes for orderBy.

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

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

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;

hasFieldMask

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:

Whether the fieldMask field is set.

getFieldMask

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:

The fieldMask.

getFieldMaskOrBuilder

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

getPageToken

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:

The pageToken.

getPageTokenBytes

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:

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

Returns:

The pageSize.