View Source GoogleApi.Jobs.V2.Model.GetHistogramRequest (google_api_jobs v0.18.0)

Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram.

Input only.

A request for the GetHistogram method.

Attributes

  • allowBroadening (type: boolean(), default: nil) - Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query.

    Defaults to false.

  • filters (type: GoogleApi.Jobs.V2.Model.JobFilters.t, default: nil) - Deprecated. Use query instead.

    Optional.

    Restrictions on the scope of the histogram.

  • query (type: GoogleApi.Jobs.V2.Model.JobQuery.t, default: nil) - Optional. Query used to search against jobs, such as keyword, location filters, etc.

  • requestMetadata (type: GoogleApi.Jobs.V2.Model.RequestMetadata.t, default: nil) - Meta information, such as user_id, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist.

  • searchTypes (type: list(String.t), default: nil) - Required. A list of facets that specify the histogram data to be calculated against and returned.

    Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Jobs.V2.Model.GetHistogramRequest{
  allowBroadening: boolean(),
  filters: GoogleApi.Jobs.V2.Model.JobFilters.t(),
  query: GoogleApi.Jobs.V2.Model.JobQuery.t(),
  requestMetadata: GoogleApi.Jobs.V2.Model.RequestMetadata.t(),
  searchTypes: [String.t()]
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.