Class: Google::Apis::JobsV2::CustomAttributeHistogramRequest
- Inherits:
-
Object
- Object
- Google::Apis::JobsV2::CustomAttributeHistogramRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/representations.rb
Overview
Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.
Instance Attribute Summary collapse
-
#key ⇒ String
Required.
-
#long_value_histogram_bucketing_option ⇒ Google::Apis::JobsV2::NumericBucketingOption
Input only.
-
#string_value_histogram ⇒ Boolean
(also: #string_value_histogram?)
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ CustomAttributeHistogramRequest
constructor
A new instance of CustomAttributeHistogramRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ CustomAttributeHistogramRequest
Returns a new instance of CustomAttributeHistogramRequest
853 854 855 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 853 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
838 839 840 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 838 def key @key end |
#long_value_histogram_bucketing_option ⇒ Google::Apis::JobsV2::NumericBucketingOption
Input only.
Use this field to specify bucketing option for the histogram search response.
Corresponds to the JSON property longValueHistogramBucketingOption
844 845 846 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 844 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 will include the histogram value for
each key as a string.
Corresponds to the JSON property stringValueHistogram
850 851 852 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 850 def string_value_histogram @string_value_histogram end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
858 859 860 861 862 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 858 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 |