Class: Google::Apis::DiscoveryengineV1::GoogleApiDistributionBucketOptionsExponential

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

Overview

Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleApiDistributionBucketOptionsExponential

Returns a new instance of GoogleApiDistributionBucketOptionsExponential.



225
226
227
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 225

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

Instance Attribute Details

#growth_factor ⇒ Float

Must be greater than 1. Corresponds to the JSON property growthFactor

Returns:

  • (Float) 


213
214
215
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 213

def growth_factor
  @growth_factor
end

#num_finite_buckets ⇒ Fixnum

Must be greater than 0. Corresponds to the JSON property numFiniteBuckets

Returns:

  • (Fixnum) 


218
219
220
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 218

def num_finite_buckets
  @num_finite_buckets
end

#scale ⇒ Float

Must be greater than 0. Corresponds to the JSON property scale

Returns:

  • (Float) 


223
224
225
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 223

def scale
  @scale
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



230
231
232
233
234
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 230

def update!(**args)
  @growth_factor = args[:growth_factor] if args.key?(:growth_factor)
  @num_finite_buckets = args[:num_finite_buckets] if args.key?(:num_finite_buckets)
  @scale = args[:scale] if args.key?(:scale)
end