/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.dataplex.v1.model;

/**
 * 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).
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Dataplex API. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudDataplexV1DataScan extends com.google.api.client.json.GenericJson {

  /**
   * Output only. The time when the scan was created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * Required. The data source for DataScan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataSource data;

  /**
   * Output only. The result of the data profile scan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataProfileResult dataProfileResult;

  /**
   * DataProfileScan related setting.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataProfileSpec dataProfileSpec;

  /**
   * Output only. The result of the data quality scan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataQualityResult dataQualityResult;

  /**
   * DataQualityScan related setting.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataQualitySpec dataQualitySpec;

  /**
   * Optional. Description of the scan. Must be between 1-1024 characters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Optional. User friendly display name. Must be between 1-256 characters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Optional. DataScan execution settings.If not specified, the fields in it will use their default
   * values.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataScanExecutionSpec executionSpec;

  /**
   * Output only. Status of the data scan execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDataplexV1DataScanExecutionStatus executionStatus;

  /**
   * Optional. User-defined labels for the scan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.String> labels;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. Current state of the DataScan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * Output only. The type of DataScan.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String uid;

  /**
   * Output only. The time when the scan was last updated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateTime;

  /**
   * Output only. The time when the scan was created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. The time when the scan was created.
   * @param createTime createTime or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * Required. The data source for DataScan.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataSource getData() {
    return data;
  }

  /**
   * Required. The data source for DataScan.
   * @param data data or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setData(GoogleCloudDataplexV1DataSource data) {
    this.data = data;
    return this;
  }

  /**
   * Output only. The result of the data profile scan.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataProfileResult getDataProfileResult() {
    return dataProfileResult;
  }

  /**
   * Output only. The result of the data profile scan.
   * @param dataProfileResult dataProfileResult or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDataProfileResult(GoogleCloudDataplexV1DataProfileResult dataProfileResult) {
    this.dataProfileResult = dataProfileResult;
    return this;
  }

  /**
   * DataProfileScan related setting.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataProfileSpec getDataProfileSpec() {
    return dataProfileSpec;
  }

  /**
   * DataProfileScan related setting.
   * @param dataProfileSpec dataProfileSpec or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDataProfileSpec(GoogleCloudDataplexV1DataProfileSpec dataProfileSpec) {
    this.dataProfileSpec = dataProfileSpec;
    return this;
  }

  /**
   * Output only. The result of the data quality scan.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataQualityResult getDataQualityResult() {
    return dataQualityResult;
  }

  /**
   * Output only. The result of the data quality scan.
   * @param dataQualityResult dataQualityResult or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDataQualityResult(GoogleCloudDataplexV1DataQualityResult dataQualityResult) {
    this.dataQualityResult = dataQualityResult;
    return this;
  }

  /**
   * DataQualityScan related setting.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataQualitySpec getDataQualitySpec() {
    return dataQualitySpec;
  }

  /**
   * DataQualityScan related setting.
   * @param dataQualitySpec dataQualitySpec or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDataQualitySpec(GoogleCloudDataplexV1DataQualitySpec dataQualitySpec) {
    this.dataQualitySpec = dataQualitySpec;
    return this;
  }

  /**
   * Optional. Description of the scan. Must be between 1-1024 characters.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * Optional. Description of the scan. Must be between 1-1024 characters.
   * @param description description or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Optional. User friendly display name. Must be between 1-256 characters.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Optional. User friendly display name. Must be between 1-256 characters.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Optional. DataScan execution settings.If not specified, the fields in it will use their default
   * values.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScanExecutionSpec getExecutionSpec() {
    return executionSpec;
  }

  /**
   * Optional. DataScan execution settings.If not specified, the fields in it will use their default
   * values.
   * @param executionSpec executionSpec or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setExecutionSpec(GoogleCloudDataplexV1DataScanExecutionSpec executionSpec) {
    this.executionSpec = executionSpec;
    return this;
  }

  /**
   * Output only. Status of the data scan execution.
   * @return value or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScanExecutionStatus getExecutionStatus() {
    return executionStatus;
  }

  /**
   * Output only. Status of the data scan execution.
   * @param executionStatus executionStatus or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setExecutionStatus(GoogleCloudDataplexV1DataScanExecutionStatus executionStatus) {
    this.executionStatus = executionStatus;
    return this;
  }

  /**
   * Optional. User-defined labels for the scan.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.String> getLabels() {
    return labels;
  }

  /**
   * Optional. User-defined labels for the scan.
   * @param labels labels or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setLabels(java.util.Map<String, java.lang.String> labels) {
    this.labels = labels;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * 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.
   * @param name name or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. Current state of the DataScan.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Output only. Current state of the DataScan.
   * @param state state or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * Output only. The type of DataScan.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * Output only. The type of DataScan.
   * @param type type or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setType(java.lang.String type) {
    this.type = type;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getUid() {
    return uid;
  }

  /**
   * 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.
   * @param uid uid or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setUid(java.lang.String uid) {
    this.uid = uid;
    return this;
  }

  /**
   * Output only. The time when the scan was last updated.
   * @return value or {@code null} for none
   */
  public String getUpdateTime() {
    return updateTime;
  }

  /**
   * Output only. The time when the scan was last updated.
   * @param updateTime updateTime or {@code null} for none
   */
  public GoogleCloudDataplexV1DataScan setUpdateTime(String updateTime) {
    this.updateTime = updateTime;
    return this;
  }

  @Override
  public GoogleCloudDataplexV1DataScan set(String fieldName, Object value) {
    return (GoogleCloudDataplexV1DataScan) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudDataplexV1DataScan clone() {
    return (GoogleCloudDataplexV1DataScan) super.clone();
  }

}
