Class: Google::Cloud::Talent::V4beta1::SearchJobsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb

Overview

Response for SearchJob method.

Defined Under Namespace

Classes: CommuteInfo, MatchingJob

Instance Attribute Summary collapse

Instance Attribute Details

#broadened_query_jobs_count ⇒ Integer

Returns If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.

Returns:

  • (Integer) —

    If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#estimated_total_size ⇒ Integer

Returns An estimation of the number of jobs that match the specified query.

This number isn't guaranteed to be accurate. For accurate results, see SearchJobsRequest#require_precise_result_size.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#histogram_query_results ⇒ Array<Google::Cloud::Talent::V4beta1::HistogramQueryResult>

Returns The histogram results that match with specified SearchJobsRequest#histogram_queries.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#location_filters ⇒ Array<Google::Cloud::Talent::V4beta1::Location>

Returns The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location#location_type is Location::LocationType::LOCATION_TYPE_UNSPECIFIED.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#matching_jobs ⇒ Array<Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob>

Returns The Job entities that match the specified SearchJobsRequest.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#metadata ⇒ Google::Cloud::Talent::V4beta1::ResponseMetadata

Returns Additional information for the API invocation, such as the request tracking id.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#next_page_token ⇒ String

Returns The token that specifies the starting position of the next page of results. This field is empty if there are no more results.

Returns:

  • (String) —

    The token that specifies the starting position of the next page of results. This field is empty if there are no more results.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#spell_correction ⇒ Google::Cloud::Talent::V4beta1::SpellingCorrection

Returns The spell checking result, and correction.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end

#total_size ⇒ Integer

Returns The precise result count, which is available only if the client set SearchJobsRequest#require_precise_result_size to true, or if the response is the last page of results. Otherwise, the value is -1.

Returns:



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb', line 603

class SearchJobsResponse
  # Job entry with metadata inside
  # {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse}.
  # @!attribute [rw] job
  #   @return [Google::Cloud::Talent::V4beta1::Job]
  #     Job resource that matches the specified
  #     {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}.
  # @!attribute [rw] job_summary
  #   @return [String]
  #     A summary of the job with core information that's displayed on the search
  #     results listing page.
  # @!attribute [rw] job_title_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#title Job#title} field most closely
  #     matching a search query's keywords, if available. The matching query
  #     keywords are enclosed in HTML bold tags.
  # @!attribute [rw] search_text_snippet
  #   @return [String]
  #     Contains snippets of text from the
  #     {Google::Cloud::Talent::V4beta1::Job#description Job#description} and
  #     similar fields that most closely match a search query's keywords, if
  #     available. All HTML tags in the original fields are stripped when
  #     returned in this field, and matching query keywords are enclosed in HTML
  #     bold tags.
  # @!attribute [rw] commute_info
  #   @return [Google::Cloud::Talent::V4beta1::SearchJobsResponse::CommuteInfo]
  #     Commute information which is generated based on specified
  #      {Google::Cloud::Talent::V4beta1::CommuteFilter CommuteFilter}.
  class MatchingJob; end

  # Commute details related to this job.
  # @!attribute [rw] job_location
  #   @return [Google::Cloud::Talent::V4beta1::Location]
  #     Location used as the destination in the commute calculation.
  # @!attribute [rw] travel_duration
  #   @return [Google::Protobuf::Duration]
  #     The number of seconds required to travel to the job location from the
  #     query location. A duration of 0 seconds indicates that the job isn't
  #     reachable within the requested duration, but was returned as part of an
  #     expanded query.
  class CommuteInfo; end
end