Class DataScanEvent (1.27.0)

public final class DataScanEvent extends GeneratedMessageV3 implements DataScanEventOrBuilder

These messages contain information about the execution of a datascan. The monitored resource is 'DataScan' Next ID: 13

Protobuf type google.cloud.dataplex.v1.DataScanEvent

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_PROFILE_CONFIGS_FIELD_NUMBER

public static final int DATA_PROFILE_CONFIGS_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_PROFILE_FIELD_NUMBER

public static final int DATA_PROFILE_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_QUALITY_CONFIGS_FIELD_NUMBER

public static final int DATA_QUALITY_CONFIGS_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_QUALITY_FIELD_NUMBER

public static final int DATA_QUALITY_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

JOB_ID_FIELD_NUMBER

public static final int JOB_ID_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER

public static final int POST_SCAN_ACTIONS_RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
TypeDescription
int

SPEC_VERSION_FIELD_NUMBER

public static final int SPEC_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TRIGGER_FIELD_NUMBER

public static final int TRIGGER_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataScanEvent getDefaultInstance()
Returns
TypeDescription
DataScanEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DataScanEvent.Builder newBuilder()
Returns
TypeDescription
DataScanEvent.Builder

newBuilder(DataScanEvent prototype)

public static DataScanEvent.Builder newBuilder(DataScanEvent prototype)
Parameter
NameDescription
prototypeDataScanEvent
Returns
TypeDescription
DataScanEvent.Builder

parseDelimitedFrom(InputStream input)

public static DataScanEvent parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DataScanEvent parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataScanEvent parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataScanEvent parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DataScanEvent parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DataScanEvent parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataScanEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataScanEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DataScanEvent> parser()
Returns
TypeDescription
Parser<DataScanEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAppliedConfigsCase()

public DataScanEvent.AppliedConfigsCase getAppliedConfigsCase()
Returns
TypeDescription
DataScanEvent.AppliedConfigsCase

getCreateTime()

public Timestamp getCreateTime()

The time when the data scan job was created.

.google.protobuf.Timestamp create_time = 12;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time when the data scan job was created.

.google.protobuf.Timestamp create_time = 12;

Returns
TypeDescription
TimestampOrBuilder

getDataProfile()

public DataScanEvent.DataProfileResult getDataProfile()

Data profile result for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileResult data_profile = 101;

Returns
TypeDescription
DataScanEvent.DataProfileResult

The dataProfile.

getDataProfileConfigs()

public DataScanEvent.DataProfileAppliedConfigs getDataProfileConfigs()

Applied configs for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileAppliedConfigs data_profile_configs = 201;

Returns
TypeDescription
DataScanEvent.DataProfileAppliedConfigs

The dataProfileConfigs.

getDataProfileConfigsOrBuilder()

public DataScanEvent.DataProfileAppliedConfigsOrBuilder getDataProfileConfigsOrBuilder()

Applied configs for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileAppliedConfigs data_profile_configs = 201;

Returns
TypeDescription
DataScanEvent.DataProfileAppliedConfigsOrBuilder

getDataProfileOrBuilder()

public DataScanEvent.DataProfileResultOrBuilder getDataProfileOrBuilder()

Data profile result for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileResult data_profile = 101;

Returns
TypeDescription
DataScanEvent.DataProfileResultOrBuilder

getDataQuality()

public DataScanEvent.DataQualityResult getDataQuality()

Data quality result for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityResult data_quality = 102;

Returns
TypeDescription
DataScanEvent.DataQualityResult

The dataQuality.

getDataQualityConfigs()

public DataScanEvent.DataQualityAppliedConfigs getDataQualityConfigs()

Applied configs for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityAppliedConfigs data_quality_configs = 202;

Returns
TypeDescription
DataScanEvent.DataQualityAppliedConfigs

The dataQualityConfigs.

getDataQualityConfigsOrBuilder()

public DataScanEvent.DataQualityAppliedConfigsOrBuilder getDataQualityConfigsOrBuilder()

Applied configs for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityAppliedConfigs data_quality_configs = 202;

Returns
TypeDescription
DataScanEvent.DataQualityAppliedConfigsOrBuilder

getDataQualityOrBuilder()

public DataScanEvent.DataQualityResultOrBuilder getDataQualityOrBuilder()

Data quality result for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityResult data_quality = 102;

Returns
TypeDescription
DataScanEvent.DataQualityResultOrBuilder

getDataSource()

public String getDataSource()

The data source of the data scan

string data_source = 1;

Returns
TypeDescription
String

The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

The data source of the data scan

string data_source = 1;

Returns
TypeDescription
ByteString

The bytes for dataSource.

getDefaultInstanceForType()

public DataScanEvent getDefaultInstanceForType()
Returns
TypeDescription
DataScanEvent

getEndTime()

public Timestamp getEndTime()

The time when the data scan job finished.

.google.protobuf.Timestamp end_time = 4;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time when the data scan job finished.

.google.protobuf.Timestamp end_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getJobId()

public String getJobId()

The identifier of the specific data scan job this log entry is for.

string job_id = 2;

Returns
TypeDescription
String

The jobId.

getJobIdBytes()

public ByteString getJobIdBytes()

The identifier of the specific data scan job this log entry is for.

string job_id = 2;

Returns
TypeDescription
ByteString

The bytes for jobId.

getMessage()

public String getMessage()

The message describing the data scan job event.

string message = 7;

Returns
TypeDescription
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

The message describing the data scan job event.

string message = 7;

Returns
TypeDescription
ByteString

The bytes for message.

getParserForType()

public Parser<DataScanEvent> getParserForType()
Returns
TypeDescription
Parser<DataScanEvent>
Overrides

getPostScanActionsResult()

public DataScanEvent.PostScanActionsResult getPostScanActionsResult()

The result of post scan actions.

.google.cloud.dataplex.v1.DataScanEvent.PostScanActionsResult post_scan_actions_result = 11;

Returns
TypeDescription
DataScanEvent.PostScanActionsResult

The postScanActionsResult.

getPostScanActionsResultOrBuilder()

public DataScanEvent.PostScanActionsResultOrBuilder getPostScanActionsResultOrBuilder()

The result of post scan actions.

.google.cloud.dataplex.v1.DataScanEvent.PostScanActionsResult post_scan_actions_result = 11;

Returns
TypeDescription
DataScanEvent.PostScanActionsResultOrBuilder

getResultCase()

public DataScanEvent.ResultCase getResultCase()
Returns
TypeDescription
DataScanEvent.ResultCase

getScope()

public DataScanEvent.Scope getScope()

The scope of the data scan (e.g. full, incremental).

.google.cloud.dataplex.v1.DataScanEvent.Scope scope = 10;

Returns
TypeDescription
DataScanEvent.Scope

The scope.

getScopeValue()

public int getScopeValue()

The scope of the data scan (e.g. full, incremental).

.google.cloud.dataplex.v1.DataScanEvent.Scope scope = 10;

Returns
TypeDescription
int

The enum numeric value on the wire for scope.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpecVersion()

public String getSpecVersion()

A version identifier of the spec which was used to execute this job.

string spec_version = 8;

Returns
TypeDescription
String

The specVersion.

getSpecVersionBytes()

public ByteString getSpecVersionBytes()

A version identifier of the spec which was used to execute this job.

string spec_version = 8;

Returns
TypeDescription
ByteString

The bytes for specVersion.

getStartTime()

public Timestamp getStartTime()

The time when the data scan job started to run.

.google.protobuf.Timestamp start_time = 3;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time when the data scan job started to run.

.google.protobuf.Timestamp start_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getState()

public DataScanEvent.State getState()

The status of the data scan job.

.google.cloud.dataplex.v1.DataScanEvent.State state = 6;

Returns
TypeDescription
DataScanEvent.State

The state.

getStateValue()

public int getStateValue()

The status of the data scan job.

.google.cloud.dataplex.v1.DataScanEvent.State state = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTrigger()

public DataScanEvent.Trigger getTrigger()

The trigger type of the data scan job.

.google.cloud.dataplex.v1.DataScanEvent.Trigger trigger = 9;

Returns
TypeDescription
DataScanEvent.Trigger

The trigger.

getTriggerValue()

public int getTriggerValue()

The trigger type of the data scan job.

.google.cloud.dataplex.v1.DataScanEvent.Trigger trigger = 9;

Returns
TypeDescription
int

The enum numeric value on the wire for trigger.

getType()

public DataScanEvent.ScanType getType()

The type of the data scan.

.google.cloud.dataplex.v1.DataScanEvent.ScanType type = 5;

Returns
TypeDescription
DataScanEvent.ScanType

The type.

getTypeValue()

public int getTypeValue()

The type of the data scan.

.google.cloud.dataplex.v1.DataScanEvent.ScanType type = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

hasCreateTime()

public boolean hasCreateTime()

The time when the data scan job was created.

.google.protobuf.Timestamp create_time = 12;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDataProfile()

public boolean hasDataProfile()

Data profile result for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileResult data_profile = 101;

Returns
TypeDescription
boolean

Whether the dataProfile field is set.

hasDataProfileConfigs()

public boolean hasDataProfileConfigs()

Applied configs for data profile type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataProfileAppliedConfigs data_profile_configs = 201;

Returns
TypeDescription
boolean

Whether the dataProfileConfigs field is set.

hasDataQuality()

public boolean hasDataQuality()

Data quality result for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityResult data_quality = 102;

Returns
TypeDescription
boolean

Whether the dataQuality field is set.

hasDataQualityConfigs()

public boolean hasDataQualityConfigs()

Applied configs for data quality type data scan.

.google.cloud.dataplex.v1.DataScanEvent.DataQualityAppliedConfigs data_quality_configs = 202;

Returns
TypeDescription
boolean

Whether the dataQualityConfigs field is set.

hasEndTime()

public boolean hasEndTime()

The time when the data scan job finished.

.google.protobuf.Timestamp end_time = 4;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasPostScanActionsResult()

public boolean hasPostScanActionsResult()

The result of post scan actions.

.google.cloud.dataplex.v1.DataScanEvent.PostScanActionsResult post_scan_actions_result = 11;

Returns
TypeDescription
boolean

Whether the postScanActionsResult field is set.

hasStartTime()

public boolean hasStartTime()

The time when the data scan job started to run.

.google.protobuf.Timestamp start_time = 3;

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DataScanEvent.Builder newBuilderForType()
Returns
TypeDescription
DataScanEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataScanEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DataScanEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DataScanEvent.Builder toBuilder()
Returns
TypeDescription
DataScanEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException