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

Constructor Details

#initialize(**args) ⇒ SearchJobsRequest

Returns a new instance of SearchJobsRequest.



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

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:



2476
2477
2478
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2476

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) 


2493
2494
2495
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2493

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) 


2504
2505
2506
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2504

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) 


2511
2512
2513
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2511

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:



2517
2518
2519
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2517

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:



2522
2523
2524
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2522

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:



2527
2528
2529
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2527

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) 


2533
2534
2535
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2533

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

Returns:

  • (Fixnum) 


2544
2545
2546
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2544

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 sorting: Use the special syntax to order jobs by distance: "distance_from('Hawaii')": Order by distance from Hawaii. " distance_from(19.89, 155.5)": Order by distance from a coordinate. " distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below. "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2582
2583
2584
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2582

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) 


2589
2590
2591
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2589

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) 


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

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:



2603
2604
2605
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2603

def request_metadata
  @request_metadata
end

#require_precise_result_size ⇒ Boolean Also known as: require_precise_result_size?

This field is deprecated. Corresponds to the JSON property requirePreciseResultSize

Returns:

  • (Boolean) 


2608
2609
2610
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2608

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) 


2614
2615
2616
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2614

def search_mode
  @search_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2621

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