Class: Google::Apis::ServiceusageV1::AdminQuotaPolicy

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

Overview

Quota policy created by quota administrator.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AdminQuotaPolicy

Returns a new instance of AdminQuotaPolicy.



115
116
117
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 115

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

Instance Attribute Details

#container ⇒ String

The cloud resource container at which the quota policy is created. The format is container_type`/`container_number Corresponds to the JSON property container

Returns:

  • (String) 


73
74
75
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 73

def container
  @container
end

#dimensions ⇒ Hash<String,String>

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, a policy on a limit with the unit 1/project/region`could contain an entry with the keyregion and the valueus-east-1; the policy is only applied to quota consumed in that region. This map has the following restrictions: * Ifregionappears as a key, its value must be a valid Cloud region. * Ifzoneappears as a key, its value must be a valid Cloud zone. * Keys other thanregionorzoneare not valid. Corresponds to the JSON propertydimensions`

Returns:

  • (Hash<String,String>) 


85
86
87
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 85

def dimensions
  @dimensions
end

#metric ⇒ String

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

Returns:

  • (String) 


91
92
93
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 91

def metric
  @metric
end

#name ⇒ String

The resource name of the policy. This name is generated by the server when the policy is created. Example names would be: organizations/123/services/compute. googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/% 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d Corresponds to the JSON property name

Returns:

  • (String) 


99
100
101
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 99

def name
  @name
end

#policy_value ⇒ Fixnum

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

Returns:

  • (Fixnum) 


105
106
107
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 105

def policy_value
  @policy_value
end

#unit ⇒ String

The limit unit of the limit to which this policy 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) 


113
114
115
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 113

def unit
  @unit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



120
121
122
123
124
125
126
127
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 120

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