HistogramFacets

JSON representation
CustomAttributeHistogramRequest
- JSON representation
NumericBucketingOption
- JSON representation
CompensationHistogramRequest
- JSON representation

Input only.

Histogram facets to be specified in SearchJobsRequest .

JSON representation

JSON representation
{ "simpleHistogramFacets" : [ enum ( `SearchType` ) ] , "customAttributeHistogramFacets" : [ { object ( `CustomAttributeHistogramRequest` ) } ] , "compensationHistogramFacets" : [ { object ( `CompensationHistogramRequest` ) } ] }

 { 
 "simpleHistogramFacets" 
 : 
 [ 
 enum (  SearchType 
 
) 
 ] 
 , 
 "customAttributeHistogramFacets" 
 : 
 [ 
 { 
 object (  CustomAttributeHistogramRequest 
 
) 
 } 
 ] 
 , 
 "compensationHistogramFacets" 
 : 
 [ 
 { 
 object (  CompensationHistogramRequest 
 
) 
 } 
 ] 
 }

Fields

Fields
`simpleHistogramFacets[]`	`enum ( SearchType )` Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE` , `EMPLOYMENT_TYPE` etc.
`customAttributeHistogramFacets[]`	`object ( CustomAttributeHistogramRequest )` Optional. Specifies the custom attributes histogram requests. Duplicate values of `CustomAttributeHistogramRequest.key` are not allowed.
`compensationHistogramFacets[]`	`object ( CompensationHistogramRequest )` Optional. Specifies compensation field-based histogram requests. Duplicate values of `CompensationHistogramRequest.type` are not allowed.

simpleHistogramFacets[]

enum ( SearchType )

Optional. Specifies the simple type of histogram facets, for example, COMPANY_SIZE , EMPLOYMENT_TYPE etc.

customAttributeHistogramFacets[]

object ( CustomAttributeHistogramRequest )

Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.

compensationHistogramFacets[]

object ( CompensationHistogramRequest )

Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.

CustomAttributeHistogramRequest

Custom attributes histogram request. An error is thrown if neither stringValueHistogram or longValueHistogramBucketingOption has been defined.

JSON representation
{ "key" : string , "stringValueHistogram" : boolean , "longValueHistogramBucketingOption" : { object ( `NumericBucketingOption` ) } }

Fields

Fields
`key`	`string` Required. Specifies the custom field key to perform a histogram on. If specified without `longValueHistogramBucketingOption` , histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.
`stringValueHistogram`	`boolean` Optional. If set to true, the response includes the histogram value for each key as a string.
`longValueHistogramBucketingOption`	`object ( NumericBucketingOption )` Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements.

key

string

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

stringValueHistogram

boolean

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

longValueHistogramBucketingOption

object ( NumericBucketingOption )

Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements.

NumericBucketingOption

Input only.

Use this field to specify bucketing option for the histogram search response.

JSON representation
{ "bucketBounds" : [ number ] , "requiresMinMax" : boolean }

Fields

Fields
`bucketBounds[]`	`number` Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), [5, 10), [10, 15), [15, inf). At most 20 [buckets_bound][] is supported.
`requiresMinMax`	`boolean` Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.

bucketBounds[]

number

Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), [5, 10), [10, 15), [15, inf). At most 20 [buckets_bound][] is supported.

requiresMinMax

boolean

Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.

CompensationHistogramRequest

Input only.

Compensation based histogram request.

JSON representation
{ "type" : enum ( `CompensationHistogramRequestType` ) , "bucketingOption" : { object ( `NumericBucketingOption` ) } }

Fields

Fields
`type`	`enum ( CompensationHistogramRequestType )` Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType` .
`bucketingOption`	`object ( NumericBucketingOption )` Required. Numeric histogram options, like buckets, whether include min or max value.

type

enum ( CompensationHistogramRequestType )

Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each CompensationHistogramRequestType .

bucketingOption

object ( NumericBucketingOption )

Required. Numeric histogram options, like buckets, whether include min or max value.

HistogramFacets Stay organized with collections Save and categorize content based on your preferences.

CustomAttributeHistogramRequest

NumericBucketingOption

CompensationHistogramRequest

HistogramFacets