Represents a DataScan.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IDataScan);Constructs a new DataScan.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataScan
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);DataScan createTime.
data
public data?: (google.cloud.dataplex.v1.IDataSource|null);DataScan data.
dataProfileResult
public dataProfileResult?: (google.cloud.dataplex.v1.IDataProfileResult|null);DataScan dataProfileResult.
dataProfileSpec
public dataProfileSpec?: (google.cloud.dataplex.v1.IDataProfileSpec|null);DataScan dataProfileSpec.
dataQualityResult
public dataQualityResult?: (google.cloud.dataplex.v1.IDataQualityResult|null);DataScan dataQualityResult.
dataQualitySpec
public dataQualitySpec?: (google.cloud.dataplex.v1.IDataQualitySpec|null);DataScan dataQualitySpec.
description
public description: string;DataScan description.
displayName
public displayName: string;DataScan displayName.
executionSpec
public executionSpec?: (google.cloud.dataplex.v1.DataScan.IExecutionSpec|null);DataScan executionSpec.
executionStatus
public executionStatus?: (google.cloud.dataplex.v1.DataScan.IExecutionStatus|null);DataScan executionStatus.
labels
public labels: { [k: string]: string };DataScan labels.
name
public name: string;DataScan name.
result
public result?: ("dataQualityResult"|"dataProfileResult");DataScan result.
spec
public spec?: ("dataQualitySpec"|"dataProfileSpec");DataScan spec.
state
public state: (google.cloud.dataplex.v1.State|keyof typeof google.cloud.dataplex.v1.State);DataScan state.
type
public type: (google.cloud.dataplex.v1.DataScanType|keyof typeof google.cloud.dataplex.v1.DataScanType);DataScan type.
uid
public uid: string;DataScan uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);DataScan updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.IDataScan): google.cloud.dataplex.v1.DataScan;Creates a new DataScan instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataScan
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DataScan | DataScan instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.DataScan;Decodes a DataScan 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 |
DataScan | DataScan |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.DataScan;Decodes a DataScan message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DataScan | DataScan |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.IDataScan, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataScan message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataScan
DataScan 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.IDataScan, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataScan message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataScan
DataScan 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.DataScan;Creates a DataScan 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 |
DataScan | DataScan |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataScan
| 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 DataScan to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.DataScan, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DataScan message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DataScan
DataScan |
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 DataScan message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|