com.google.cloud.dataplex.v1.DataScanOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dataplex/v1/datascans.proto

// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;

public interface DataScanOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.DataScan)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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];
   *
   * @return The name.
   */
  java.lang.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];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * 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];
   *
   * @return The uid.
   */
  java.lang.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];
   *
   * @return The bytes for uid.
   */
  com.google.protobuf.ByteString getUidBytes();

  /**
   *
   *
   *    * Optional. Description of the scan.
   *
   * * Must be between 1-1024 characters.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * Optional. Description of the scan.
   *
   * * Must be between 1-1024 characters.
   * 
   *
   * string description = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * Optional. User friendly display name.
   *
   * * Must be between 1-256 characters.
   * 
   *
   * string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * Optional. User friendly display name.
   *
   * * Must be between 1-256 characters.
   * 
   *
   * string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * Optional. User-defined labels for the scan.
   * 
   *
   * map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getLabelsCount();
  /**
   *
   *
   *    * Optional. User-defined labels for the scan.
   * 
   *
   * map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   *    * Optional. User-defined labels for the scan.
   * 
   *
   * map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * Optional. User-defined labels for the scan.
   * 
   *
   * map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
   */
  /* nullable */
  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. User-defined labels for the scan.
   * 
   *
   * map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);

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

  /**
   *
   *
   *    * Output only. The time when the scan was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   *    * Output only. The time when the scan was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   *    * Output only. The time when the scan was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   *    * Output only. The time when the scan was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   *    * Required. The data source for DataScan.
   * 
   *
   * .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the data field is set.
   */
  boolean hasData();
  /**
   *
   *
   *    * Required. The data source for DataScan.
   * 
   *
   * .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The data.
   */
  com.google.cloud.dataplex.v1.DataSource getData();
  /**
   *
   *
   *    * Required. The data source for DataScan.
   * 
   *
   * .google.cloud.dataplex.v1.DataSource data = 9 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dataplex.v1.DataSourceOrBuilder getDataOrBuilder();

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the executionSpec field is set.
   */
  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];
   * 
   *
   * @return The executionSpec.
   */
  com.google.cloud.dataplex.v1.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];
   * 
   */
  com.google.cloud.dataplex.v1.DataScan.ExecutionSpecOrBuilder getExecutionSpecOrBuilder();

  /**
   *
   *
   *    * Output only. Status of the data scan execution.
   * 
   *
   * 
   * .google.cloud.dataplex.v1.DataScan.ExecutionStatus execution_status = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the executionStatus field is set.
   */
  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];
   * 
   *
   * @return The executionStatus.
   */
  com.google.cloud.dataplex.v1.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];
   * 
   */
  com.google.cloud.dataplex.v1.DataScan.ExecutionStatusOrBuilder getExecutionStatusOrBuilder();

  /**
   *
   *
   *    * Output only. The type of DataScan.
   * 
   *
   * 
   * .google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *
   *
   *    * Output only. The type of DataScan.
   * 
   *
   * 
   * .google.cloud.dataplex.v1.DataScanType type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The type.
   */
  com.google.cloud.dataplex.v1.DataScanType getType();

  /**
   *
   *
   *    * DataQualityScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
   *
   * @return Whether the dataQualitySpec field is set.
   */
  boolean hasDataQualitySpec();
  /**
   *
   *
   *    * DataQualityScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
   *
   * @return The dataQualitySpec.
   */
  com.google.cloud.dataplex.v1.DataQualitySpec getDataQualitySpec();
  /**
   *
   *
   *    * DataQualityScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataQualitySpec data_quality_spec = 100;
   */
  com.google.cloud.dataplex.v1.DataQualitySpecOrBuilder getDataQualitySpecOrBuilder();

  /**
   *
   *
   *    * DataProfileScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
   *
   * @return Whether the dataProfileSpec field is set.
   */
  boolean hasDataProfileSpec();
  /**
   *
   *
   *    * DataProfileScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
   *
   * @return The dataProfileSpec.
   */
  com.google.cloud.dataplex.v1.DataProfileSpec getDataProfileSpec();
  /**
   *
   *
   *    * DataProfileScan related setting.
   * 
   *
   * .google.cloud.dataplex.v1.DataProfileSpec data_profile_spec = 101;
   */
  com.google.cloud.dataplex.v1.DataProfileSpecOrBuilder getDataProfileSpecOrBuilder();

  /**
   *
   *
   *    * Output only. The result of the data quality scan.
   * 
   *
   * 
   * .google.cloud.dataplex.v1.DataQualityResult data_quality_result = 200 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the dataQualityResult field is set.
   */
  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];
   * 
   *
   * @return The dataQualityResult.
   */
  com.google.cloud.dataplex.v1.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];
   * 
   */
  com.google.cloud.dataplex.v1.DataQualityResultOrBuilder getDataQualityResultOrBuilder();

  /**
   *
   *
   *    * Output only. The result of the data profile scan.
   * 
   *
   * 
   * .google.cloud.dataplex.v1.DataProfileResult data_profile_result = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the dataProfileResult field is set.
   */
  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];
   * 
   *
   * @return The dataProfileResult.
   */
  com.google.cloud.dataplex.v1.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];
   * 
   */
  com.google.cloud.dataplex.v1.DataProfileResultOrBuilder getDataProfileResultOrBuilder();

  com.google.cloud.dataplex.v1.DataScan.SpecCase getSpecCase();

  com.google.cloud.dataplex.v1.DataScan.ResultCase getResultCase();
}