class Google::Apis::JobsV3::SearchJobsRequest

Input only. The Request body of the `SearchJobs` call.

Attributes

disable_keyword_match[RW]

Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query “program manager,” a result is returned even if the job posting has the title “software developer,” which does not fall into “program manager” ontology, but does have “program manager” appearing in its description. For queries like “cloud” that does not contain title or location specific ontology, jobs with “cloud” keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company. keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. Corresponds to the JSON property `disableKeywordMatch` @return [Boolean]

disable_keyword_match?[RW]

Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, the query “program manager,” a result is returned even if the job posting has the title “software developer,” which does not fall into “program manager” ontology, but does have “program manager” appearing in its description. For queries like “cloud” that does not contain title or location specific ontology, jobs with “cloud” keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company. keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. Corresponds to the JSON property `disableKeywordMatch` @return [Boolean]

diversification_level[RW]

Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. Corresponds to the JSON property `diversificationLevel` @return [String]

enable_broadening[RW]

Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. Corresponds to the JSON property `enableBroadening` @return [Boolean]

enable_broadening?[RW]

Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. Corresponds to the JSON property `enableBroadening` @return [Boolean]

histogram_facets[RW]

Input only. Histogram facets to be specified in SearchJobsRequest. Corresponds to the JSON property `histogramFacets` @return [Google::Apis::JobsV3::HistogramFacets]

job_query[RW]

Input only. The query required to perform a search query. Corresponds to the JSON property `jobQuery` @return [Google::Apis::JobsV3::JobQuery]

job_view[RW]

Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. Corresponds to the JSON property `jobView` @return [String]

offset[RW]

Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). Corresponds to the JSON property `offset` @return [Fixnum]

order_by[RW]

Optional. The criteria determining how search results are sorted. Default is “ relevance desc”. Supported options are: * `“relevance desc”`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `“posting_publish_time desc”`: By Job.posting_publish_time descending. * `“posting_update_time desc”`: By Job.posting_update_time descending. * `“title”`: By Job.title ascending. * `“title desc”`: By Job.title descending. * `“annualized_base_compensation”`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `“annualized_base_compensation desc”`: By job's CompensationInfo. annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `“ annualized_total_compensation”`: By job's CompensationInfo. annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `“ annualized_total_compensation desc”`: By job's CompensationInfo. annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. Corresponds to the JSON property `orderBy` @return [String]

page_size[RW]

Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. Corresponds to the JSON property `pageSize` @return [Fixnum]

page_token[RW]

Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. Corresponds to the JSON property `pageToken` @return [String]

request_metadata[RW]

Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. Corresponds to the JSON property `requestMetadata` @return [Google::Apis::JobsV3::RequestMetadata]

require_precise_result_size[RW]

This field is deprecated. Corresponds to the JSON property `requirePreciseResultSize` @return [Boolean]

require_precise_result_size?[RW]

This field is deprecated. Corresponds to the JSON property `requirePreciseResultSize` @return [Boolean]

search_mode[RW]

Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. Corresponds to the JSON property `searchMode` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/jobs_v3/classes.rb, line 2391
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/jobs_v3/classes.rb, line 2396
def update!(**args)
  @disable_keyword_match = args[:disable_keyword_match] if args.key?(:disable_keyword_match)
  @diversification_level = args[:diversification_level] if args.key?(:diversification_level)
  @enable_broadening = args[:enable_broadening] if args.key?(:enable_broadening)
  @histogram_facets = args[:histogram_facets] if args.key?(:histogram_facets)
  @job_query = args[:job_query] if args.key?(:job_query)
  @job_view = args[:job_view] if args.key?(:job_view)
  @offset = args[:offset] if args.key?(:offset)
  @order_by = args[:order_by] if args.key?(:order_by)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @request_metadata = args[:request_metadata] if args.key?(:request_metadata)
  @require_precise_result_size = args[:require_precise_result_size] if args.key?(:require_precise_result_size)
  @search_mode = args[:search_mode] if args.key?(:search_mode)
end