Class: Google::Apis::JobsV2::SearchJobsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/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.



3268
3269
3270
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3268

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

Instance Attribute Details

#disable_relevance_thresholding ⇒ Boolean Also known as: disable_relevance_thresholding?

Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false. Corresponds to the JSON property disableRelevanceThresholding

Returns:

  • (Boolean) 


3165
3166
3167
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3165

def disable_relevance_thresholding
  @disable_relevance_thresholding
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) 


3175
3176
3177
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3175

def enable_broadening
  @enable_broadening
end

#enable_precise_result_size ⇒ Boolean Also known as: enable_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 enablePreciseResultSize

Returns:

  • (Boolean) 


3187
3188
3189
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3187

def enable_precise_result_size
  @enable_precise_result_size
end

#filters ⇒ Google::Apis::JobsV2::JobFilters

Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. Corresponds to the JSON property filters

Returns:



3195
3196
3197
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3195

def filters
  @filters
end

#histogram_facets ⇒ Google::Apis::JobsV2::HistogramFacets

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

Returns:



3201
3202
3203
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3201

def histogram_facets
  @histogram_facets
end

#job_view ⇒ String

Optional. The number of 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) 


3207
3208
3209
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3207

def job_view
  @job_view
end

#mode ⇒ String

Required. Mode of a search. Corresponds to the JSON property mode

Returns:

  • (String) 


3212
3213
3214
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3212

def mode
  @mode
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) 


3224
3225
3226
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3224

def offset
  @offset
end

#order_by ⇒ String

Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. Corresponds to the JSON property orderBy

Returns:

  • (String) 


3232
3233
3234
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3232

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) 


3239
3240
3241
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3239

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) 


3246
3247
3248
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3246

def page_token
  @page_token
end

#query ⇒ Google::Apis::JobsV2::JobQuery

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

Returns:



3252
3253
3254
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3252

def query
  @query
end

#request_metadata ⇒ Google::Apis::JobsV2::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:



3260
3261
3262
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3260

def request_metadata
  @request_metadata
end

#sort_by ⇒ String

Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. Corresponds to the JSON property sortBy

Returns:

  • (String) 


3266
3267
3268
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3266

def sort_by
  @sort_by
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3273

def update!(**args)
  @disable_relevance_thresholding = args[:disable_relevance_thresholding] if args.key?(:disable_relevance_thresholding)
  @enable_broadening = args[:enable_broadening] if args.key?(:enable_broadening)
  @enable_precise_result_size = args[:enable_precise_result_size] if args.key?(:enable_precise_result_size)
  @filters = args[:filters] if args.key?(:filters)
  @histogram_facets = args[:histogram_facets] if args.key?(:histogram_facets)
  @job_view = args[:job_view] if args.key?(:job_view)
  @mode = args[:mode] if args.key?(:mode)
  @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)
  @query = args[:query] if args.key?(:query)
  @request_metadata = args[:request_metadata] if args.key?(:request_metadata)
  @sort_by = args[:sort_by] if args.key?(:sort_by)
end