/*
 * 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;

/**
 * Request message for FeaturestoreService.ImportFeatureValues.
 *
 * <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 GoogleCloudAiplatformV1ImportFeatureValuesRequest extends com.google.api.client.json.GenericJson {

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1AvroSource avroSource;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1BigQuerySource bigquerySource;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1CsvSource csvSource;

  /**
   * If true, API doesn't start ingestion analysis pipeline.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean disableIngestionAnalysis;

  /**
   * If set, data will not be imported for online serving. This is typically used for backfilling,
   * where Feature generation timestamps are not in the timestamp range needed for online serving.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean disableOnlineServing;

  /**
   * Source column that holds entity IDs. If not provided, entity IDs are extracted from the column
   * named entity_id.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String entityIdField;

  /**
   * Required. Specifications defining which Feature values to import from the entity. The request
   * fails if no feature_specs are provided, and having multiple feature_specs for one Feature is
   * not allowed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec> featureSpecs;

  /**
   * Single Feature timestamp for all entities being imported. The timestamp must not have higher
   * than millisecond precision.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String featureTime;

  /**
   * Source column that holds the Feature timestamp for all Feature values in each entity.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String featureTimeField;

  /**
   * Specifies the number of workers that are used to write data to the Featurestore. Consider the
   * online serving capacity that you require to achieve the desired import throughput without
   * interfering with online serving. The value must be positive, and less than or equal to 100. If
   * not set, defaults to using 1 worker. The low count ensures minimal impact on online serving
   * performance.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer workerCount;

  /**
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1AvroSource getAvroSource() {
    return avroSource;
  }

  /**
   * @param avroSource avroSource or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setAvroSource(GoogleCloudAiplatformV1AvroSource avroSource) {
    this.avroSource = avroSource;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1BigQuerySource getBigquerySource() {
    return bigquerySource;
  }

  /**
   * @param bigquerySource bigquerySource or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setBigquerySource(GoogleCloudAiplatformV1BigQuerySource bigquerySource) {
    this.bigquerySource = bigquerySource;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1CsvSource getCsvSource() {
    return csvSource;
  }

  /**
   * @param csvSource csvSource or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setCsvSource(GoogleCloudAiplatformV1CsvSource csvSource) {
    this.csvSource = csvSource;
    return this;
  }

  /**
   * If true, API doesn't start ingestion analysis pipeline.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDisableIngestionAnalysis() {
    return disableIngestionAnalysis;
  }

  /**
   * If true, API doesn't start ingestion analysis pipeline.
   * @param disableIngestionAnalysis disableIngestionAnalysis or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setDisableIngestionAnalysis(java.lang.Boolean disableIngestionAnalysis) {
    this.disableIngestionAnalysis = disableIngestionAnalysis;
    return this;
  }

  /**
   * If set, data will not be imported for online serving. This is typically used for backfilling,
   * where Feature generation timestamps are not in the timestamp range needed for online serving.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDisableOnlineServing() {
    return disableOnlineServing;
  }

  /**
   * If set, data will not be imported for online serving. This is typically used for backfilling,
   * where Feature generation timestamps are not in the timestamp range needed for online serving.
   * @param disableOnlineServing disableOnlineServing or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setDisableOnlineServing(java.lang.Boolean disableOnlineServing) {
    this.disableOnlineServing = disableOnlineServing;
    return this;
  }

  /**
   * Source column that holds entity IDs. If not provided, entity IDs are extracted from the column
   * named entity_id.
   * @return value or {@code null} for none
   */
  public java.lang.String getEntityIdField() {
    return entityIdField;
  }

  /**
   * Source column that holds entity IDs. If not provided, entity IDs are extracted from the column
   * named entity_id.
   * @param entityIdField entityIdField or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setEntityIdField(java.lang.String entityIdField) {
    this.entityIdField = entityIdField;
    return this;
  }

  /**
   * Required. Specifications defining which Feature values to import from the entity. The request
   * fails if no feature_specs are provided, and having multiple feature_specs for one Feature is
   * not allowed.
   * @return value or {@code null} for none
   */
  public java.util.List<GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec> getFeatureSpecs() {
    return featureSpecs;
  }

  /**
   * Required. Specifications defining which Feature values to import from the entity. The request
   * fails if no feature_specs are provided, and having multiple feature_specs for one Feature is
   * not allowed.
   * @param featureSpecs featureSpecs or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setFeatureSpecs(java.util.List<GoogleCloudAiplatformV1ImportFeatureValuesRequestFeatureSpec> featureSpecs) {
    this.featureSpecs = featureSpecs;
    return this;
  }

  /**
   * Single Feature timestamp for all entities being imported. The timestamp must not have higher
   * than millisecond precision.
   * @return value or {@code null} for none
   */
  public String getFeatureTime() {
    return featureTime;
  }

  /**
   * Single Feature timestamp for all entities being imported. The timestamp must not have higher
   * than millisecond precision.
   * @param featureTime featureTime or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setFeatureTime(String featureTime) {
    this.featureTime = featureTime;
    return this;
  }

  /**
   * Source column that holds the Feature timestamp for all Feature values in each entity.
   * @return value or {@code null} for none
   */
  public java.lang.String getFeatureTimeField() {
    return featureTimeField;
  }

  /**
   * Source column that holds the Feature timestamp for all Feature values in each entity.
   * @param featureTimeField featureTimeField or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setFeatureTimeField(java.lang.String featureTimeField) {
    this.featureTimeField = featureTimeField;
    return this;
  }

  /**
   * Specifies the number of workers that are used to write data to the Featurestore. Consider the
   * online serving capacity that you require to achieve the desired import throughput without
   * interfering with online serving. The value must be positive, and less than or equal to 100. If
   * not set, defaults to using 1 worker. The low count ensures minimal impact on online serving
   * performance.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getWorkerCount() {
    return workerCount;
  }

  /**
   * Specifies the number of workers that are used to write data to the Featurestore. Consider the
   * online serving capacity that you require to achieve the desired import throughput without
   * interfering with online serving. The value must be positive, and less than or equal to 100. If
   * not set, defaults to using 1 worker. The low count ensures minimal impact on online serving
   * performance.
   * @param workerCount workerCount or {@code null} for none
   */
  public GoogleCloudAiplatformV1ImportFeatureValuesRequest setWorkerCount(java.lang.Integer workerCount) {
    this.workerCount = workerCount;
    return this;
  }

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

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

}
