com.google.api.services.servicecontrol.v1.model.ExponentialBuckets Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2016-10-17 16:43:55 UTC)
 * on 2016-11-10 at 17:05:21 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.servicecontrol.v1.model;

/**
 * Describing buckets with exponentially growing width.
 *
 *  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 Google Service Control 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 ExponentialBuckets extends com.google.api.client.json.GenericJson {

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than
   * 1.0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double growthFactor;

  /**
   * The number of finite buckets. With the underflow and overflow buckets, the total number of
   * buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer numFiniteBuckets;

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double scale;

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than
   * 1.0.
   * @return value or {@code null} for none
   */
  public java.lang.Double getGrowthFactor() {
    return growthFactor;
  }

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than
   * 1.0.
   * @param growthFactor growthFactor or {@code null} for none
   */
  public ExponentialBuckets setGrowthFactor(java.lang.Double growthFactor) {
    this.growthFactor = growthFactor;
    return this;
  }

  /**
   * The number of finite buckets. With the underflow and overflow buckets, the total number of
   * buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getNumFiniteBuckets() {
    return numFiniteBuckets;
  }

  /**
   * The number of finite buckets. With the underflow and overflow buckets, the total number of
   * buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.
   * @param numFiniteBuckets numFiniteBuckets or {@code null} for none
   */
  public ExponentialBuckets setNumFiniteBuckets(java.lang.Integer numFiniteBuckets) {
    this.numFiniteBuckets = numFiniteBuckets;
    return this;
  }

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.
   * @return value or {@code null} for none
   */
  public java.lang.Double getScale() {
    return scale;
  }

  /**
   * The i'th exponential bucket covers the interval   [scale * growth_factor^(i-1), scale *
   * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.
   * @param scale scale or {@code null} for none
   */
  public ExponentialBuckets setScale(java.lang.Double scale) {
    this.scale = scale;
    return this;
  }

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

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

}