com.google.api.services.bigtableadmin.v2.model.DropRowRangeRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigtableadmin Show documentation
The 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.bigtableadmin.v2.model;

/**
 * Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
 *
 *  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 Bigtable Admin 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 DropRowRangeRequest extends com.google.api.client.json.GenericJson {

  /**
   * Delete all rows in the table. Setting this to false is a no-op.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean deleteAllDataFromTable;

  /**
   * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String rowKeyPrefix;

  /**
   * Delete all rows in the table. Setting this to false is a no-op.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDeleteAllDataFromTable() {
    return deleteAllDataFromTable;
  }

  /**
   * Delete all rows in the table. Setting this to false is a no-op.
   * @param deleteAllDataFromTable deleteAllDataFromTable or {@code null} for none
   */
  public DropRowRangeRequest setDeleteAllDataFromTable(java.lang.Boolean deleteAllDataFromTable) {
    this.deleteAllDataFromTable = deleteAllDataFromTable;
    return this;
  }

  /**
   * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
   * @see #decodeRowKeyPrefix()
   * @return value or {@code null} for none
   */
  public java.lang.String getRowKeyPrefix() {
    return rowKeyPrefix;
  }

  /**
   * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
   * @see #getRowKeyPrefix()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeRowKeyPrefix() {
    return com.google.api.client.util.Base64.decodeBase64(rowKeyPrefix);
  }

  /**
   * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
   * @see #encodeRowKeyPrefix()
   * @param rowKeyPrefix rowKeyPrefix or {@code null} for none
   */
  public DropRowRangeRequest setRowKeyPrefix(java.lang.String rowKeyPrefix) {
    this.rowKeyPrefix = rowKeyPrefix;
    return this;
  }

  /**
   * Delete all rows that start with this row key prefix. Prefix cannot be zero length.
   * @see #setRowKeyPrefix()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public DropRowRangeRequest encodeRowKeyPrefix(byte[] rowKeyPrefix) {
    this.rowKeyPrefix = com.google.api.client.util.Base64.encodeBase64URLSafeString(rowKeyPrefix);
    return this;
  }

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

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

}