Class: Google::Apis::ServiceuserV1::QuotaLimit

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

Overview

QuotaLimit defines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within a QuotaGroup.

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) ⇒ QuotaLimit

Returns a new instance of QuotaLimit



2584
2585
2586
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2584

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

Instance Attribute Details

#default_limit ⇒ Fixnum

Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only. Corresponds to the JSON property defaultLimit

Returns:

  • (Fixnum) 


2508
2509
2510
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2508

def default_limit
  @default_limit
end

#description ⇒ String

Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: display_name). Corresponds to the JSON property description

Returns:

  • (String) 


2531
2532
2533
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2531

def description
  @description
end

#display_name ⇒ String

User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration. Corresponds to the JSON property displayName

Returns:

  • (String) 


2524
2525
2526
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2524

def display_name
  @display_name
end

#duration ⇒ String

Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. Used by group-based quotas only. Corresponds to the JSON property duration

Returns:

  • (String) 


2485
2486
2487
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2485

def duration
  @duration
end

#free_tier ⇒ Fixnum

Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only. Corresponds to the JSON property freeTier

Returns:

  • (Fixnum) 


2496
2497
2498
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2496

def free_tier
  @free_tier
end

#max_limit ⇒ Fixnum

Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only. Corresponds to the JSON property maxLimit

Returns:

  • (Fixnum) 


2567
2568
2569
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2567

def max_limit
  @max_limit
end

#metric ⇒ String

The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config. Used by metric-based quotas only. Corresponds to the JSON property metric

Returns:

  • (String) 


2516
2517
2518
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2516

def metric
  @metric
end

#name ⇒ String

Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis. For metric-based quota limits, the name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters. The name of a limit is used as a unique identifier for this limit. Therefore, once a limit has been put into use, its name should be immutable. You can use the display_name field to provide a user-friendly name for the limit. The display name can be evolved over time without affecting the identity of the limit. Corresponds to the JSON property name

Returns:

  • (String) 


2582
2583
2584
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2582

def name
  @name
end

#unit ⇒ String

Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. The Google Service Control supports the following unit components:

  • One of the time intevals:
  • "/min" for quota every minute.
  • "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
  • Otherwise the quota won't be reset by time, such as storage limit.
  • One and only one of the granted containers:
  • "/project" quota for a project Here are some examples:
  • "1/min/project" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax. Used by metric-based quotas only. Corresponds to the JSON property unit

Returns:

  • (String) 


2556
2557
2558
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2556

def unit
  @unit
end

#values ⇒ Hash<String,Fixnum>

Tiered limit values, currently only STANDARD is supported. Corresponds to the JSON property values

Returns:

  • (Hash<String,Fixnum>) 


2536
2537
2538
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2536

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2589

def update!(**args)
  @duration = args[:duration] if args.key?(:duration)
  @free_tier = args[:free_tier] if args.key?(:free_tier)
  @default_limit = args[:default_limit] if args.key?(:default_limit)
  @metric = args[:metric] if args.key?(:metric)
  @display_name = args[:display_name] if args.key?(:display_name)
  @description = args[:description] if args.key?(:description)
  @values = args[:values] if args.key?(:values)
  @unit = args[:unit] if args.key?(:unit)
  @max_limit = args[:max_limit] if args.key?(:max_limit)
  @name = args[:name] if args.key?(:name)
end