com.google.api.services.datamigration.v1.model.IndexEntity Maven / Gradle / Ivy

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

/**
 * Index is not used as an independent entity, it is retrieved as part of a Table entity.
 *
 *  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 Database Migration 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 IndexEntity extends com.google.api.client.json.GenericJson {

  /**
   * Custom engine specific features.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map customFeatures;

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

  /**
   * Table columns used as part of the Index, for example B-TREE index should list the columns which
   * constitutes the index.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List tableColumns;

  /**
   * For each table_column, mark whether it's sorting order is ascending (false) or descending
   * (true). If no value is defined, assume all columns are sorted in ascending order. Otherwise,
   * the number of items must match that of table_columns with each value specifying the direction
   * of the matched column by its index.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List tableColumnsDescending;

  /**
   * Type of index, for example B-TREE.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * Boolean value indicating whether the index is unique.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean unique;

  /**
   * Custom engine specific features.
   * @return value or {@code null} for none
   */
  public java.util.Map getCustomFeatures() {
    return customFeatures;
  }

  /**
   * Custom engine specific features.
   * @param customFeatures customFeatures or {@code null} for none
   */
  public IndexEntity setCustomFeatures(java.util.Map customFeatures) {
    this.customFeatures = customFeatures;
    return this;
  }

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

  /**
   * The name of the index.
   * @param name name or {@code null} for none
   */
  public IndexEntity setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Table columns used as part of the Index, for example B-TREE index should list the columns which
   * constitutes the index.
   * @return value or {@code null} for none
   */
  public java.util.List getTableColumns() {
    return tableColumns;
  }

  /**
   * Table columns used as part of the Index, for example B-TREE index should list the columns which
   * constitutes the index.
   * @param tableColumns tableColumns or {@code null} for none
   */
  public IndexEntity setTableColumns(java.util.List tableColumns) {
    this.tableColumns = tableColumns;
    return this;
  }

  /**
   * For each table_column, mark whether it's sorting order is ascending (false) or descending
   * (true). If no value is defined, assume all columns are sorted in ascending order. Otherwise,
   * the number of items must match that of table_columns with each value specifying the direction
   * of the matched column by its index.
   * @return value or {@code null} for none
   */
  public java.util.List getTableColumnsDescending() {
    return tableColumnsDescending;
  }

  /**
   * For each table_column, mark whether it's sorting order is ascending (false) or descending
   * (true). If no value is defined, assume all columns are sorted in ascending order. Otherwise,
   * the number of items must match that of table_columns with each value specifying the direction
   * of the matched column by its index.
   * @param tableColumnsDescending tableColumnsDescending or {@code null} for none
   */
  public IndexEntity setTableColumnsDescending(java.util.List tableColumnsDescending) {
    this.tableColumnsDescending = tableColumnsDescending;
    return this;
  }

  /**
   * Type of index, for example B-TREE.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * Type of index, for example B-TREE.
   * @param type type or {@code null} for none
   */
  public IndexEntity setType(java.lang.String type) {
    this.type = type;
    return this;
  }

  /**
   * Boolean value indicating whether the index is unique.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUnique() {
    return unique;
  }

  /**
   * Boolean value indicating whether the index is unique.
   * @param unique unique or {@code null} for none
   */
  public IndexEntity setUnique(java.lang.Boolean unique) {
    this.unique = unique;
    return this;
  }

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

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

}