Class: Google::Apis::ServiceusageV1beta1::QuotaOverride

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

Overview

A quota override

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QuotaOverride

Returns a new instance of QuotaOverride.



3590
3591
3592
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3590

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

Instance Attribute Details

#admin_override_ancestor ⇒ String

The resource name of the ancestor that requested the override. For example: " organizations/12345" or "folders/67890". Used by admin overrides only. Corresponds to the JSON property adminOverrideAncestor

Returns:

  • (String) 


3538
3539
3540
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3538

def admin_override_ancestor
  @admin_override_ancestor
end

#dimensions ⇒ Hash<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>) 


3556
3557
3558
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3556

def dimensions
  @dimensions
end

#metric ⇒ String

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) 


3562
3563
3564
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3562

def metric
  @metric
end

#name ⇒ String

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) 


3574
3575
3576
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3574

def name
  @name
end

#override_value ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3580
3581
3582
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3580

def override_value
  @override_value
end

#unit ⇒ String

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

Returns:

  • (String) 


3588
3589
3590
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3588

def unit
  @unit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3595
3596
3597
3598
3599
3600
3601
3602
 
# File 'lib/google/apis/serviceusage_v1beta1/classes.rb', line 3595

def update!(**args)
  @admin_override_ancestor = args[:admin_override_ancestor] if args.key?(:admin_override_ancestor)
  @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