- JSON representation
- Finding
- Location
- Range
- ContentLocation
- RecordLocation
- RecordKey
- DatastoreKey
- Key
- PathElement
- BigQueryKey
- TableLocation
- ImageLocation
- BoundingBox
- DocumentLocation
- MetadataLocation
- MetadataType
- StorageMetadataLabel
- QuoteInfo
- DateTime
- TimeZone
All the findings for a single scanned item.
JSON representation |
---|
{
"findings": [
{
object ( |
Fields | |
---|---|
findings[] |
List of findings for an item. |
findingsTruncated |
If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings. The findings list might be truncated because the input items were too large, or because the server reached the maximum amount of resources allowed for a single API call. For best results, divide the input into smaller batches. |
Finding
Represents a piece of potentially sensitive content.
JSON representation |
---|
{ "name": string, "quote": string, "infoType": { object ( |
Fields | |
---|---|
name |
Resource name in format projects/{project}/locations/{location}/findings/{finding} Populated only when viewing persisted findings. |
quote |
The content that was found. Even if the content is not textual, it may be converted to a textual representation here. Provided if |
infoType |
The type of content that might have been found. Provided if |
likelihood |
Confidence of how likely it is that the |
location |
Where the content was found. |
createTime |
Timestamp when finding was detected. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
quoteInfo |
Contains data parsed from quotes. Only populated if includeQuote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME. |
resourceName |
The job that stored the finding. |
triggerName |
Job trigger name, if applicable, for this finding. |
labels |
The labels associated with this Label keys must be between 1 and 63 characters long and must conform to the following regular expression: Label values must be between 0 and 63 characters long and must conform to the regular expression No more than 10 labels can be associated with a given finding. Examples:
An object containing a list of |
jobCreateTime |
Time the job started that produced this finding. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
jobName |
The job that stored the finding. |
findingId |
The unique finding id. |
Location
Specifies the location of the finding.
JSON representation |
---|
{ "byteRange": { object ( |
Fields | |
---|---|
byteRange |
Zero-based byte offsets delimiting the finding. These are relative to the finding's containing element. Note that when the content is not textual, this references the UTF-8 encoded textual representation of the content. Omitted if content is an image. |
codepointRange |
Unicode character offsets delimiting the finding. These are relative to the finding's containing element. Provided when the content is text. |
contentLocations[] |
List of nested objects pointing to the precise location of the finding within the file or record. |
container |
Information about the container where this finding occurred, if available. |
Range
Generic half-open interval [start, end)
JSON representation |
---|
{ "start": string, "end": string } |
Fields | |
---|---|
start |
Index of the first character of the range (inclusive). |
end |
Index of the last character of the range (exclusive). |
ContentLocation
Precise location of the finding within a document, record, image, or metadata container.
JSON representation |
---|
{ "containerName": string, "containerTimestamp": string, "containerVersion": string, // Union field |
Fields | |
---|---|
containerName |
Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows:
Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document). |
containerTimestamp |
Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the lastModifiedTime property. For Datastore, this field isn't populated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
containerVersion |
Finding container version, if available ("generation" for Cloud Storage). |
Union field location . Type of the container within the file with location of the finding. location can be only one of the following: |
|
recordLocation |
Location within a row or record of a database table. |
imageLocation |
Location within an image's pixels. |
documentLocation |
Location data for document files. |
metadataLocation |
Location within the metadata for inspected content. |
RecordLocation
Location of a finding within a row or record.
JSON representation |
---|
{ "recordKey": { object ( |
Fields | |
---|---|
recordKey |
Key of the finding. |
fieldId |
Field id of the field containing the finding. |
tableLocation |
Location within a |
RecordKey
Message for a unique key indicating a record that contains a finding.
JSON representation |
---|
{ "idValues": [ string ], // Union field |
Fields | |
---|---|
idValues[] |
Values of identifying columns in the given row. Order of values matches the order of |
Union field type . Type of key type can be only one of the following: |
|
datastoreKey |
BigQuery key |
bigQueryKey |
Datastore key |
DatastoreKey
Record key for a finding in Cloud Datastore.
JSON representation |
---|
{
"entityKey": {
object ( |
Fields | |
---|---|
entityKey |
Datastore entity key. |
Key
A unique identifier for a Datastore entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
JSON representation |
---|
{ "partitionId": { object ( |
Fields | |
---|---|
partitionId |
Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. |
path[] |
The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a root entity, the second element identifies a child of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's ancestors. A path can never be empty, and a path can have at most 100 elements. |
PathElement
A (kind, ID/name) pair used to construct a key path.
If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
JSON representation |
---|
{ "kind": string, // Union field |
Fields | |
---|---|
kind |
The kind of the entity. A kind matching regex |
Union field id_type . The type of ID. id_type can be only one of the following: |
|
id |
The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. |
name |
The name of the entity. A name matching regex |
BigQueryKey
Row key for identifying a record in BigQuery table.
JSON representation |
---|
{
"tableReference": {
object ( |
Fields | |
---|---|
tableReference |
Complete BigQuery table reference. |
rowNumber |
Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify |
TableLocation
Location of a finding within a table.
JSON representation |
---|
{ "rowIndex": string } |
Fields | |
---|---|
rowIndex |
The zero-based index of the row where the finding is located. Only populated for resources that have a natural ordering, not BigQuery. In BigQuery, to identify the row a finding came from, populate BigQueryOptions.identifying_fields with your primary key column names and when you store the findings the value of those columns will be stored inside of Finding. |
ImageLocation
Location of the finding within an image.
JSON representation |
---|
{
"boundingBoxes": [
{
object ( |
Fields | |
---|---|
boundingBoxes[] |
Bounding boxes locating the pixels within the image containing the finding. |
BoundingBox
Bounding box encompassing detected text within an image.
JSON representation |
---|
{ "top": integer, "left": integer, "width": integer, "height": integer } |
Fields | |
---|---|
top |
Top coordinate of the bounding box. (0,0) is upper left. |
left |
Left coordinate of the bounding box. (0,0) is upper left. |
width |
Width of the bounding box in pixels. |
height |
Height of the bounding box in pixels. |
DocumentLocation
Location of a finding within a document.
JSON representation |
---|
{ "fileOffset": string } |
Fields | |
---|---|
fileOffset |
Offset of the line, from the beginning of the file, where the finding is located. |
MetadataLocation
Metadata Location
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
Type of metadata containing the finding. |
Union field label . Label of the piece of metadata containing the finding, for example - latitude, author, caption. label can be only one of the following: |
|
storageLabel |
Storage metadata. |
MetadataType
Type of metadata containing the finding.
Enums | |
---|---|
METADATATYPE_UNSPECIFIED |
Unused |
STORAGE_METADATA |
General file metadata provided by Cloud Storage. |
StorageMetadataLabel
Storage metadata label to indicate which metadata entry contains findings.
JSON representation |
---|
{ "key": string } |
Fields | |
---|---|
key |
Label name. |
QuoteInfo
Message for infoType-dependent details parsed from quote.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field parsed_quote . Object representation of the quote. parsed_quote can be only one of the following: |
|
dateTime |
The date time indicated by the quote. |
DateTime
Message for a date time object. e.g. 2018-01-01, 5th August.
JSON representation |
---|
{ "date": { object ( |
Fields | |
---|---|
date |
One or more of the following must be set. Must be a valid date or time value. |
dayOfWeek |
Day of week |
time |
Time of day |
timeZone |
Time zone |
TimeZone
Time zone of the date time object.
JSON representation |
---|
{ "offsetMinutes": integer } |
Fields | |
---|---|
offsetMinutes |
Set only if the offset can be determined. Positive for time ahead of UTC. E.g. For "UTC-9", this value is -540. |