com.google.api.services.spanner.v1.model.Scan Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-spanner Show documentation
There is a newer version: v1-rev20241020-2.0.0
Show newest version
/*
 * 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.spanner.v1.model;

/**
 * Scan is a structure which describes Cloud Key Visualizer scan information.
 *
 *  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 Spanner API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Scan extends com.google.api.client.json.GenericJson {

  /**
   * Additional information provided by the implementer.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map details;

  /**
   * The upper bound for when the scan is defined.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String endTime;

  /**
   * The unique name of the scan, specific to the Database service implementing this interface.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans
   * method.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ScanData scanData;

  /**
   * A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is
   * defined.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String startTime;

  /**
   * Additional information provided by the implementer.
   * @return value or {@code null} for none
   */
  public java.util.Map getDetails() {
    return details;
  }

  /**
   * Additional information provided by the implementer.
   * @param details details or {@code null} for none
   */
  public Scan setDetails(java.util.Map details) {
    this.details = details;
    return this;
  }

  /**
   * The upper bound for when the scan is defined.
   * @return value or {@code null} for none
   */
  public String getEndTime() {
    return endTime;
  }

  /**
   * The upper bound for when the scan is defined.
   * @param endTime endTime or {@code null} for none
   */
  public Scan setEndTime(String endTime) {
    this.endTime = endTime;
    return this;
  }

  /**
   * The unique name of the scan, specific to the Database service implementing this interface.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The unique name of the scan, specific to the Database service implementing this interface.
   * @param name name or {@code null} for none
   */
  public Scan setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans
   * method.
   * @return value or {@code null} for none
   */
  public ScanData getScanData() {
    return scanData;
  }

  /**
   * Output only. Cloud Key Visualizer scan data. Note, this field is not available to the ListScans
   * method.
   * @param scanData scanData or {@code null} for none
   */
  public Scan setScanData(ScanData scanData) {
    this.scanData = scanData;
    return this;
  }

  /**
   * A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is
   * defined.
   * @return value or {@code null} for none
   */
  public String getStartTime() {
    return startTime;
  }

  /**
   * A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is
   * defined.
   * @param startTime startTime or {@code null} for none
   */
  public Scan setStartTime(String startTime) {
    this.startTime = startTime;
    return this;
  }

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

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

}