REST Resource: organizations.storedInfoTypes

Resource: StoredInfoType

StoredInfoType resource message that contains information about the current version and any pending updates.

JSON representation
{
  "name": string,
  "currentVersion": {
    object(StoredInfoTypeVersion)
  },
  "pendingVersions": [
    {
      object(StoredInfoTypeVersion)
    }
  ]
}
Fields
name

string

Resource name.

currentVersion

object(StoredInfoTypeVersion)

Current version of the stored info type.

pendingVersions[]

object(StoredInfoTypeVersion)

Pending versions of the stored info type. Empty if no versions are pending.

StoredInfoTypeVersion

Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state.

JSON representation
{
  "config": {
    object(StoredInfoTypeConfig)
  },
  "createTime": string,
  "state": enum(StoredInfoTypeState),
  "errors": [
    {
      object(Error)
    }
  ]
}
Fields
config

object(StoredInfoTypeConfig)

StoredInfoType configuration.

createTime

string (Timestamp format)

Create timestamp of the version. Read-only, determined by the system when the version is created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

state

enum(StoredInfoTypeState)

Stored info type version state. Read-only, updated by the system during dictionary creation.

errors[]

object(Error)

Errors that occurred when creating this storedInfoType version, or anomalies detected in the storedInfoType data that render it unusable. Only the five most recent errors will be displayed, with the most recent error appearing first.

For example, some of the data for stored custom dictionaries is put in the user's Google Cloud Storage bucket, and if this data is modified or deleted by the user or another system, the dictionary becomes invalid.

If any errors occur, fix the problem indicated by the error message and use the storedInfoTypes.patch API method to create another version of the storedInfoType to continue using it, reusing the same config if it was not the source of the error.

StoredInfoTypeConfig

Configuration for a StoredInfoType.

JSON representation
{
  "displayName": string,
  "description": string,
  "largeCustomDictionary": {
    object(LargeCustomDictionaryConfig)
  }
}
Fields
displayName

string

Display name of the StoredInfoType (max 256 characters).

description

string

Description of the StoredInfoType (max 256 characters).

largeCustomDictionary

object(LargeCustomDictionaryConfig)

StoredInfoType where findings are defined by a dictionary of phrases.

LargeCustomDictionaryConfig

Configuration for a custom dictionary created from a data source of any size up to the maximum size defined in the limits page. The artifacts of dictionary creation are stored in the specified Google Cloud Storage location. Consider using CustomInfoType.Dictionary for smaller dictionaries that satisfy the size requirements.

JSON representation
{
  "outputPath": {
    object(CloudStoragePath)
  },

  // Union field source can be only one of the following:
  "cloudStorageFileSet": {
    object(CloudStorageFileSet)
  },
  "bigQueryField": {
    object(BigQueryField)
  }
  // End of list of possible types for union field source.
}
Fields
outputPath

object(CloudStoragePath)

Location to store dictionary artifacts in Google Cloud Storage. These files will only be accessible by project owners and the DLP API. If any of these artifacts are modified, the dictionary is considered invalid and can no longer be used.

Union field source.

source can be only one of the following:

cloudStorageFileSet

object(CloudStorageFileSet)

Set of files containing newline-delimited lists of dictionary phrases.

bigQueryField

object(BigQueryField)

Field in a BigQuery table where each cell represents a dictionary phrase.

CloudStorageFileSet

Message representing a set of files in Cloud Storage.

JSON representation
{
  "url": string
}
Fields
url

string

The url, in the format gs://<bucket>/<path>. Trailing wildcard in the path is allowed.

BigQueryField

Message defining a field of a BigQuery table.

JSON representation
{
  "table": {
    object(BigQueryTable)
  },
  "field": {
    object(FieldId)
  }
}
Fields
table

object(BigQueryTable)

Source table of the field.

field

object(FieldId)

Designated field in the BigQuery table.

StoredInfoTypeState

State of a StoredInfoType version.

Enums
STORED_INFO_TYPE_STATE_UNSPECIFIED
PENDING StoredInfoType version is being created.
READY StoredInfoType version is ready for use.
FAILED StoredInfoType creation failed. All relevant error messages are returned in the StoredInfoTypeVersion message.
INVALID StoredInfoType is no longer valid because artifacts stored in user-controlled storage were modified. To fix an invalid StoredInfoType, use the storedInfoTypes.patch method to create a new version.

Methods

create

Creates a pre-built stored infoType to be used for inspection.

delete

Deletes a stored infoType.

get

Gets a stored infoType.

list

Lists stored infoTypes.

patch

Updates the stored infoType by creating a new version.
Was this page helpful? Let us know how we did:

Send feedback about...

Data Loss Prevention API