Package com.google.cloud.dataplex.v1

Class DataScan

  • All Implemented Interfaces:
    DataScanOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataScan
extends com.google.protobuf.GeneratedMessageV3
implements DataScanOrBuilder
     Represents a user-visible job which provides the insights for the related
 data source.

 For example:

 * Data Quality: generates queries based on the rules and runs against the
   data to get data quality check results.
 * Data Profile: analyzes the data in table(s) and generates insights about
   the structure, content and relationships (such as null percent,
   cardinality, min/max/mean, etc).
    Protobuf type google.cloud.dataplex.v1.DataScan
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The relative resource name of the scan, of the form:
 `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
 where `project` refers to a *project_id* or *project_number* and
 `location_id` refers to a GCP region.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface DataScanOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The relative resource name of the scan, of the form:
 `projects/{project}/locations/{location_id}/dataScans/{datascan_id}`,
 where `project` refers to a *project_id* or *project_number* and
 `location_id` refers to a GCP region.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface DataScanOrBuilder
        Returns:
        The bytes for name.

      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the scan. This ID will
 be different if the scan is deleted and re-created with the same name.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface DataScanOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the scan. This ID will
 be different if the scan is deleted and re-created with the same name.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface DataScanOrBuilder
        Returns:
        The bytes for uid.

      • getDescription

        public String getDescription()
         Optional. Description of the scan.

 * Must be between 1-1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface DataScanOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Description of the scan.

 * Must be between 1-1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface DataScanOrBuilder
        Returns:
        The bytes for description.

      • getDisplayName

        public String getDisplayName()
         Optional. User friendly display name.

 * Must be between 1-256 characters.
        string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface DataScanOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. User friendly display name.

 * Must be between 1-256 characters.
        string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface DataScanOrBuilder
        Returns:
        The bytes for displayName.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DataScanOrBuilder
         Optional. User-defined labels for the scan.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface DataScanOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. User-defined labels for the scan.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface DataScanOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. User-defined labels for the scan.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface DataScanOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. User-defined labels for the scan.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface DataScanOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. User-defined labels for the scan.
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface DataScanOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. Current state of the DataScan.
        .google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface DataScanOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public State getState()
         Output only. Current state of the DataScan.
        .google.cloud.dataplex.v1.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface DataScanOrBuilder
        Returns:
        The state.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the scan was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DataScanOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the scan was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DataScanOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the scan was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DataScanOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time when the scan was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface DataScanOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the scan was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DataScanOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the scan was last updated.
        .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DataScanOrBuilder

      • hasData

        public boolean hasData()
         Required. The data source for DataScan.
        .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasData in interface DataScanOrBuilder
        Returns:
        Whether the data field is set.

      • getData

        public DataSource getData()
         Required. The data source for DataScan.
        .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getData in interface DataScanOrBuilder
        Returns:
        The data.

      • hasExecutionSpec

        public boolean hasExecutionSpec()
         Optional. DataScan execution settings.

 If not specified, the fields in it will use their default values.
        .google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasExecutionSpec in interface DataScanOrBuilder
        Returns:
        Whether the executionSpec field is set.

      • getExecutionSpec

        public DataScan.ExecutionSpec getExecutionSpec()
         Optional. DataScan execution settings.

 If not specified, the fields in it will use their default values.
        .google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExecutionSpec in interface DataScanOrBuilder
        Returns:
        The executionSpec.

      • getExecutionSpecOrBuilder

        public DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()
         Optional. DataScan execution settings.

 If not specified, the fields in it will use their default values.
        .google.cloud.dataplex.v1.DataScan.ExecutionSpec execution_spec = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExecutionSpecOrBuilder in interface DataScanOrBuilder

      • hasExecutionStatus

        public boolean hasExecutionStatus()
         Output only. Status of the data scan execution.
        .google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasExecutionStatus in interface DataScanOrBuilder
        Returns:
        Whether the executionStatus field is set.

      • getExecutionStatus

        public DataScan.ExecutionStatus getExecutionStatus()
         Output only. Status of the data scan execution.
        .google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExecutionStatus in interface DataScanOrBuilder
        Returns:
        The executionStatus.

      • getTypeValue

        public int getTypeValue()
         Output only. The type of DataScan.
        .google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTypeValue in interface DataScanOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public DataScanType getType()
         Output only. The type of DataScan.
        .google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getType in interface DataScanOrBuilder
        Returns:
        The type.

      • hasDataQualitySpec

        public boolean hasDataQualitySpec()
         DataQualityScan related setting.
        .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
        Specified by:
        hasDataQualitySpec in interface DataScanOrBuilder
        Returns:
        Whether the dataQualitySpec field is set.

      • getDataQualitySpec

        public DataQualitySpec getDataQualitySpec()
         DataQualityScan related setting.
        .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
        Specified by:
        getDataQualitySpec in interface DataScanOrBuilder
        Returns:
        The dataQualitySpec.

      • hasDataProfileSpec

        public boolean hasDataProfileSpec()
         DataProfileScan related setting.
        .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
        Specified by:
        hasDataProfileSpec in interface DataScanOrBuilder
        Returns:
        Whether the dataProfileSpec field is set.

      • getDataProfileSpec

        public DataProfileSpec getDataProfileSpec()
         DataProfileScan related setting.
        .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
        Specified by:
        getDataProfileSpec in interface DataScanOrBuilder
        Returns:
        The dataProfileSpec.

      • hasDataQualityResult

        public boolean hasDataQualityResult()
         Output only. The result of the data quality scan.
        .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDataQualityResult in interface DataScanOrBuilder
        Returns:
        Whether the dataQualityResult field is set.

      • getDataQualityResult

        public DataQualityResult getDataQualityResult()
         Output only. The result of the data quality scan.
        .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataQualityResult in interface DataScanOrBuilder
        Returns:
        The dataQualityResult.

      • hasDataProfileResult

        public boolean hasDataProfileResult()
         Output only. The result of the data profile scan.
        .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDataProfileResult in interface DataScanOrBuilder
        Returns:
        Whether the dataProfileResult field is set.

      • getDataProfileResult

        public DataProfileResult getDataProfileResult()
         Output only. The result of the data profile scan.
        .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataProfileResult in interface DataScanOrBuilder
        Returns:
        The dataProfileResult.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DataScan parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataScan parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DataScan.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DataScan.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DataScan.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static DataScan getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<DataScan> parser()

      • getParserForType

        public com.google.protobuf.Parser<DataScan> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public DataScan getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder