get(name, x__xgafv=None)

Gets a column data profile.

Args:
name: string, Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The profile for a scanned column within a table.
"column": "A String", # The name of the column.
"columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
"estimatedPrevalence": 42, # Not populated for predicted infotypes.
"infoType": { # Type of information detected by the API. # The infoType.
"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
"sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
"score": "A String", # The sensitivity score applied to the resource.
},
"version": "A String", # Optional version name for this InfoType.
},
},
"columnType": "A String", # The data type of a given column.
"dataRiskLevel": { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level for this column.
"score": "A String", # The score applied to the resource.
},
"datasetId": "A String", # The BigQuery dataset ID.
"datasetLocation": "A String", # The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
"datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource.
"estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column.
"estimatedUniquenessScore": "A String", # Approximate uniqueness of the column.
"freeTextScore": 3.14, # The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
"name": "A String", # The name of the profile.
"otherMatches": [ # Other types found within this column. List will be unordered.
{ # Infotype details for other infoTypes found within a column.
"estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype.
"excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change).
"infoType": { # Type of information detected by the API. # The other infoType.
"name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
"sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
"score": "A String", # The sensitivity score applied to the resource.
},
"version": "A String", # Optional version name for this InfoType.
},
},
],
"policyState": "A String", # Indicates if a policy tag has been applied to the column.
"profileLastGenerated": "A String", # The last time the profile was generated.
"profileStatus": { # Success or errors for the profile generation. # Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
"status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"timestamp": "A String", # Time when the profile generation status was updated
},
"sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity of this column.
"score": "A String", # The sensitivity score applied to the resource.
},
"state": "A String", # State of a profile.
"tableDataProfile": "A String", # The resource name of the table data profile.
"tableFullResource": "A String", # The resource name of the resource this column is within.
"tableId": "A String", # The BigQuery table ID.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists column data profiles for an organization.

Args:
  parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required)
  filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `table_data_profile_name` - The name of the related table data profile. - `project_id` - The Google Cloud project ID. (REQUIRED) - `dataset_id` - The BigQuery dataset ID. (REQUIRED) - `table_id` - The BigQuery table ID. (REQUIRED) - `field_id` - The ID of the BigQuery field. - `info_type` - The infotype detected in the resource. - `sensitivity_level` - HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data. - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS The length of this field should be no more than 500 characters.
  orderBy: string, Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.
  pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
  pageToken: string, Page token to continue retrieval.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List of profiles generated for a given organization or project.
  "columnDataProfiles": [ # List of data profiles.
    { # The profile for a scanned column within a table.
      "column": "A String", # The name of the column.
      "columnInfoType": { # The infoType details for this column. # If it's been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
        "estimatedPrevalence": 42, # Not populated for predicted infotypes.
        "infoType": { # Type of information detected by the API. # The infoType.
          "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
          "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
            "score": "A String", # The sensitivity score applied to the resource.
          },
          "version": "A String", # Optional version name for this InfoType.
        },
      },
      "columnType": "A String", # The data type of a given column.
      "dataRiskLevel": { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level for this column.
        "score": "A String", # The score applied to the resource.
      },
      "datasetId": "A String", # The BigQuery dataset ID.
      "datasetLocation": "A String", # The BigQuery location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations.
      "datasetProjectId": "A String", # The Google Cloud project ID that owns the profiled resource.
      "estimatedNullPercentage": "A String", # Approximate percentage of entries being null in the column.
      "estimatedUniquenessScore": "A String", # Approximate uniqueness of the column.
      "freeTextScore": 3.14, # The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
      "name": "A String", # The name of the profile.
      "otherMatches": [ # Other types found within this column. List will be unordered.
        { # Infotype details for other infoTypes found within a column.
          "estimatedPrevalence": 42, # Approximate percentage of non-null rows that contained data detected by this infotype.
          "excludedFromAnalysis": True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change).
          "infoType": { # Type of information detected by the API. # The other infoType.
            "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
            "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
              "score": "A String", # The sensitivity score applied to the resource.
            },
            "version": "A String", # Optional version name for this InfoType.
          },
        },
      ],
      "policyState": "A String", # Indicates if a policy tag has been applied to the column.
      "profileLastGenerated": "A String", # The last time the profile was generated.
      "profileStatus": { # Success or errors for the profile generation. # Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
        "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        },
        "timestamp": "A String", # Time when the profile generation status was updated
      },
      "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity of this column.
        "score": "A String", # The sensitivity score applied to the resource.
      },
      "state": "A String", # State of a profile.
      "tableDataProfile": "A String", # The resource name of the table data profile.
      "tableFullResource": "A String", # The resource name of the resource this column is within.
      "tableId": "A String", # The BigQuery table ID.
    },
  ],
  "nextPageToken": "A String", # The next page token.
}

Sensitive Data Protection (DLP) . organizations . locations . columnDataProfiles

Instance Methods

Method Details