Class: Google::Apis::JobsV3p1beta1::SearchJobsRequest

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

Overview

Input only. The Request body of the SearchJobs call.

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

Returns a new instance of SearchJobsRequest



2775
2776
2777
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2775

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

Instance Attribute Details

#custom_ranking_info ⇒ Google::Apis::JobsV3p1beta1::CustomRankingInfo

Input only. Custom ranking information for SearchJobsRequest. Corresponds to the JSON property customRankingInfo

Returns:



2596
2597
2598
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2596

def custom_ranking_info
  @custom_ranking_info
end

#disable_keyword_match ⇒ Boolean Also known as: disable_keyword_match?

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

Returns:

  • (Boolean) 


2617
2618
2619
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2617

def disable_keyword_match
  @disable_keyword_match
end

#diversification_level ⇒ String

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

Returns:

  • (String) 


2631
2632
2633
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2631

def diversification_level
  @diversification_level
end

#enable_broadening ⇒ Boolean Also known as: enable_broadening?

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

Returns:

  • (Boolean) 


2640
2641
2642
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2640

def enable_broadening
  @enable_broadening
end

#histogram_facets ⇒ Google::Apis::JobsV3p1beta1::HistogramFacets

Input only. Histogram facets to be specified in SearchJobsRequest. Corresponds to the JSON property histogramFacets

Returns:



2647
2648
2649
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2647

def histogram_facets
  @histogram_facets
end

#histogram_queries ⇒ Array<Google::Apis::JobsV3p1beta1::HistogramQuery>

Optional. Expression based histogram requests for jobs matching JobQuery. Corresponds to the JSON property histogramQueries

Returns:



2653
2654
2655
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2653

def histogram_queries
  @histogram_queries
end

#job_query ⇒ Google::Apis::JobsV3p1beta1::JobQuery

Input only. The query required to perform a search query. Corresponds to the JSON property jobQuery

Returns:



2659
2660
2661
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2659

def job_query
  @job_query
end

#job_view ⇒ String

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

Returns:

  • (String) 


2666
2667
2668
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2666

def job_view
  @job_view
end

#offset ⇒ Fixnum

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. 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

Returns:

  • (Fixnum) 


2678
2679
2680
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2678

def offset
  @offset
end

#order_by ⇒ String

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.
  • "custom_ranking desc": By the relevance score adjusted to the SearchJobsRequest.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order.
  • "location_distance": By the distance between the location on jobs and locations specified in the SearchJobsRequest.job_query.location_filters. When this order is selected, the SearchJobsRequest.job_query.location_filters must not be empty. When a job has multiple locations, the location closest to one of the locations specified in the location filter will be used to calculate location distance. Distance is calculated by the distance between two lat/long coordinates, with a precision of 10e-4 degrees (11.3 meters). Jobs that don't have locations specified will be ranked below jobs having locations. Diversification strategy is still applied unless explicitly disabled in SearchJobsRequest.diversification_level. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2729
2730
2731
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2729

def order_by
  @order_by
end

#page_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2737
2738
2739
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2737

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


2745
2746
2747
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2745

def page_token
  @page_token
end

#request_metadata ⇒ Google::Apis::JobsV3p1beta1::RequestMetadata

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

Returns:



2753
2754
2755
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2753

def request_metadata
  @request_metadata
end

#require_precise_result_size ⇒ Boolean Also known as: require_precise_result_size?

Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to true ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. Corresponds to the JSON property requirePreciseResultSize

Returns:

  • (Boolean) 


2765
2766
2767
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2765

def require_precise_result_size
  @require_precise_result_size
end

#search_mode ⇒ String

Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. Corresponds to the JSON property searchMode

Returns:

  • (String) 


2773
2774
2775
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2773

def search_mode
  @search_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2780

def update!(**args)
  @custom_ranking_info = args[:custom_ranking_info] if args.key?(:custom_ranking_info)
  @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)
  @histogram_queries = args[:histogram_queries] if args.key?(:histogram_queries)
  @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