<?php
/*
 * Copyright 2014 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.
 */

namespace Google\Service\ServiceUsage;

class QuotaOverride extends \Google\Model
{
  /**
   * The resource name of the ancestor that requested the override. For example:
   * `organizations/12345` or `folders/67890`. Used by admin overrides only.
   *
   * @var string
   */
  public $adminOverrideAncestor;
  /**
   * If this map is nonempty, then this override applies only to specific values
   * for dimensions defined in the limit unit. For example, an override on a
   * limit with the unit `1/{project}/{region}` could contain an entry with the
   * key `region` and the value `us-east-1`; the override is only applied to
   * quota consumed in that region. This map has the following restrictions: *
   * Keys that are not defined in the limit's unit are not valid keys. Any
   * string appearing in `{brackets}` in the unit (besides `{project}` or
   * `{user}`) is a defined key. * `project` is not a valid key; the project is
   * already specified in the parent resource name. * `user` is not a valid key;
   * the API does not support quota overrides that apply only to a specific
   * user. * If `region` appears as a key, its value must be a valid Cloud
   * region. * If `zone` appears as a key, its value must be a valid Cloud zone.
   * * If any valid key other than `region` or `zone` appears in the map, then
   * all valid keys other than `region` or `zone` must also appear in the map.
   *
   * @var string[]
   */
  public $dimensions;
  /**
   * The name of the metric to which this override applies. An example name
   * would be: `compute.googleapis.com/cpus`
   *
   * @var string
   */
  public $metric;
  /**
   * The resource name of the override. This name is generated by the server
   * when the override is created. Example names would be: `projects/123/service
   * s/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus
   * /limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services
   * /compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
   * limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is
   * intended to be opaque and should not be parsed for its component strings,
   * since its representation could change in the future.
   *
   * @var string
   */
  public $name;
  /**
   * The overriding quota limit value. Can be any nonnegative integer, or -1
   * (unlimited quota).
   *
   * @var string
   */
  public $overrideValue;
  /**
   * The limit unit of the limit to which this override applies. An example unit
   * would be: `1/{project}/{region}` Note that `{project}` and `{region}` are
   * not placeholders in this example; the literal characters `{` and `}` occur
   * in the string.
   *
   * @var string
   */
  public $unit;

  /**
   * The resource name of the ancestor that requested the override. For example:
   * `organizations/12345` or `folders/67890`. Used by admin overrides only.
   *
   * @param string $adminOverrideAncestor
   */
  public function setAdminOverrideAncestor($adminOverrideAncestor)
  {
    $this->adminOverrideAncestor = $adminOverrideAncestor;
  }
  /**
   * @return string
   */
  public function getAdminOverrideAncestor()
  {
    return $this->adminOverrideAncestor;
  }
  /**
   * If this map is nonempty, then this override applies only to specific values
   * for dimensions defined in the limit unit. For example, an override on a
   * limit with the unit `1/{project}/{region}` could contain an entry with the
   * key `region` and the value `us-east-1`; the override is only applied to
   * quota consumed in that region. This map has the following restrictions: *
   * Keys that are not defined in the limit's unit are not valid keys. Any
   * string appearing in `{brackets}` in the unit (besides `{project}` or
   * `{user}`) is a defined key. * `project` is not a valid key; the project is
   * already specified in the parent resource name. * `user` is not a valid key;
   * the API does not support quota overrides that apply only to a specific
   * user. * If `region` appears as a key, its value must be a valid Cloud
   * region. * If `zone` appears as a key, its value must be a valid Cloud zone.
   * * If any valid key other than `region` or `zone` appears in the map, then
   * all valid keys other than `region` or `zone` must also appear in the map.
   *
   * @param string[] $dimensions
   */
  public function setDimensions($dimensions)
  {
    $this->dimensions = $dimensions;
  }
  /**
   * @return string[]
   */
  public function getDimensions()
  {
    return $this->dimensions;
  }
  /**
   * The name of the metric to which this override applies. An example name
   * would be: `compute.googleapis.com/cpus`
   *
   * @param string $metric
   */
  public function setMetric($metric)
  {
    $this->metric = $metric;
  }
  /**
   * @return string
   */
  public function getMetric()
  {
    return $this->metric;
  }
  /**
   * The resource name of the override. This name is generated by the server
   * when the override is created. Example names would be: `projects/123/service
   * s/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus
   * /limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services
   * /compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
   * limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is
   * intended to be opaque and should not be parsed for its component strings,
   * since its representation could change in the future.
   *
   * @param string $name
   */
  public function setName($name)
  {
    $this->name = $name;
  }
  /**
   * @return string
   */
  public function getName()
  {
    return $this->name;
  }
  /**
   * The overriding quota limit value. Can be any nonnegative integer, or -1
   * (unlimited quota).
   *
   * @param string $overrideValue
   */
  public function setOverrideValue($overrideValue)
  {
    $this->overrideValue = $overrideValue;
  }
  /**
   * @return string
   */
  public function getOverrideValue()
  {
    return $this->overrideValue;
  }
  /**
   * The limit unit of the limit to which this override applies. An example unit
   * would be: `1/{project}/{region}` Note that `{project}` and `{region}` are
   * not placeholders in this example; the literal characters `{` and `}` occur
   * in the string.
   *
   * @param string $unit
   */
  public function setUnit($unit)
  {
    $this->unit = $unit;
  }
  /**
   * @return string
   */
  public function getUnit()
  {
    return $this->unit;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(QuotaOverride::class, 'Google_Service_ServiceUsage_QuotaOverride');