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

/**
 * Noise sigma for a single feature.
 *
 * <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 GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature extends com.google.api.client.json.GenericJson {

  /**
   * The name of the input feature for which noise sigma is provided. The features are defined in
   * explanation metadata inputs.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * This represents the standard deviation of the Gaussian kernel that will be used to add noise to
   * the feature prior to computing gradients. Similar to noise_sigma but represents the noise added
   * to the current feature. Defaults to 0.1.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float sigma;

  /**
   * The name of the input feature for which noise sigma is provided. The features are defined in
   * explanation metadata inputs.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the input feature for which noise sigma is provided. The features are defined in
   * explanation metadata inputs.
   * @param name name or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * This represents the standard deviation of the Gaussian kernel that will be used to add noise to
   * the feature prior to computing gradients. Similar to noise_sigma but represents the noise added
   * to the current feature. Defaults to 0.1.
   * @return value or {@code null} for none
   */
  public java.lang.Float getSigma() {
    return sigma;
  }

  /**
   * This represents the standard deviation of the Gaussian kernel that will be used to add noise to
   * the feature prior to computing gradients. Similar to noise_sigma but represents the noise added
   * to the current feature. Defaults to 0.1.
   * @param sigma sigma or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1FeatureNoiseSigmaNoiseSigmaForFeature setSigma(java.lang.Float sigma) {
    this.sigma = sigma;
    return this;
  }

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

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

}
