google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.dataplex/v1.getDataScan

Gets a DataScan resource.

Using getDataScan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDataScan(args: GetDataScanArgs, opts?: InvokeOptions): Promise<GetDataScanResult>
function getDataScanOutput(args: GetDataScanOutputArgs, opts?: InvokeOptions): Output<GetDataScanResult>
def get_data_scan(data_scan_id: Optional[str] = None,
                  location: Optional[str] = None,
                  project: Optional[str] = None,
                  view: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDataScanResult
def get_data_scan_output(data_scan_id: Optional[pulumi.Input[str]] = None,
                  location: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  view: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDataScanResult]
func LookupDataScan(ctx *Context, args *LookupDataScanArgs, opts ...InvokeOption) (*LookupDataScanResult, error)
func LookupDataScanOutput(ctx *Context, args *LookupDataScanOutputArgs, opts ...InvokeOption) LookupDataScanResultOutput

> Note: This function is named LookupDataScan in the Go SDK.

public static class GetDataScan 
{
    public static Task<GetDataScanResult> InvokeAsync(GetDataScanArgs args, InvokeOptions? opts = null)
    public static Output<GetDataScanResult> Invoke(GetDataScanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataScanResult> getDataScan(GetDataScanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:dataplex/v1:getDataScan
  arguments:
    # arguments dictionary

The following arguments are supported:

DataScanId string
Location string
Project string
View string
DataScanId string
Location string
Project string
View string
dataScanId String
location String
project String
view String
dataScanId string
location string
project string
view string
dataScanId String
location String
project String
view String

getDataScan Result

The following output properties are available:

CreateTime string

The time when the scan was created.

Data Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataSourceResponse

The data source for DataScan.

DataProfileResult Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataProfileResultResponse

The result of the data profile scan.

DataProfileSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataProfileSpecResponse

DataProfileScan related setting.

DataQualityResult Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataQualityResultResponse

The result of the data quality scan.

DataQualitySpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataQualitySpecResponse

DataQualityScan related setting.

Description string

Optional. Description of the scan. Must be between 1-1024 characters.

DisplayName string

Optional. User friendly display name. Must be between 1-256 characters.

ExecutionSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataScanExecutionSpecResponse

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

ExecutionStatus Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataScanExecutionStatusResponse

Status of the data scan execution.

Labels Dictionary<string, string>

Optional. User-defined labels for the scan.

Name string

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

State string

Current state of the DataScan.

Type string

The type of DataScan.

Uid string

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

UpdateTime string

The time when the scan was last updated.

CreateTime string

The time when the scan was created.

Data GoogleCloudDataplexV1DataSourceResponse

The data source for DataScan.

DataProfileResult GoogleCloudDataplexV1DataProfileResultResponse

The result of the data profile scan.

DataProfileSpec GoogleCloudDataplexV1DataProfileSpecResponse

DataProfileScan related setting.

DataQualityResult GoogleCloudDataplexV1DataQualityResultResponse

The result of the data quality scan.

DataQualitySpec GoogleCloudDataplexV1DataQualitySpecResponse

DataQualityScan related setting.

Description string

Optional. Description of the scan. Must be between 1-1024 characters.

DisplayName string

Optional. User friendly display name. Must be between 1-256 characters.

ExecutionSpec GoogleCloudDataplexV1DataScanExecutionSpecResponse

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

ExecutionStatus GoogleCloudDataplexV1DataScanExecutionStatusResponse

Status of the data scan execution.

Labels map[string]string

Optional. User-defined labels for the scan.

Name string

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

State string

Current state of the DataScan.

Type string

The type of DataScan.

Uid string

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

UpdateTime string

The time when the scan was last updated.

createTime String

The time when the scan was created.

data GoogleCloudDataplexV1DataSourceResponse

The data source for DataScan.

dataProfileResult GoogleCloudDataplexV1DataProfileResultResponse

The result of the data profile scan.

dataProfileSpec GoogleCloudDataplexV1DataProfileSpecResponse

DataProfileScan related setting.

dataQualityResult GoogleCloudDataplexV1DataQualityResultResponse

The result of the data quality scan.

dataQualitySpec GoogleCloudDataplexV1DataQualitySpecResponse

DataQualityScan related setting.

description String

Optional. Description of the scan. Must be between 1-1024 characters.

displayName String

Optional. User friendly display name. Must be between 1-256 characters.

executionSpec GoogleCloudDataplexV1DataScanExecutionSpecResponse

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

executionStatus GoogleCloudDataplexV1DataScanExecutionStatusResponse

Status of the data scan execution.

labels Map<String,String>

Optional. User-defined labels for the scan.

name String

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

state String

Current state of the DataScan.

type String

The type of DataScan.

uid String

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

updateTime String

The time when the scan was last updated.

createTime string

The time when the scan was created.

data GoogleCloudDataplexV1DataSourceResponse

The data source for DataScan.

dataProfileResult GoogleCloudDataplexV1DataProfileResultResponse

The result of the data profile scan.

dataProfileSpec GoogleCloudDataplexV1DataProfileSpecResponse

DataProfileScan related setting.

dataQualityResult GoogleCloudDataplexV1DataQualityResultResponse

The result of the data quality scan.

dataQualitySpec GoogleCloudDataplexV1DataQualitySpecResponse

DataQualityScan related setting.

description string

Optional. Description of the scan. Must be between 1-1024 characters.

displayName string

Optional. User friendly display name. Must be between 1-256 characters.

executionSpec GoogleCloudDataplexV1DataScanExecutionSpecResponse

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

executionStatus GoogleCloudDataplexV1DataScanExecutionStatusResponse

Status of the data scan execution.

labels {[key: string]: string}

Optional. User-defined labels for the scan.

name string

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

state string

Current state of the DataScan.

type string

The type of DataScan.

uid string

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

updateTime string

The time when the scan was last updated.

create_time str

The time when the scan was created.

data GoogleCloudDataplexV1DataSourceResponse

The data source for DataScan.

data_profile_result GoogleCloudDataplexV1DataProfileResultResponse

The result of the data profile scan.

data_profile_spec GoogleCloudDataplexV1DataProfileSpecResponse

DataProfileScan related setting.

data_quality_result GoogleCloudDataplexV1DataQualityResultResponse

The result of the data quality scan.

data_quality_spec GoogleCloudDataplexV1DataQualitySpecResponse

DataQualityScan related setting.

description str

Optional. Description of the scan. Must be between 1-1024 characters.

display_name str

Optional. User friendly display name. Must be between 1-256 characters.

execution_spec GoogleCloudDataplexV1DataScanExecutionSpecResponse

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

execution_status GoogleCloudDataplexV1DataScanExecutionStatusResponse

Status of the data scan execution.

labels Mapping[str, str]

Optional. User-defined labels for the scan.

name str

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

state str

Current state of the DataScan.

type str

The type of DataScan.

uid str

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

update_time str

The time when the scan was last updated.

createTime String

The time when the scan was created.

data Property Map

The data source for DataScan.

dataProfileResult Property Map

The result of the data profile scan.

dataProfileSpec Property Map

DataProfileScan related setting.

dataQualityResult Property Map

The result of the data quality scan.

dataQualitySpec Property Map

DataQualityScan related setting.

description String

Optional. Description of the scan. Must be between 1-1024 characters.

displayName String

Optional. User friendly display name. Must be between 1-256 characters.

executionSpec Property Map

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

executionStatus Property Map

Status of the data scan execution.

labels Map<String>

Optional. User-defined labels for the scan.

name String

The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.

state String

Current state of the DataScan.

type String

The type of DataScan.

uid String

System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.

updateTime String

The time when the scan was last updated.

Supporting Types

GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Average double

Average of non-null values in the scanned data. NaN, if the field has a NaN.

Max double

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

Min double

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

Quartiles List<double>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

StandardDeviation double

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

Average float64

Average of non-null values in the scanned data. NaN, if the field has a NaN.

Max float64

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

Min float64

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

Quartiles []float64

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

StandardDeviation float64

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average Double

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max Double

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min Double

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles List<Double>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation Double

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average number

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max number

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min number

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles number[]

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation number

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average float

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max float

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min float

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles Sequence[float]

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standard_deviation float

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average Number

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max Number

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min Number

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles List<Number>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation Number

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Average double

Average of non-null values in the scanned data. NaN, if the field has a NaN.

Max string

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

Min string

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

Quartiles List<string>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

StandardDeviation double

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

Average float64

Average of non-null values in the scanned data. NaN, if the field has a NaN.

Max string

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

Min string

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

Quartiles []string

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

StandardDeviation float64

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average Double

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max String

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min String

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles List<String>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation Double

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average number

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max string

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min string

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles string[]

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation number

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average float

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max str

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min str

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles Sequence[str]

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standard_deviation float

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

average Number

Average of non-null values in the scanned data. NaN, if the field has a NaN.

max String

Maximum of non-null values in the scanned data. NaN, if the field has a NaN.

min String

Minimum of non-null values in the scanned data. NaN, if the field has a NaN.

quartiles List<String>

A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.

standardDeviation Number

Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.

GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

DistinctRatio double

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

DoubleProfile Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Double type field information.

IntegerProfile Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Integer type field information.

NullRatio double

Ratio of rows with null value against total scanned rows.

StringProfile Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

String type field information.

TopNValues List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse>

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

DistinctRatio float64

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

DoubleProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Double type field information.

IntegerProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Integer type field information.

NullRatio float64

Ratio of rows with null value against total scanned rows.

StringProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

String type field information.

TopNValues []GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

distinctRatio Double

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

doubleProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Double type field information.

integerProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Integer type field information.

nullRatio Double

Ratio of rows with null value against total scanned rows.

stringProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

String type field information.

topNValues List<GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse>

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

distinctRatio number

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

doubleProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Double type field information.

integerProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Integer type field information.

nullRatio number

Ratio of rows with null value against total scanned rows.

stringProfile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

String type field information.

topNValues GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse[]

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

distinct_ratio float

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

double_profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfoResponse

Double type field information.

integer_profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfoResponse

Integer type field information.

null_ratio float

Ratio of rows with null value against total scanned rows.

string_profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

String type field information.

top_n_values Sequence[GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse]

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

distinctRatio Number

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

doubleProfile Property Map

Double type field information.

integerProfile Property Map

Integer type field information.

nullRatio Number

Ratio of rows with null value against total scanned rows.

stringProfile Property Map

String type field information.

topNValues List<Property Map>

The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfoResponse

AverageLength double

Average length of non-null values in the scanned data.

MaxLength string

Maximum length of non-null values in the scanned data.

MinLength string

Minimum length of non-null values in the scanned data.

AverageLength float64

Average length of non-null values in the scanned data.

MaxLength string

Maximum length of non-null values in the scanned data.

MinLength string

Minimum length of non-null values in the scanned data.

averageLength Double

Average length of non-null values in the scanned data.

maxLength String

Maximum length of non-null values in the scanned data.

minLength String

Minimum length of non-null values in the scanned data.

averageLength number

Average length of non-null values in the scanned data.

maxLength string

Maximum length of non-null values in the scanned data.

minLength string

Minimum length of non-null values in the scanned data.

average_length float

Average length of non-null values in the scanned data.

max_length str

Maximum length of non-null values in the scanned data.

min_length str

Minimum length of non-null values in the scanned data.

averageLength Number

Average length of non-null values in the scanned data.

maxLength String

Maximum length of non-null values in the scanned data.

minLength String

Minimum length of non-null values in the scanned data.

GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValueResponse

Count string

Count of the corresponding value in the scanned data.

Value string

String value of a top N non-null value.

Count string

Count of the corresponding value in the scanned data.

Value string

String value of a top N non-null value.

count String

Count of the corresponding value in the scanned data.

value String

String value of a top N non-null value.

count string

Count of the corresponding value in the scanned data.

value string

String value of a top N non-null value.

count str

Count of the corresponding value in the scanned data.

value str

String value of a top N non-null value.

count String

Count of the corresponding value in the scanned data.

value String

String value of a top N non-null value.

GoogleCloudDataplexV1DataProfileResultProfileFieldResponse

Mode string

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

Name string

The name of the field.

Profile Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

Profile information for the corresponding field.

Type string

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

Mode string

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

Name string

The name of the field.

Profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

Profile information for the corresponding field.

Type string

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

mode String

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

name String

The name of the field.

profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

Profile information for the corresponding field.

type String

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

mode string

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

name string

The name of the field.

profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

Profile information for the corresponding field.

type string

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

mode str

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

name str

The name of the field.

profile GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoResponse

Profile information for the corresponding field.

type str

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

mode String

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.

name String

The name of the field.

profile Property Map

Profile information for the corresponding field.

type String

The field data type. Possible values include: STRING BYTE INT64 INT32 INT16 DOUBLE FLOAT DECIMAL BOOLEAN BINARY TIMESTAMP DATE TIME NULL RECORD

GoogleCloudDataplexV1DataProfileResultProfileResponse

Fields []GoogleCloudDataplexV1DataProfileResultProfileFieldResponse

List of fields with structural and profile information for each field.

fields List<GoogleCloudDataplexV1DataProfileResultProfileFieldResponse>

List of fields with structural and profile information for each field.

fields GoogleCloudDataplexV1DataProfileResultProfileFieldResponse[]

List of fields with structural and profile information for each field.

fields Sequence[GoogleCloudDataplexV1DataProfileResultProfileFieldResponse]

List of fields with structural and profile information for each field.

fields List<Property Map>

List of fields with structural and profile information for each field.

GoogleCloudDataplexV1DataProfileResultResponse

Profile GoogleCloudDataplexV1DataProfileResultProfileResponse

The profile information per field.

RowCount string

The count of rows scanned.

ScannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

profile GoogleCloudDataplexV1DataProfileResultProfileResponse

The profile information per field.

rowCount String

The count of rows scanned.

scannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

profile GoogleCloudDataplexV1DataProfileResultProfileResponse

The profile information per field.

rowCount string

The count of rows scanned.

scannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

profile GoogleCloudDataplexV1DataProfileResultProfileResponse

The profile information per field.

row_count str

The count of rows scanned.

scanned_data GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

profile Property Map

The profile information per field.

rowCount String

The count of rows scanned.

scannedData Property Map

The data scanned for this result.

GoogleCloudDataplexV1DataQualityDimensionResultResponse

Passed bool

Whether the dimension passed or failed.

Passed bool

Whether the dimension passed or failed.

passed Boolean

Whether the dimension passed or failed.

passed boolean

Whether the dimension passed or failed.

passed bool

Whether the dimension passed or failed.

passed Boolean

Whether the dimension passed or failed.

GoogleCloudDataplexV1DataQualityResultResponse

Dimensions List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityDimensionResultResponse>

A list of results at the dimension level.

Passed bool

Overall data quality result -- true if all rules passed.

RowCount string

The count of rows processed.

Rules List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleResultResponse>

A list of all the rules in a job, and their results.

ScannedData Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

Dimensions []GoogleCloudDataplexV1DataQualityDimensionResultResponse

A list of results at the dimension level.

Passed bool

Overall data quality result -- true if all rules passed.

RowCount string

The count of rows processed.

Rules []GoogleCloudDataplexV1DataQualityRuleResultResponse

A list of all the rules in a job, and their results.

ScannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

dimensions List<GoogleCloudDataplexV1DataQualityDimensionResultResponse>

A list of results at the dimension level.

passed Boolean

Overall data quality result -- true if all rules passed.

rowCount String

The count of rows processed.

rules List<GoogleCloudDataplexV1DataQualityRuleResultResponse>

A list of all the rules in a job, and their results.

scannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

dimensions GoogleCloudDataplexV1DataQualityDimensionResultResponse[]

A list of results at the dimension level.

passed boolean

Overall data quality result -- true if all rules passed.

rowCount string

The count of rows processed.

rules GoogleCloudDataplexV1DataQualityRuleResultResponse[]

A list of all the rules in a job, and their results.

scannedData GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

dimensions Sequence[GoogleCloudDataplexV1DataQualityDimensionResultResponse]

A list of results at the dimension level.

passed bool

Overall data quality result -- true if all rules passed.

row_count str

The count of rows processed.

rules Sequence[GoogleCloudDataplexV1DataQualityRuleResultResponse]

A list of all the rules in a job, and their results.

scanned_data GoogleCloudDataplexV1ScannedDataResponse

The data scanned for this result.

dimensions List<Property Map>

A list of results at the dimension level.

passed Boolean

Overall data quality result -- true if all rules passed.

rowCount String

The count of rows processed.

rules List<Property Map>

A list of all the rules in a job, and their results.

scannedData Property Map

The data scanned for this result.

GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

MaxValue string

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

MinValue string

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

StrictMaxEnabled bool

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

StrictMinEnabled bool

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

MaxValue string

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

MinValue string

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

StrictMaxEnabled bool

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

StrictMinEnabled bool

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue String

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

minValue String

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

strictMaxEnabled Boolean

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled Boolean

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue string

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

minValue string

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

strictMaxEnabled boolean

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled boolean

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

max_value str

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

min_value str

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

strict_max_enabled bool

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strict_min_enabled bool

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue String

Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

minValue String

Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.

strictMaxEnabled Boolean

Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled Boolean

Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

Regex string

A regular expression the column value is expected to match.

Regex string

A regular expression the column value is expected to match.

regex String

A regular expression the column value is expected to match.

regex string

A regular expression the column value is expected to match.

regex str

A regular expression the column value is expected to match.

regex String

A regular expression the column value is expected to match.

GoogleCloudDataplexV1DataQualityRuleResponse

Column string

Optional. The unnested column which this rule is evaluated against.

Dimension string

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

IgnoreNull bool

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

NonNullExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleNonNullExpectationResponse

ColumnMap rule which evaluates whether each column value is null.

RangeExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

ColumnMap rule which evaluates whether each column value lies between a specified range.

RegexExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

ColumnMap rule which evaluates whether each column value matches a specified regex.

RowConditionExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

Table rule which evaluates whether each row passes the specified condition.

SetExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

ColumnMap rule which evaluates whether each column value is contained by a specified set.

StatisticRangeExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

TableConditionExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

Table rule which evaluates whether the provided expression is true.

Threshold double

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

UniquenessExpectation Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleUniquenessExpectationResponse

ColumnAggregate rule which evaluates whether the column has duplicates.

Column string

Optional. The unnested column which this rule is evaluated against.

Dimension string

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

IgnoreNull bool

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

NonNullExpectation GoogleCloudDataplexV1DataQualityRuleNonNullExpectationResponse

ColumnMap rule which evaluates whether each column value is null.

RangeExpectation GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

ColumnMap rule which evaluates whether each column value lies between a specified range.

RegexExpectation GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

ColumnMap rule which evaluates whether each column value matches a specified regex.

RowConditionExpectation GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

Table rule which evaluates whether each row passes the specified condition.

SetExpectation GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

ColumnMap rule which evaluates whether each column value is contained by a specified set.

StatisticRangeExpectation GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

TableConditionExpectation GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

Table rule which evaluates whether the provided expression is true.

Threshold float64

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

UniquenessExpectation GoogleCloudDataplexV1DataQualityRuleUniquenessExpectationResponse

ColumnAggregate rule which evaluates whether the column has duplicates.

column String

Optional. The unnested column which this rule is evaluated against.

dimension String

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

ignoreNull Boolean

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

nonNullExpectation GoogleCloudDataplexV1DataQualityRuleNonNullExpectationResponse

ColumnMap rule which evaluates whether each column value is null.

rangeExpectation GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

ColumnMap rule which evaluates whether each column value lies between a specified range.

regexExpectation GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

ColumnMap rule which evaluates whether each column value matches a specified regex.

rowConditionExpectation GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

Table rule which evaluates whether each row passes the specified condition.

setExpectation GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

ColumnMap rule which evaluates whether each column value is contained by a specified set.

statisticRangeExpectation GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

tableConditionExpectation GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

Table rule which evaluates whether the provided expression is true.

threshold Double

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

uniquenessExpectation GoogleCloudDataplexV1DataQualityRuleUniquenessExpectationResponse

ColumnAggregate rule which evaluates whether the column has duplicates.

column string

Optional. The unnested column which this rule is evaluated against.

dimension string

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

ignoreNull boolean

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

nonNullExpectation GoogleCloudDataplexV1DataQualityRuleNonNullExpectationResponse

ColumnMap rule which evaluates whether each column value is null.

rangeExpectation GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

ColumnMap rule which evaluates whether each column value lies between a specified range.

regexExpectation GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

ColumnMap rule which evaluates whether each column value matches a specified regex.

rowConditionExpectation GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

Table rule which evaluates whether each row passes the specified condition.

setExpectation GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

ColumnMap rule which evaluates whether each column value is contained by a specified set.

statisticRangeExpectation GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

tableConditionExpectation GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

Table rule which evaluates whether the provided expression is true.

threshold number

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

uniquenessExpectation GoogleCloudDataplexV1DataQualityRuleUniquenessExpectationResponse

ColumnAggregate rule which evaluates whether the column has duplicates.

column str

Optional. The unnested column which this rule is evaluated against.

dimension str

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

ignore_null bool

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

non_null_expectation GoogleCloudDataplexV1DataQualityRuleNonNullExpectationResponse

ColumnMap rule which evaluates whether each column value is null.

range_expectation GoogleCloudDataplexV1DataQualityRuleRangeExpectationResponse

ColumnMap rule which evaluates whether each column value lies between a specified range.

regex_expectation GoogleCloudDataplexV1DataQualityRuleRegexExpectationResponse

ColumnMap rule which evaluates whether each column value matches a specified regex.

row_condition_expectation GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

Table rule which evaluates whether each row passes the specified condition.

set_expectation GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

ColumnMap rule which evaluates whether each column value is contained by a specified set.

statistic_range_expectation GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

table_condition_expectation GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

Table rule which evaluates whether the provided expression is true.

threshold float

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

uniqueness_expectation GoogleCloudDataplexV1DataQualityRuleUniquenessExpectationResponse

ColumnAggregate rule which evaluates whether the column has duplicates.

column String

Optional. The unnested column which this rule is evaluated against.

dimension String

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

ignoreNull Boolean

Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to ColumnMap rules.

nonNullExpectation Property Map

ColumnMap rule which evaluates whether each column value is null.

rangeExpectation Property Map

ColumnMap rule which evaluates whether each column value lies between a specified range.

regexExpectation Property Map

ColumnMap rule which evaluates whether each column value matches a specified regex.

rowConditionExpectation Property Map

Table rule which evaluates whether each row passes the specified condition.

setExpectation Property Map

ColumnMap rule which evaluates whether each column value is contained by a specified set.

statisticRangeExpectation Property Map

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range.

tableConditionExpectation Property Map

Table rule which evaluates whether the provided expression is true.

threshold Number

Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).

uniquenessExpectation Property Map

ColumnAggregate rule which evaluates whether the column has duplicates.

GoogleCloudDataplexV1DataQualityRuleResultResponse

EvaluatedCount string

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

FailingRowsQuery string

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

NullCount string

The number of rows with null values in the specified column.

PassRatio double

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

Passed bool

Whether the rule passed or failed.

PassedCount string

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

Rule Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleResponse

The rule specified in the DataQualitySpec, as is.

EvaluatedCount string

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

FailingRowsQuery string

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

NullCount string

The number of rows with null values in the specified column.

PassRatio float64

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

Passed bool

Whether the rule passed or failed.

PassedCount string

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

Rule GoogleCloudDataplexV1DataQualityRuleResponse

The rule specified in the DataQualitySpec, as is.

evaluatedCount String

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

failingRowsQuery String

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

nullCount String

The number of rows with null values in the specified column.

passRatio Double

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

passed Boolean

Whether the rule passed or failed.

passedCount String

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

rule GoogleCloudDataplexV1DataQualityRuleResponse

The rule specified in the DataQualitySpec, as is.

evaluatedCount string

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

failingRowsQuery string

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

nullCount string

The number of rows with null values in the specified column.

passRatio number

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

passed boolean

Whether the rule passed or failed.

passedCount string

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

rule GoogleCloudDataplexV1DataQualityRuleResponse

The rule specified in the DataQualitySpec, as is.

evaluated_count str

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

failing_rows_query str

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

null_count str

The number of rows with null values in the specified column.

pass_ratio float

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

passed bool

Whether the rule passed or failed.

passed_count str

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

rule GoogleCloudDataplexV1DataQualityRuleResponse

The rule specified in the DataQualitySpec, as is.

evaluatedCount String

The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.

failingRowsQuery String

The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules.

nullCount String

The number of rows with null values in the specified column.

passRatio Number

The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules.

passed Boolean

Whether the rule passed or failed.

passedCount String

The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules.

rule Property Map

The rule specified in the DataQualitySpec, as is.

GoogleCloudDataplexV1DataQualityRuleRowConditionExpectationResponse

SqlExpression string

The SQL expression.

SqlExpression string

The SQL expression.

sqlExpression String

The SQL expression.

sqlExpression string

The SQL expression.

sql_expression str

The SQL expression.

sqlExpression String

The SQL expression.

GoogleCloudDataplexV1DataQualityRuleSetExpectationResponse

Values List<string>

Expected values for the column value.

Values []string

Expected values for the column value.

values List<String>

Expected values for the column value.

values string[]

Expected values for the column value.

values Sequence[str]

Expected values for the column value.

values List<String>

Expected values for the column value.

GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectationResponse

MaxValue string

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

MinValue string

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

Statistic string
StrictMaxEnabled bool

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

StrictMinEnabled bool

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

MaxValue string

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

MinValue string

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

Statistic string
StrictMaxEnabled bool

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

StrictMinEnabled bool

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue String

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

minValue String

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

statistic String
strictMaxEnabled Boolean

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled Boolean

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue string

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

minValue string

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

statistic string
strictMaxEnabled boolean

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled boolean

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

max_value str

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

min_value str

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

statistic str
strict_max_enabled bool

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strict_min_enabled bool

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

maxValue String

The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

minValue String

The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.

statistic String
strictMaxEnabled Boolean

Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.

strictMinEnabled Boolean

Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.

GoogleCloudDataplexV1DataQualityRuleTableConditionExpectationResponse

SqlExpression string

The SQL expression.

SqlExpression string

The SQL expression.

sqlExpression String

The SQL expression.

sqlExpression string

The SQL expression.

sql_expression str

The SQL expression.

sqlExpression String

The SQL expression.

GoogleCloudDataplexV1DataQualitySpecResponse

Rules List<Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1DataQualityRuleResponse>

The list of rules to evaluate against a data source. At least one rule is required.

Rules []GoogleCloudDataplexV1DataQualityRuleResponse

The list of rules to evaluate against a data source. At least one rule is required.

rules List<GoogleCloudDataplexV1DataQualityRuleResponse>

The list of rules to evaluate against a data source. At least one rule is required.

rules GoogleCloudDataplexV1DataQualityRuleResponse[]

The list of rules to evaluate against a data source. At least one rule is required.

rules Sequence[GoogleCloudDataplexV1DataQualityRuleResponse]

The list of rules to evaluate against a data source. At least one rule is required.

rules List<Property Map>

The list of rules to evaluate against a data source. At least one rule is required.

GoogleCloudDataplexV1DataScanExecutionSpecResponse

Field string

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

Trigger Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1TriggerResponse

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

Field string

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

Trigger GoogleCloudDataplexV1TriggerResponse

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

field String

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

trigger GoogleCloudDataplexV1TriggerResponse

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

field string

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

trigger GoogleCloudDataplexV1TriggerResponse

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

field str

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

trigger GoogleCloudDataplexV1TriggerResponse

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

field String

Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table.

trigger Property Map

Optional. Spec related to how often and when a scan should be triggered.If not specified, the default is OnDemand, which means the scan will not run until the user calls RunDataScan API.

GoogleCloudDataplexV1DataScanExecutionStatusResponse

LatestJobEndTime string

The time when the latest DataScanJob ended.

LatestJobStartTime string

The time when the latest DataScanJob started.

LatestJobEndTime string

The time when the latest DataScanJob ended.

LatestJobStartTime string

The time when the latest DataScanJob started.

latestJobEndTime String

The time when the latest DataScanJob ended.

latestJobStartTime String

The time when the latest DataScanJob started.

latestJobEndTime string

The time when the latest DataScanJob ended.

latestJobStartTime string

The time when the latest DataScanJob started.

latest_job_end_time str

The time when the latest DataScanJob ended.

latest_job_start_time str

The time when the latest DataScanJob started.

latestJobEndTime String

The time when the latest DataScanJob ended.

latestJobStartTime String

The time when the latest DataScanJob started.

GoogleCloudDataplexV1DataSourceResponse

Entity string

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

Entity string

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

entity String

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

entity string

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

entity str

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

entity String

Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

GoogleCloudDataplexV1ScannedDataIncrementalFieldResponse

End string

Value that marks the end of the range.

Field string

The field that contains values which monotonically increases over time (e.g. a timestamp column).

Start string

Value that marks the start of the range.

End string

Value that marks the end of the range.

Field string

The field that contains values which monotonically increases over time (e.g. a timestamp column).

Start string

Value that marks the start of the range.

end String

Value that marks the end of the range.

field String

The field that contains values which monotonically increases over time (e.g. a timestamp column).

start String

Value that marks the start of the range.

end string

Value that marks the end of the range.

field string

The field that contains values which monotonically increases over time (e.g. a timestamp column).

start string

Value that marks the start of the range.

end str

Value that marks the end of the range.

field str

The field that contains values which monotonically increases over time (e.g. a timestamp column).

start str

Value that marks the start of the range.

end String

Value that marks the end of the range.

field String

The field that contains values which monotonically increases over time (e.g. a timestamp column).

start String

Value that marks the start of the range.

GoogleCloudDataplexV1ScannedDataResponse

IncrementalField GoogleCloudDataplexV1ScannedDataIncrementalFieldResponse

The range denoted by values of an incremental field

incrementalField GoogleCloudDataplexV1ScannedDataIncrementalFieldResponse

The range denoted by values of an incremental field

incrementalField GoogleCloudDataplexV1ScannedDataIncrementalFieldResponse

The range denoted by values of an incremental field

incremental_field GoogleCloudDataplexV1ScannedDataIncrementalFieldResponse

The range denoted by values of an incremental field

incrementalField Property Map

The range denoted by values of an incremental field

GoogleCloudDataplexV1TriggerResponse

OnDemand GoogleCloudDataplexV1TriggerOnDemandResponse

The scan runs once via RunDataScan API.

Schedule GoogleCloudDataplexV1TriggerScheduleResponse

The scan is scheduled to run periodically.

onDemand GoogleCloudDataplexV1TriggerOnDemandResponse

The scan runs once via RunDataScan API.

schedule GoogleCloudDataplexV1TriggerScheduleResponse

The scan is scheduled to run periodically.

onDemand GoogleCloudDataplexV1TriggerOnDemandResponse

The scan runs once via RunDataScan API.

schedule GoogleCloudDataplexV1TriggerScheduleResponse

The scan is scheduled to run periodically.

on_demand GoogleCloudDataplexV1TriggerOnDemandResponse

The scan runs once via RunDataScan API.

schedule GoogleCloudDataplexV1TriggerScheduleResponse

The scan is scheduled to run periodically.

onDemand Property Map

The scan runs once via RunDataScan API.

schedule Property Map

The scan is scheduled to run periodically.

GoogleCloudDataplexV1TriggerScheduleResponse

Cron string

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

Cron string

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

cron String

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

cron string

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

cron str

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

cron String

Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0