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)
  }
  // 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.

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 a new row in BigQuery.

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 Changed one of the following profile metrics: * Table data risk score * Table sensitivity score * Table resource visibility * Table encryption type * Table predicted infoTypes * Table 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 resource name of the table.