/*
 * 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.aiplatform.v1.model;

/**
 * A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and
 * filters.
 *
 * <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 Vertex AI 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 GoogleCloudAiplatformV1SavedQuery extends com.google.api.client.json.GenericJson {

  /**
   * Output only. Filters on the Annotations in the dataset.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String annotationFilter;

  /**
   * Output only. Number of AnnotationSpecs in the context of the SavedQuery.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer annotationSpecCount;

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

  /**
   * Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long
   * and can consist of any UTF-8 characters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update
   * happens.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String etag;

  /**
   * Some additional information about the SavedQuery.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Object metadata;

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

  /**
   * Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL *
   * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX *
   * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION *
   * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String problemType;

  /**
   * Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean supportAutomlTraining;

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

  /**
   * Output only. Filters on the Annotations in the dataset.
   * @return value or {@code null} for none
   */
  public java.lang.String getAnnotationFilter() {
    return annotationFilter;
  }

  /**
   * Output only. Filters on the Annotations in the dataset.
   * @param annotationFilter annotationFilter or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setAnnotationFilter(java.lang.String annotationFilter) {
    this.annotationFilter = annotationFilter;
    return this;
  }

  /**
   * Output only. Number of AnnotationSpecs in the context of the SavedQuery.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getAnnotationSpecCount() {
    return annotationSpecCount;
  }

  /**
   * Output only. Number of AnnotationSpecs in the context of the SavedQuery.
   * @param annotationSpecCount annotationSpecCount or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setAnnotationSpecCount(java.lang.Integer annotationSpecCount) {
    this.annotationSpecCount = annotationSpecCount;
    return this;
  }

  /**
   * Output only. Timestamp when this SavedQuery was created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. Timestamp when this SavedQuery was created.
   * @param createTime createTime or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long
   * and can consist of any UTF-8 characters.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long
   * and can consist of any UTF-8 characters.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update
   * happens.
   * @return value or {@code null} for none
   */
  public java.lang.String getEtag() {
    return etag;
  }

  /**
   * Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update
   * happens.
   * @param etag etag or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setEtag(java.lang.String etag) {
    this.etag = etag;
    return this;
  }

  /**
   * Some additional information about the SavedQuery.
   * @return value or {@code null} for none
   */
  public java.lang.Object getMetadata() {
    return metadata;
  }

  /**
   * Some additional information about the SavedQuery.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setMetadata(java.lang.Object metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * Output only. Resource name of the SavedQuery.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. Resource name of the SavedQuery.
   * @param name name or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL *
   * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX *
   * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION *
   * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
   * @return value or {@code null} for none
   */
  public java.lang.String getProblemType() {
    return problemType;
  }

  /**
   * Required. Problem type of the SavedQuery. Allowed values: * IMAGE_CLASSIFICATION_SINGLE_LABEL *
   * IMAGE_CLASSIFICATION_MULTI_LABEL * IMAGE_BOUNDING_POLY * IMAGE_BOUNDING_BOX *
   * TEXT_CLASSIFICATION_SINGLE_LABEL * TEXT_CLASSIFICATION_MULTI_LABEL * TEXT_EXTRACTION *
   * TEXT_SENTIMENT * VIDEO_CLASSIFICATION * VIDEO_OBJECT_TRACKING
   * @param problemType problemType or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setProblemType(java.lang.String problemType) {
    this.problemType = problemType;
    return this;
  }

  /**
   * Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSupportAutomlTraining() {
    return supportAutomlTraining;
  }

  /**
   * Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training.
   * @param supportAutomlTraining supportAutomlTraining or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setSupportAutomlTraining(java.lang.Boolean supportAutomlTraining) {
    this.supportAutomlTraining = supportAutomlTraining;
    return this;
  }

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

  /**
   * Output only. Timestamp when SavedQuery was last updated.
   * @param updateTime updateTime or {@code null} for none
   */
  public GoogleCloudAiplatformV1SavedQuery setUpdateTime(String updateTime) {
    this.updateTime = updateTime;
    return this;
  }

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

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

}
