Class protos.google.cloud.dataplex.v1.DataScanJob (3.11.0)

Represents a DataScanJob.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.IDataScanJob);

Constructs a new DataScanJob.

Parameter
Name Description
properties IDataScanJob

Properties to set

Properties

dataProfileResult

public dataProfileResult?: (google.cloud.dataplex.v1.IDataProfileResult|null);

DataScanJob dataProfileResult.

dataProfileSpec

public dataProfileSpec?: (google.cloud.dataplex.v1.IDataProfileSpec|null);

DataScanJob dataProfileSpec.

dataQualityResult

public dataQualityResult?: (google.cloud.dataplex.v1.IDataQualityResult|null);

DataScanJob dataQualityResult.

dataQualitySpec

public dataQualitySpec?: (google.cloud.dataplex.v1.IDataQualitySpec|null);

DataScanJob dataQualitySpec.

endTime

public endTime?: (google.protobuf.ITimestamp|null);

DataScanJob endTime.

message

public message: string;

DataScanJob message.

name

public name: string;

DataScanJob name.

result

public result?: ("dataQualityResult"|"dataProfileResult");

DataScanJob result.

spec

public spec?: ("dataQualitySpec"|"dataProfileSpec");

DataScanJob spec.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

DataScanJob startTime.

state

public state: (google.cloud.dataplex.v1.DataScanJob.State|keyof typeof google.cloud.dataplex.v1.DataScanJob.State);

DataScanJob state.

type

public type: (google.cloud.dataplex.v1.DataScanType|keyof typeof google.cloud.dataplex.v1.DataScanType);

DataScanJob type.

uid

public uid: string;

DataScanJob uid.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IDataScanJob): google.cloud.dataplex.v1.DataScanJob;

Creates a new DataScanJob instance using the specified properties.

Parameter
Name Description
properties IDataScanJob

Properties to set

Returns
Type Description
DataScanJob

DataScanJob instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.DataScanJob;

Decodes a DataScanJob 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
DataScanJob

DataScanJob

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.DataScanJob;

Decodes a DataScanJob message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DataScanJob

DataScanJob

encode(message, writer)

public static encode(message: google.cloud.dataplex.v1.IDataScanJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataScanJob message. Does not implicitly messages.

Parameters
Name Description
message IDataScanJob

DataScanJob 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.IDataScanJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataScanJob message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IDataScanJob

DataScanJob 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.DataScanJob;

Creates a DataScanJob 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
DataScanJob

DataScanJob

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataScanJob

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 DataScanJob to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dataplex.v1.DataScanJob, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DataScanJob message. Also converts values to other types if specified.

Parameters
Name Description
message DataScanJob

DataScanJob

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 DataScanJob message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not