Package com.google.cloud.dataplex.v1

Class DataScanJob

  • All Implemented Interfaces:
    DataScanJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataScanJob
extends com.google.protobuf.GeneratedMessageV3
implements DataScanJobOrBuilder
     A DataScanJob represents an instance of DataScan execution.
    Protobuf type google.cloud.dataplex.v1.DataScanJob
    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()

      • 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 DataScanJob, of the form:
 `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_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 DataScanJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The relative resource name of the DataScanJob, of the form:
 `projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_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 DataScanJobOrBuilder
        Returns:
        The bytes for name.

      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the DataScanJob.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface DataScanJobOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the DataScanJob.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface DataScanJobOrBuilder
        Returns:
        The bytes for uid.

      • hasStartTime

        public boolean hasStartTime()
         Output only. The time when the DataScanJob was started.
        .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasStartTime in interface DataScanJobOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. The time when the DataScanJob was started.
        .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface DataScanJobOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. The time when the DataScanJob was started.
        .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface DataScanJobOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. The time when the DataScanJob ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface DataScanJobOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. The time when the DataScanJob ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface DataScanJobOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. The time when the DataScanJob ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface DataScanJobOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. Execution state for the DataScanJob.
        .google.cloud.dataplex.v1.DataScanJob.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface DataScanJobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public DataScanJob.State getState()
         Output only. Execution state for the DataScanJob.
        .google.cloud.dataplex.v1.DataScanJob.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface DataScanJobOrBuilder
        Returns:
        The state.

      • getMessage

        public String getMessage()
         Output only. Additional information about the current state.
        string message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMessage in interface DataScanJobOrBuilder
        Returns:
        The message.

      • getMessageBytes

        public com.google.protobuf.ByteString getMessageBytes()
         Output only. Additional information about the current state.
        string message = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMessageBytes in interface DataScanJobOrBuilder
        Returns:
        The bytes for message.

      • getTypeValue

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

      • getType

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

      • hasDataQualitySpec

        public boolean hasDataQualitySpec()
         Output only. DataQualityScan related setting.
        .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDataQualitySpec in interface DataScanJobOrBuilder
        Returns:
        Whether the dataQualitySpec field is set.

      • getDataQualitySpec

        public DataQualitySpec getDataQualitySpec()
         Output only. DataQualityScan related setting.
        .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataQualitySpec in interface DataScanJobOrBuilder
        Returns:
        The dataQualitySpec.

      • hasDataProfileSpec

        public boolean hasDataProfileSpec()
         Output only. DataProfileScan related setting.
        .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDataProfileSpec in interface DataScanJobOrBuilder
        Returns:
        Whether the dataProfileSpec field is set.

      • getDataProfileSpec

        public DataProfileSpec getDataProfileSpec()
         Output only. DataProfileScan related setting.
        .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataProfileSpec in interface DataScanJobOrBuilder
        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 DataScanJobOrBuilder
        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 DataScanJobOrBuilder
        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 DataScanJobOrBuilder
        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 DataScanJobOrBuilder
        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 DataScanJob parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static DataScanJob getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DataScanJob> 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 DataScanJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder