Class protos.google.cloud.dataplex.v1.DataScanEvent (3.7.0)

Represents a DataScanEvent.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new DataScanEvent.

Parameter
Name Description
properties IDataScanEvent

Properties to set

Properties

appliedConfigs

public appliedConfigs?: ("dataProfileConfigs"|"dataQualityConfigs");

DataScanEvent appliedConfigs.

createTime

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

DataScanEvent createTime.

dataProfile

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

DataScanEvent dataProfile.

dataProfileConfigs

public dataProfileConfigs?: (google.cloud.dataplex.v1.DataScanEvent.IDataProfileAppliedConfigs|null);

DataScanEvent dataProfileConfigs.

dataQuality

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

DataScanEvent dataQuality.

dataQualityConfigs

public dataQualityConfigs?: (google.cloud.dataplex.v1.DataScanEvent.IDataQualityAppliedConfigs|null);

DataScanEvent dataQualityConfigs.

dataSource

public dataSource: string;

DataScanEvent dataSource.

endTime

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

DataScanEvent endTime.

jobId

public jobId: string;

DataScanEvent jobId.

message

public message: string;

DataScanEvent message.

postScanActionsResult

public postScanActionsResult?: (google.cloud.dataplex.v1.DataScanEvent.IPostScanActionsResult|null);

DataScanEvent postScanActionsResult.

result

public result?: ("dataProfile"|"dataQuality");

DataScanEvent result.

scope

public scope: (google.cloud.dataplex.v1.DataScanEvent.Scope|keyof typeof google.cloud.dataplex.v1.DataScanEvent.Scope);

DataScanEvent scope.

specVersion

public specVersion: string;

DataScanEvent specVersion.

startTime

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

DataScanEvent startTime.

state

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

DataScanEvent state.

trigger

public trigger: (google.cloud.dataplex.v1.DataScanEvent.Trigger|keyof typeof google.cloud.dataplex.v1.DataScanEvent.Trigger);

DataScanEvent trigger.

type

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

DataScanEvent type.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IDataScanEvent): google.cloud.dataplex.v1.DataScanEvent;

Creates a new DataScanEvent instance using the specified properties.

Parameter
Name Description
properties IDataScanEvent

Properties to set
Returns
Type Description
DataScanEvent

DataScanEvent instance

decode(reader, length)

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

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

DataScanEvent

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
DataScanEvent

DataScanEvent

encode(message, writer)

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

Encodes the specified DataScanEvent message. Does not implicitly messages.

Parameters
Name Description
message IDataScanEvent

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

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

Parameters
Name Description
message IDataScanEvent

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

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

DataScanEvent

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DataScanEvent

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DataScanEvent

DataScanEvent
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 DataScanEvent 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