Class: Google::Apis::JobsV3::CustomAttributeHistogramRequest

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

Overview

Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.

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

Returns a new instance of CustomAttributeHistogramRequest



804
805
806
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 804

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

Instance Attribute Details

#key ⇒ String

Required. Specifies the custom field key to perform a histogram on. If specified without long_value_histogram_bucketing_option, histogram on string values of the given key is triggered, otherwise histogram is performed on long values. Corresponds to the JSON property key

Returns:

  • (String) 


789
790
791
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 789

def key
  @key
end

#long_value_histogram_bucketing_option ⇒ Google::Apis::JobsV3::NumericBucketingOption

Input only. Use this field to specify bucketing option for the histogram search response. Corresponds to the JSON property longValueHistogramBucketingOption

Returns:



795
796
797
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 795

def long_value_histogram_bucketing_option
  @long_value_histogram_bucketing_option
end

#string_value_histogram ⇒ Boolean Also known as: string_value_histogram?

Optional. If set to true, the response includes the histogram value for each key as a string. Corresponds to the JSON property stringValueHistogram

Returns:

  • (Boolean) 


801
802
803
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 801

def string_value_histogram
  @string_value_histogram
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



809
810
811
812
813
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 809

def update!(**args)
  @key = args[:key] if args.key?(:key)
  @long_value_histogram_bucketing_option = args[:long_value_histogram_bucketing_option] if args.key?(:long_value_histogram_bucketing_option)
  @string_value_histogram = args[:string_value_histogram] if args.key?(:string_value_histogram)
end