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

/**
 * Response message for PredictionService.Predict.
 *
 * <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 GoogleCloudAiplatformV1beta1PredictResponse extends com.google.api.client.json.GenericJson {

  /**
   * ID of the Endpoint's DeployedModel that served this prediction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String deployedModelId;

  /**
   * Output only. Request-level metadata returned by the model. The metadata type will be dependent
   * upon the model implementation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Object metadata;

  /**
   * Output only. The resource name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String model;

  /**
   * Output only. The display name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String modelDisplayName;

  /**
   * Output only. The version ID of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String modelVersionId;

  /**
   * The predictions that are the output of the predictions call. The schema of any single
   * prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's
   * prediction_schema_uri.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.Object> predictions;

  /**
   * ID of the Endpoint's DeployedModel that served this prediction.
   * @return value or {@code null} for none
   */
  public java.lang.String getDeployedModelId() {
    return deployedModelId;
  }

  /**
   * ID of the Endpoint's DeployedModel that served this prediction.
   * @param deployedModelId deployedModelId or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setDeployedModelId(java.lang.String deployedModelId) {
    this.deployedModelId = deployedModelId;
    return this;
  }

  /**
   * Output only. Request-level metadata returned by the model. The metadata type will be dependent
   * upon the model implementation.
   * @return value or {@code null} for none
   */
  public java.lang.Object getMetadata() {
    return metadata;
  }

  /**
   * Output only. Request-level metadata returned by the model. The metadata type will be dependent
   * upon the model implementation.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setMetadata(java.lang.Object metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * Output only. The resource name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @return value or {@code null} for none
   */
  public java.lang.String getModel() {
    return model;
  }

  /**
   * Output only. The resource name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @param model model or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setModel(java.lang.String model) {
    this.model = model;
    return this;
  }

  /**
   * Output only. The display name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @return value or {@code null} for none
   */
  public java.lang.String getModelDisplayName() {
    return modelDisplayName;
  }

  /**
   * Output only. The display name of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @param modelDisplayName modelDisplayName or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setModelDisplayName(java.lang.String modelDisplayName) {
    this.modelDisplayName = modelDisplayName;
    return this;
  }

  /**
   * Output only. The version ID of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @return value or {@code null} for none
   */
  public java.lang.String getModelVersionId() {
    return modelVersionId;
  }

  /**
   * Output only. The version ID of the Model which is deployed as the DeployedModel that this
   * prediction hits.
   * @param modelVersionId modelVersionId or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setModelVersionId(java.lang.String modelVersionId) {
    this.modelVersionId = modelVersionId;
    return this;
  }

  /**
   * The predictions that are the output of the predictions call. The schema of any single
   * prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's
   * prediction_schema_uri.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.Object> getPredictions() {
    return predictions;
  }

  /**
   * The predictions that are the output of the predictions call. The schema of any single
   * prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's
   * prediction_schema_uri.
   * @param predictions predictions or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1PredictResponse setPredictions(java.util.List<java.lang.Object> predictions) {
    this.predictions = predictions;
    return this;
  }

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

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

}
