DataProfileAction

A task to execute when a data profile has been generated.

JSON representation 
{

  // Union field action can be only one of the following:
  "exportData": {
    object (Export)
  },
  "pubSubNotification": {
    object (PubSubNotification)
  },
  "tagResources": {
    object (TagResources)
  }
  // End of list of possible types for union field action.
}
Fields
Union field action. Type of action to execute when a profile is generated. action can be only one of the following:
exportData

object (Export)

Export data profiles into a provided location.
pubSubNotification

object (PubSubNotification)

Publish a message into the Pub/Sub topic.
tagResources

object (TagResources)

Tags the profiled resources with the specified tag values.

Export

If set, the detailed data profiles will be persisted to the location of your choice whenever updated.

JSON representation 
{
  "profileTable": {
    object (BigQueryTable)
  }
}
Fields
profileTable

object (BigQueryTable)

Store all table and column profiles in an existing table or a new table in an existing dataset. Each re-generation will result in new rows in BigQuery. Data is inserted using streaming insert and so data may be in the buffer for a period of time after the profile has finished. The Pub/Sub notification is sent before the streaming buffer is guaranteed to be written, so data may not be instantly visible to queries by the time your topic receives the Pub/Sub notification.

PubSubNotification

Send a Pub/Sub message into the given Pub/Sub topic to connect other systems to data profile generation. The message payload data will be the byte serialization of DataProfilePubSubMessage.

JSON representation 
{
  "topic": string,
  "event": enum (EventType),
  "pubsubCondition": {
    object (DataProfilePubSubCondition)
  },
  "detailOfMessage": enum (DetailLevel)
}
Fields
topic

string

Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}.
event

enum (EventType)

The type of event that triggers a Pub/Sub. At most one PubSubNotification per EventType is permitted.
pubsubCondition

object (DataProfilePubSubCondition)

Conditions (e.g., data risk or sensitivity level) for triggering a Pub/Sub.
detailOfMessage

enum (DetailLevel)

How much data to include in the Pub/Sub message. If the user wishes to limit the size of the message, they can use resourceName and fetch the profile fields they wish to. Per table profile (not per column).

EventType

Types of event that can trigger an action.

Enums
EVENT_TYPE_UNSPECIFIED Unused.
NEW_PROFILE New profile (not a re-profile).
CHANGED_PROFILE One of the following profile metrics changed: Data risk score, Sensitivity score, Resource visibility, Encryption type, Predicted infoTypes, Other infoTypes
SCORE_INCREASED Table data risk score or sensitivity score increased.
ERROR_CHANGED A user (non-internal) error occurred.

DataProfilePubSubCondition

A condition for determining whether a Pub/Sub should be triggered.

JSON representation 
{
  "expressions": {
    object (PubSubExpressions)
  }
}
Fields
expressions

object (PubSubExpressions)

An expression.

PubSubExpressions

An expression, consisting of an operator and conditions.

JSON representation 
{
  "logicalOperator": enum (PubSubLogicalOperator),
  "conditions": [
    {
      object (PubSubCondition)
    }
  ]
}
Fields
logicalOperator

enum (PubSubLogicalOperator)

The operator to apply to the collection of conditions.
conditions[]

object (PubSubCondition)

Conditions to apply to the expression.

PubSubLogicalOperator

Logical operators for conditional checks.

Enums
LOGICAL_OPERATOR_UNSPECIFIED Unused.
OR Conditional OR.
AND Conditional AND.

PubSubCondition

A condition consisting of a value.

JSON representation 
{

  // Union field value can be only one of the following:
  "minimumRiskScore": enum (ProfileScoreBucket),
  "minimumSensitivityScore": enum (ProfileScoreBucket)
  // End of list of possible types for union field value.
}
Fields
Union field value. The value for the condition to trigger. value can be only one of the following:
minimumRiskScore

enum (ProfileScoreBucket)

The minimum data risk score that triggers the condition.
minimumSensitivityScore

enum (ProfileScoreBucket)

The minimum sensitivity level that triggers the condition.

ProfileScoreBucket

Various score levels for resources.

Enums
PROFILE_SCORE_BUCKET_UNSPECIFIED Unused.
HIGH High risk/sensitivity detected.
MEDIUM_OR_HIGH Medium or high risk/sensitivity detected.

DetailLevel

The levels of detail that can be included in the Pub/Sub message.

Enums
DETAIL_LEVEL_UNSPECIFIED Unused.
TABLE_PROFILE The full table data profile.
RESOURCE_NAME The name of the profiled resource.
FILE_STORE_PROFILE The full file store data profile.

TagResources

If set, attaches the tags provided to profiled resources. Tags support access control. You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.

JSON representation 
{
  "tagConditions": [
    {
      object (TagCondition)
    }
  ],
  "profileGenerationsToTag": [
    enum (ProfileGeneration)
  ],
  "lowerDataRiskToLow": boolean
}
Fields
tagConditions[]

object (TagCondition)

The tags to associate with different conditions.
profileGenerationsToTag[]

enum (ProfileGeneration)

The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both PROFILE_GENERATION_NEW and PROFILE_GENERATION_UPDATE.
lowerDataRiskToLow

boolean

Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an IAM deny policy, you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.

TagCondition

The tag to attach to profiles matching the condition. At most one TagCondition can be specified per sensitivity level.

JSON representation 
{
  "tag": {
    object (TagValue)
  },

  // Union field type can be only one of the following:
  "sensitivityScore": {
    object (SensitivityScore)
  }
  // End of list of possible types for union field type.
}
Fields
tag

object (TagValue)

The tag value to attach to resources.
Union field type. The type of condition on which attaching the tag will be predicated. type can be only one of the following:
sensitivityScore

object (SensitivityScore)

Conditions attaching the tag to a resource on its profile having this sensitivity score.

TagValue

A value of a tag.

JSON representation 
{

  // Union field format can be only one of the following:
  "namespacedValue": string
  // End of list of possible types for union field format.
}
Fields
Union field format. The format of the tag value. format can be only one of the following:
namespacedValue

string

The namespaced name for the tag value to attach to resources. Must be in the format {parent_id}/{tag_key_short_name}/{short_name}, for example, "123456/environment/prod".

ProfileGeneration

Whether a profile being created is the first generation or an update.

Enums
PROFILE_GENERATION_UNSPECIFIED Unused.
PROFILE_GENERATION_NEW The profile is the first profile for the resource.
PROFILE_GENERATION_UPDATE The profile is an update to a previous profile.