com.google.api.services.spanner.v1.model.UpdateInstanceConfigRequest Maven / Gradle / Ivy

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

/**
 * The request for UpdateInstanceConfigRequest.
 *
 *  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 Spanner 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 UpdateInstanceConfigRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. The user instance configuration to update, which must always include the instance
   * configuration name. Otherwise, only fields mentioned in update_mask need be included. To
   * prevent conflicts of concurrent updates, etag can be used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private InstanceConfig instanceConfig;

  /**
   * Required. A mask specifying which fields in InstanceConfig should be updated. The field mask
   * must always be specified; this prevents any future fields in InstanceConfig from being erased
   * accidentally by clients that do not know about them. Only display_name and labels can be
   * updated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateMask;

  /**
   * An option to validate, but not actually execute, a request, and provide the same response.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean validateOnly;

  /**
   * Required. The user instance configuration to update, which must always include the instance
   * configuration name. Otherwise, only fields mentioned in update_mask need be included. To
   * prevent conflicts of concurrent updates, etag can be used.
   * @return value or {@code null} for none
   */
  public InstanceConfig getInstanceConfig() {
    return instanceConfig;
  }

  /**
   * Required. The user instance configuration to update, which must always include the instance
   * configuration name. Otherwise, only fields mentioned in update_mask need be included. To
   * prevent conflicts of concurrent updates, etag can be used.
   * @param instanceConfig instanceConfig or {@code null} for none
   */
  public UpdateInstanceConfigRequest setInstanceConfig(InstanceConfig instanceConfig) {
    this.instanceConfig = instanceConfig;
    return this;
  }

  /**
   * Required. A mask specifying which fields in InstanceConfig should be updated. The field mask
   * must always be specified; this prevents any future fields in InstanceConfig from being erased
   * accidentally by clients that do not know about them. Only display_name and labels can be
   * updated.
   * @return value or {@code null} for none
   */
  public String getUpdateMask() {
    return updateMask;
  }

  /**
   * Required. A mask specifying which fields in InstanceConfig should be updated. The field mask
   * must always be specified; this prevents any future fields in InstanceConfig from being erased
   * accidentally by clients that do not know about them. Only display_name and labels can be
   * updated.
   * @param updateMask updateMask or {@code null} for none
   */
  public UpdateInstanceConfigRequest setUpdateMask(String updateMask) {
    this.updateMask = updateMask;
    return this;
  }

  /**
   * An option to validate, but not actually execute, a request, and provide the same response.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getValidateOnly() {
    return validateOnly;
  }

  /**
   * An option to validate, but not actually execute, a request, and provide the same response.
   * @param validateOnly validateOnly or {@code null} for none
   */
  public UpdateInstanceConfigRequest setValidateOnly(java.lang.Boolean validateOnly) {
    this.validateOnly = validateOnly;
    return this;
  }

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

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

}