Represents a DataQualityRule.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IDataQualityRule);Constructs a new DataQualityRule.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataQualityRule
Properties to set |
Properties
column
public column: string;DataQualityRule column.
description
public description: string;DataQualityRule description.
dimension
public dimension: string;DataQualityRule dimension.
ignoreNull
public ignoreNull: boolean;DataQualityRule ignoreNull.
name
public name: string;DataQualityRule name.
nonNullExpectation
public nonNullExpectation?: (google.cloud.dataplex.v1.DataQualityRule.INonNullExpectation|null);DataQualityRule nonNullExpectation.
rangeExpectation
public rangeExpectation?: (google.cloud.dataplex.v1.DataQualityRule.IRangeExpectation|null);DataQualityRule rangeExpectation.
regexExpectation
public regexExpectation?: (google.cloud.dataplex.v1.DataQualityRule.IRegexExpectation|null);DataQualityRule regexExpectation.
rowConditionExpectation
public rowConditionExpectation?: (google.cloud.dataplex.v1.DataQualityRule.IRowConditionExpectation|null);DataQualityRule rowConditionExpectation.
ruleType
public ruleType?: ("rangeExpectation"|"nonNullExpectation"|"setExpectation"|"regexExpectation"|"uniquenessExpectation"|"statisticRangeExpectation"|"rowConditionExpectation"|"tableConditionExpectation");DataQualityRule ruleType.
setExpectation
public setExpectation?: (google.cloud.dataplex.v1.DataQualityRule.ISetExpectation|null);DataQualityRule setExpectation.
statisticRangeExpectation
public statisticRangeExpectation?: (google.cloud.dataplex.v1.DataQualityRule.IStatisticRangeExpectation|null);DataQualityRule statisticRangeExpectation.
tableConditionExpectation
public tableConditionExpectation?: (google.cloud.dataplex.v1.DataQualityRule.ITableConditionExpectation|null);DataQualityRule tableConditionExpectation.
threshold
public threshold: number;DataQualityRule threshold.
uniquenessExpectation
public uniquenessExpectation?: (google.cloud.dataplex.v1.DataQualityRule.IUniquenessExpectation|null);DataQualityRule uniquenessExpectation.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.IDataQualityRule): google.cloud.dataplex.v1.DataQualityRule;Creates a new DataQualityRule instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataQualityRule
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DataQualityRule | DataQualityRule instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.DataQualityRule;Decodes a DataQualityRule message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
DataQualityRule | DataQualityRule |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.DataQualityRule;Decodes a DataQualityRule message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DataQualityRule | DataQualityRule |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.IDataQualityRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataQualityRule message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataQualityRule
DataQualityRule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dataplex.v1.IDataQualityRule, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataQualityRule message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataQualityRule
DataQualityRule message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dataplex.v1.DataQualityRule;Creates a DataQualityRule message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
DataQualityRule | DataQualityRule |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataQualityRule
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this DataQualityRule to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.DataQualityRule, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DataQualityRule message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DataQualityRule
DataQualityRule |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a DataQualityRule message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|