Package com.google.cloud.dataplex.v1

Interface DataScanOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataScan, DataScan.Builder
@Generated public interface DataScanOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Identifier. 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 Google Cloud region.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Identifier. 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 Google Cloud region.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getUid

      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, (.google.api.field_info) = { ... }
      Returns:
      The uid.

    • getUidBytes

      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, (.google.api.field_info) = { ... }
      Returns:
      The bytes for uid.

    • getDescription

      String getDescription()
       Optional. Description of the scan.

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

    • getDescriptionBytes

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

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

    • getDisplayName

      String getDisplayName()
       Optional. User friendly display name.

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

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getLabelsCount

      int getLabelsCount()
       Optional. User-defined labels for the scan.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. User-defined labels for the scan.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. User-defined labels for the scan.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. User-defined labels for the scan.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. User-defined labels for the scan.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getStateValue

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

    • getState

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

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

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

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasData

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

    • getData

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

    • getDataOrBuilder

      DataSourceOrBuilder getDataOrBuilder()
       Required. The data source for DataScan.
      .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];

    • hasExecutionSpec

      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];
      Returns:
      Whether the executionSpec field is set.

    • getExecutionSpec

      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];
      Returns:
      The executionSpec.

    • getExecutionSpecOrBuilder

      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];

    • hasExecutionStatus

      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];
      Returns:
      Whether the executionStatus field is set.

    • getExecutionStatus

      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];
      Returns:
      The executionStatus.

    • getExecutionStatusOrBuilder

      DataScan.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()
       Output only. Status of the data scan execution.
      .google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getTypeValue

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

    • getType

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

    • hasDataQualitySpec

      boolean hasDataQualitySpec()
       Settings for a data quality scan.
      .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
      Returns:
      Whether the dataQualitySpec field is set.

    • getDataQualitySpec

      DataQualitySpec getDataQualitySpec()
       Settings for a data quality scan.
      .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
      Returns:
      The dataQualitySpec.

    • getDataQualitySpecOrBuilder

      DataQualitySpecOrBuilder getDataQualitySpecOrBuilder()
       Settings for a data quality scan.
      .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;

    • hasDataProfileSpec

      boolean hasDataProfileSpec()
       Settings for a data profile scan.
      .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
      Returns:
      Whether the dataProfileSpec field is set.

    • getDataProfileSpec

      DataProfileSpec getDataProfileSpec()
       Settings for a data profile scan.
      .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
      Returns:
      The dataProfileSpec.

    • getDataProfileSpecOrBuilder

      DataProfileSpecOrBuilder getDataProfileSpecOrBuilder()
       Settings for a data profile scan.
      .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;

    • hasDataDiscoverySpec

      boolean hasDataDiscoverySpec()
       Settings for a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;
      Returns:
      Whether the dataDiscoverySpec field is set.

    • getDataDiscoverySpec

      DataDiscoverySpec getDataDiscoverySpec()
       Settings for a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;
      Returns:
      The dataDiscoverySpec.

    • getDataDiscoverySpecOrBuilder

      DataDiscoverySpecOrBuilder getDataDiscoverySpecOrBuilder()
       Settings for a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoverySpec data_discovery_spec = 102;

    • hasDataDocumentationSpec

      boolean hasDataDocumentationSpec()
       Settings for a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationSpec data_documentation_spec = 103;
      Returns:
      Whether the dataDocumentationSpec field is set.

    • getDataDocumentationSpec

      DataDocumentationSpec getDataDocumentationSpec()
       Settings for a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationSpec data_documentation_spec = 103;
      Returns:
      The dataDocumentationSpec.

    • getDataDocumentationSpecOrBuilder

      DataDocumentationSpecOrBuilder getDataDocumentationSpecOrBuilder()
       Settings for a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationSpec data_documentation_spec = 103;

    • hasDataQualityResult

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

    • getDataQualityResult

      DataQualityResult getDataQualityResult()
       Output only. The result of a data quality scan.
      .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataQualityResult.

    • getDataQualityResultOrBuilder

      DataQualityResultOrBuilder getDataQualityResultOrBuilder()
       Output only. The result of a data quality scan.
      .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDataProfileResult

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

    • getDataProfileResult

      DataProfileResult getDataProfileResult()
       Output only. The result of a data profile scan.
      .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataProfileResult.

    • getDataProfileResultOrBuilder

      DataProfileResultOrBuilder getDataProfileResultOrBuilder()
       Output only. The result of a data profile scan.
      .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDataDiscoveryResult

      boolean hasDataDiscoveryResult()
       Output only. The result of a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the dataDiscoveryResult field is set.

    • getDataDiscoveryResult

      DataDiscoveryResult getDataDiscoveryResult()
       Output only. The result of a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataDiscoveryResult.

    • getDataDiscoveryResultOrBuilder

      DataDiscoveryResultOrBuilder getDataDiscoveryResultOrBuilder()
       Output only. The result of a data discovery scan.
      .google.cloud.dataplex.v1.DataDiscoveryResult data_discovery_result = 202 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasDataDocumentationResult

      boolean hasDataDocumentationResult()
       Output only. The result of a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationResult data_documentation_result = 203 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the dataDocumentationResult field is set.

    • getDataDocumentationResult

      DataDocumentationResult getDataDocumentationResult()
       Output only. The result of a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationResult data_documentation_result = 203 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataDocumentationResult.

    • getDataDocumentationResultOrBuilder

      DataDocumentationResultOrBuilder getDataDocumentationResultOrBuilder()
       Output only. The result of a data documentation scan.
      .google.cloud.dataplex.v1.DataDocumentationResult data_documentation_result = 203 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSpecCase

      DataScan.SpecCase getSpecCase()

    • getResultCase

      DataScan.ResultCase getResultCase()