Class: Google::Apis::ServiceusageV1::QuotaOverride

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb

Overview

A quota override

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ QuotaOverride

Returns a new instance of QuotaOverride.



3840
3841
3842
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3840

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dimensionsHash<String,String>

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. Corresponds to the JSON property dimensions

Returns:

  • (Hash<String,String>)


3803
3804
3805
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3803

def dimensions
  @dimensions
end

#metricString

The name of the metric to which this override applies. An example name would be: compute.googleapis.com/cpus Corresponds to the JSON property metric

Returns:

  • (String)


3810
3811
3812
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3810

def metric
  @metric
end

#nameString

The resource name of the override. This name is generated by the server when the override is created. Example names would be: projects/123/services/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. Corresponds to the JSON property name

Returns:

  • (String)


3823
3824
3825
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3823

def name
  @name
end

#override_valueFixnum

The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota). Corresponds to the JSON property overrideValue

Returns:

  • (Fixnum)


3829
3830
3831
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3829

def override_value
  @override_value
end

#unitString

The limit unit of the limit to which this override applies. An example unit would be: 1/project/region Note thatprojectandregionare not placeholders in this example; the literal charactersand`occur in the string. Corresponds to the JSON propertyunit`

Returns:

  • (String)


3838
3839
3840
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3838

def unit
  @unit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3845
3846
3847
3848
3849
3850
3851
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 3845

def update!(**args)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @metric = args[:metric] if args.key?(:metric)
  @name = args[:name] if args.key?(:name)
  @override_value = args[:override_value] if args.key?(:override_value)
  @unit = args[:unit] if args.key?(:unit)
end