Represents a DataQualityScanRuleResult.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IDataQualityScanRuleResult);Constructs a new DataQualityScanRuleResult.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataQualityScanRuleResult
Properties to set |
Properties
column
public column: string;DataQualityScanRuleResult column.
dataSource
public dataSource: string;DataQualityScanRuleResult dataSource.
evaluatedRowCount
public evaluatedRowCount: (number|Long|string);DataQualityScanRuleResult evaluatedRowCount.
evalutionType
public evalutionType: (google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType|keyof typeof google.cloud.dataplex.v1.DataQualityScanRuleResult.EvaluationType);DataQualityScanRuleResult evalutionType.
jobId
public jobId: string;DataQualityScanRuleResult jobId.
nullRowCount
public nullRowCount: (number|Long|string);DataQualityScanRuleResult nullRowCount.
passedRowCount
public passedRowCount: (number|Long|string);DataQualityScanRuleResult passedRowCount.
result
public result: (google.cloud.dataplex.v1.DataQualityScanRuleResult.Result|keyof typeof google.cloud.dataplex.v1.DataQualityScanRuleResult.Result);DataQualityScanRuleResult result.
ruleDimension
public ruleDimension: string;DataQualityScanRuleResult ruleDimension.
ruleName
public ruleName: string;DataQualityScanRuleResult ruleName.
ruleType
public ruleType: (google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType|keyof typeof google.cloud.dataplex.v1.DataQualityScanRuleResult.RuleType);DataQualityScanRuleResult ruleType.
thresholdPercent
public thresholdPercent: number;DataQualityScanRuleResult thresholdPercent.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.IDataQualityScanRuleResult): google.cloud.dataplex.v1.DataQualityScanRuleResult;Creates a new DataQualityScanRuleResult instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataQualityScanRuleResult
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DataQualityScanRuleResult | DataQualityScanRuleResult instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.DataQualityScanRuleResult;Decodes a DataQualityScanRuleResult 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 |
DataQualityScanRuleResult | DataQualityScanRuleResult |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.DataQualityScanRuleResult;Decodes a DataQualityScanRuleResult message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DataQualityScanRuleResult | DataQualityScanRuleResult |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.IDataQualityScanRuleResult, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataQualityScanRuleResult message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataQualityScanRuleResult
DataQualityScanRuleResult 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.IDataQualityScanRuleResult, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataQualityScanRuleResult message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataQualityScanRuleResult
DataQualityScanRuleResult 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.DataQualityScanRuleResult;Creates a DataQualityScanRuleResult 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 |
DataQualityScanRuleResult | DataQualityScanRuleResult |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataQualityScanRuleResult
| 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 DataQualityScanRuleResult to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.DataQualityScanRuleResult, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DataQualityScanRuleResult message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DataQualityScanRuleResult
DataQualityScanRuleResult |
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 DataQualityScanRuleResult message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|