lib/google/cloud/talent/v4/job_service/client.rb in google-cloud-talent-v4-0.8.1 vs lib/google/cloud/talent/v4/job_service/client.rb in google-cloud-talent-v4-0.9.0

- old
+ new

@@ -324,18 +324,18 @@ # request = Google::Cloud::Talent::V4::BatchCreateJobsRequest.new # # # Call the batch_create_jobs method. # result = client.batch_create_jobs request # - # # The returned object is of type Gapic::Operation. You can use this - # # object to check the status of an operation, cancel it, or wait - # # for results. Here is how to block until completion: + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else - # puts "Error!" + # puts "No response received." # end # def batch_create_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? @@ -492,12 +492,14 @@ # @param job [::Google::Cloud::Talent::V4::Job, ::Hash] # Required. The Job to be updated. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Strongly recommended for the best service experience. # - # If {::Google::Cloud::Talent::V4::UpdateJobRequest#update_mask update_mask} is provided, only the specified fields in - # {::Google::Cloud::Talent::V4::UpdateJobRequest#job job} are updated. Otherwise all the fields are updated. + # If {::Google::Cloud::Talent::V4::UpdateJobRequest#update_mask update_mask} is + # provided, only the specified fields in + # {::Google::Cloud::Talent::V4::UpdateJobRequest#job job} are updated. Otherwise + # all the fields are updated. # # A field mask to restrict the fields that are updated. Only # top level fields of {::Google::Cloud::Talent::V4::Job Job} are supported. # # @yield [response, operation] Access the result along with the RPC operation @@ -592,21 +594,23 @@ # A maximum of 200 jobs can be updated in a batch. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Strongly recommended for the best service experience. Be aware that it will # also increase latency when checking the status of a batch operation. # - # If {::Google::Cloud::Talent::V4::BatchUpdateJobsRequest#update_mask update_mask} is provided, only the specified fields in - # {::Google::Cloud::Talent::V4::Job Job} are updated. Otherwise all the fields are updated. + # If {::Google::Cloud::Talent::V4::BatchUpdateJobsRequest#update_mask update_mask} + # is provided, only the specified fields in {::Google::Cloud::Talent::V4::Job Job} + # are updated. Otherwise all the fields are updated. # # A field mask to restrict the fields that are updated. Only # top level fields of {::Google::Cloud::Talent::V4::Job Job} are supported. # - # If {::Google::Cloud::Talent::V4::BatchUpdateJobsRequest#update_mask update_mask} is provided, The {::Google::Cloud::Talent::V4::Job Job} inside + # If {::Google::Cloud::Talent::V4::BatchUpdateJobsRequest#update_mask update_mask} + # is provided, The {::Google::Cloud::Talent::V4::Job Job} inside # [JobResult][JobOperationResult.JobResult] # will only contains fields that is updated, plus the Id of the Job. - # Otherwise, {::Google::Cloud::Talent::V4::Job Job} will include all fields, which can yield a very - # large response. + # Otherwise, {::Google::Cloud::Talent::V4::Job Job} will include all fields, + # which can yield a very large response. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -624,18 +628,18 @@ # request = Google::Cloud::Talent::V4::BatchUpdateJobsRequest.new # # # Call the batch_update_jobs method. # result = client.batch_update_jobs request # - # # The returned object is of type Gapic::Operation. You can use this - # # object to check the status of an operation, cancel it, or wait - # # for results. Here is how to block until completion: + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else - # puts "Error!" + # puts "No response received." # end # def batch_update_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? @@ -821,18 +825,18 @@ # request = Google::Cloud::Talent::V4::BatchDeleteJobsRequest.new # # # Call the batch_delete_jobs method. # result = client.batch_delete_jobs request # - # # The returned object is of type Gapic::Operation. You can use this - # # object to check the status of an operation, cancel it, or wait - # # for results. Here is how to block until completion: + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else - # puts "Error!" + # puts "No response received." # end # def batch_delete_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? @@ -925,18 +929,21 @@ # @param page_token [::String] # The starting point of a query result. # @param page_size [::Integer] # The maximum number of jobs to be returned per page of results. # - # If {::Google::Cloud::Talent::V4::ListJobsRequest#job_view job_view} is set to {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_ID_ONLY JobView.JOB_VIEW_ID_ONLY}, the maximum allowed - # page size is 1000. Otherwise, the maximum allowed page size is 100. + # If {::Google::Cloud::Talent::V4::ListJobsRequest#job_view job_view} is set to + # {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_ID_ONLY JobView.JOB_VIEW_ID_ONLY}, + # the maximum allowed page size is 1000. Otherwise, the maximum allowed page + # size is 100. # # Default is 100 if empty or a number < 1 is specified. # @param job_view [::Google::Cloud::Talent::V4::JobView] # The desired job attributes returned for jobs in the - # search response. Defaults to {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_FULL JobView.JOB_VIEW_FULL} if no value is - # specified. + # search response. Defaults to + # {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_FULL JobView.JOB_VIEW_FULL} if no + # value is specified. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4::Job>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -954,17 +961,15 @@ # request = Google::Cloud::Talent::V4::ListJobsRequest.new # # # Call the list_jobs method. # result = client.list_jobs request # - # # The returned object is of type Gapic::PagedEnumerable. You can - # # iterate over all elements by calling #each, and the enumerable - # # will lazily make API calls to fetch subsequent pages. Other - # # methods are also available for managing paging directly. - # result.each do |response| + # # The returned object is of type Gapic::PagedEnumerable. You can iterate + # # over elements, and API calls will be issued to fetch pages as needed. + # result.each do |item| # # Each element is of type ::Google::Cloud::Talent::V4::Job. - # p response + # p item # end # def list_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? @@ -1006,15 +1011,17 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## - # Searches for jobs using the provided {::Google::Cloud::Talent::V4::SearchJobsRequest SearchJobsRequest}. + # Searches for jobs using the provided + # {::Google::Cloud::Talent::V4::SearchJobsRequest SearchJobsRequest}. # - # This call constrains the {::Google::Cloud::Talent::V4::Job#visibility visibility} of jobs - # present in the database, and only returns jobs that the caller has - # permission to search against. + # This call constrains the + # {::Google::Cloud::Talent::V4::Job#visibility visibility} of jobs present in the + # database, and only returns jobs that the caller has permission to search + # against. # # @overload search_jobs(request, options = nil) # Pass arguments to `search_jobs` via a request object, either of type # {::Google::Cloud::Talent::V4::SearchJobsRequest} or an equivalent Hash. # @@ -1035,15 +1042,16 @@ # The format is "projects/\\{project_id}/tenants/\\{tenant_id}". For example, # "projects/foo/tenants/bar". # @param search_mode [::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode] # Mode of a search. # - # Defaults to {::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode.JOB_SEARCH}. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode.JOB_SEARCH}. # @param request_metadata [::Google::Cloud::Talent::V4::RequestMetadata, ::Hash] - # Required. The meta information collected about the job searcher, used to improve the - # search quality of the service. The identifiers (such as `user_id`) are - # provided by users, and must be unique and consistent. + # Required. The meta information collected about the job searcher, used to + # improve the search quality of the service. The identifiers (such as + # `user_id`) are provided by users, and must be unique and consistent. # @param job_query [::Google::Cloud::Talent::V4::JobQuery, ::Hash] # Query used to search against jobs, such as keyword, location filters, etc. # @param enable_broadening [::Boolean] # Controls whether to broaden the search when it produces sparse results. # Broadened queries append results to the end of the matching results @@ -1083,27 +1091,36 @@ # with range of [start, end). Note that the end is exclusive, for example, # bucket(1, MAX, "positive number") or bucket(1, 10). # # Job histogram facets: # - # * company_display_name: histogram by {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}. - # * employment_type: histogram by {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types}, for example, + # * company_display_name: histogram by + # {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}. + # * employment_type: histogram by + # {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types}, for + # example, # "FULL_TIME", "PART_TIME". - # * company_size (DEPRECATED): histogram by {::Google::Cloud::Talent::V4::CompanySize CompanySize}, for example, - # "SMALL", "MEDIUM", "BIG". - # * publish_time_in_day: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * company_size (DEPRECATED): histogram by + # {::Google::Cloud::Talent::V4::CompanySize CompanySize}, for example, "SMALL", + # "MEDIUM", "BIG". + # * publish_time_in_day: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in days. # Must specify list of numeric buckets in spec. - # * publish_time_in_month: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * publish_time_in_month: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in months. # Must specify list of numeric buckets in spec. - # * publish_time_in_year: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * publish_time_in_year: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in years. # Must specify list of numeric buckets in spec. - # * degree_types: histogram by the {::Google::Cloud::Talent::V4::Job#degree_types Job.degree_types}, for example, + # * degree_types: histogram by the + # {::Google::Cloud::Talent::V4::Job#degree_types Job.degree_types}, for example, # "Bachelors", "Masters". - # * job_level: histogram by the {::Google::Cloud::Talent::V4::Job#job_level Job.job_level}, for example, "Entry + # * job_level: histogram by the + # {::Google::Cloud::Talent::V4::Job#job_level Job.job_level}, for example, "Entry # Level". # * country: histogram by the country code of jobs, for example, "US", "FR". # * admin1: histogram by the admin1 code of jobs, which is a global # placeholder referring to the state, province, or the particular term a # country uses to define the geographic structure below the country level, @@ -1114,29 +1131,35 @@ # for example, "CA, US", "IL, US". # * city_coordinate: histogram by the city center's GPS coordinates (latitude # and longitude), for example, 37.4038522,-122.0987765. Since the # coordinates of a city center can change, customers may need to refresh # them periodically. - # * locale: histogram by the {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, for example, "en-US", + # * locale: histogram by the + # {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, for example, + # "en-US", # "fr-FR". - # * language: histogram by the language subtag of the {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, + # * language: histogram by the language subtag of the + # {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, # for example, "en", "fr". - # * category: histogram by the {::Google::Cloud::Talent::V4::JobCategory JobCategory}, for example, + # * category: histogram by the + # {::Google::Cloud::Talent::V4::JobCategory JobCategory}, for example, # "COMPUTER_AND_IT", "HEALTHCARE". # * base_compensation_unit: histogram by the - # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationInfo.CompensationUnit} of base - # salary, for example, "WEEKLY", "MONTHLY". + # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationInfo.CompensationUnit} + # of base salary, for example, "WEEKLY", "MONTHLY". # * base_compensation: histogram by the base salary. Must specify list of # numeric buckets to group results by. # * annualized_base_compensation: histogram by the base annualized salary. # Must specify list of numeric buckets to group results by. # * annualized_total_compensation: histogram by the total annualized salary. # Must specify list of numeric buckets to group results by. - # * string_custom_attribute: histogram by string {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. + # * string_custom_attribute: histogram by string + # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. # Values can be accessed via square bracket notations like # string_custom_attribute["key1"]. - # * numeric_custom_attribute: histogram by numeric {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. + # * numeric_custom_attribute: histogram by numeric + # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. # Values can be accessed via square bracket notations like # numeric_custom_attribute["key1"]. Must specify list of numeric buckets to # group results by. # # Example expressions: @@ -1147,15 +1170,18 @@ # * `count(string_custom_attribute["some-string-custom-attribute"])` # * `count(numeric_custom_attribute["some-numeric-custom-attribute"], # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])` # @param job_view [::Google::Cloud::Talent::V4::JobView] # The desired job attributes returned for jobs in the search response. - # Defaults to {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_SMALL JobView.JOB_VIEW_SMALL} if no value is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_SMALL JobView.JOB_VIEW_SMALL} if + # no value is specified. # @param offset [::Integer] # 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 {::Google::Cloud::Talent::V4::SearchJobsRequest#page_token page_token} is unset. + # results. This field is only considered if + # {::Google::Cloud::Talent::V4::SearchJobsRequest#page_token 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 @@ -1165,48 +1191,52 @@ # 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. # @param page_token [::String] # The token specifying the current offset within - # search results. See {::Google::Cloud::Talent::V4::SearchJobsResponse#next_page_token SearchJobsResponse.next_page_token} for - # an explanation of how to obtain the next set of query results. + # search results. See + # {::Google::Cloud::Talent::V4::SearchJobsResponse#next_page_token SearchJobsResponse.next_page_token} + # for an explanation of how to obtain the next set of query results. # @param order_by [::String] # 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 {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * `"posting_publish_time desc"`: By + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # descending. - # * `"posting_update_time desc"`: By {::Google::Cloud::Talent::V4::Job#posting_update_time Job.posting_update_time} + # * `"posting_update_time desc"`: By + # {::Google::Cloud::Talent::V4::Job#posting_update_time Job.posting_update_time} # descending. # * `"title"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} ascending. - # * `"title desc"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} descending. + # * `"title desc"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} + # descending. # * `"annualized_base_compensation"`: By job's - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range CompensationInfo.annualized_base_compensation_range} ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range CompensationInfo.annualized_base_compensation_range} descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range CompensationInfo.annualized_total_compensation_range} ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range CompensationInfo.annualized_total_compensation_range} descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range 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 - # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest.CustomRankingInfo.ranking_expression} with weight - # factor assigned by - # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#importance_level SearchJobsRequest.CustomRankingInfo.importance_level} in descending - # order. + # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest.CustomRankingInfo.ranking_expression} + # with weight factor assigned by + # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#importance_level SearchJobsRequest.CustomRankingInfo.importance_level} + # in descending order. # * Location sorting: Use the special syntax to order jobs by distance:<br> # `"distance_from('Hawaii')"`: Order by distance from Hawaii.<br> # `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.<br> # `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by # multiple locations. See details below.<br> @@ -1226,49 +1256,60 @@ # 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 {::Google::Cloud::Talent::V4::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel.SIMPLE} if no value - # is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel.SIMPLE} + # if no value is specified. # @param custom_ranking_info [::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo, ::Hash] # Controls over how job documents get ranked on top of existing relevance # score (determined by API algorithm). # @param disable_keyword_match [::Boolean] # This field is deprecated. Please use - # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} going forward. + # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} + # going forward. # # To migrate, disable_keyword_match set to false maps to - # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL}, and disable_keyword_match set to - # true maps to {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_DISABLED KeywordMatchMode.KEYWORD_MATCH_DISABLED}. If - # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} is set, this field is ignored. + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL}, + # and disable_keyword_match set to true maps to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_DISABLED KeywordMatchMode.KEYWORD_MATCH_DISABLED}. + # If + # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} + # is set, this field is ignored. # - # Controls whether to disable exact keyword match on {::Google::Cloud::Talent::V4::Job#title Job.title}, - # {::Google::Cloud::Talent::V4::Job#description Job.description}, {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}, {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}, - # {::Google::Cloud::Talent::V4::Job#qualifications 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, for the query "program manager," - # a result is returned even if the job posting has the title "software - # developer," which doesn't fall into "program manager" ontology, but does - # have "program manager" appearing in its description. + # Controls whether to disable exact keyword match on + # {::Google::Cloud::Talent::V4::Job#title Job.title}, + # {::Google::Cloud::Talent::V4::Job#description Job.description}, + # {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}, + # {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}, + # {::Google::Cloud::Talent::V4::Job#qualifications 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, for the query "program manager," a result is returned even if the + # job posting has the title "software developer," which doesn't fall into + # "program manager" ontology, but does have "program manager" appearing in + # its description. # # For queries like "cloud" that don't contain title or # location specific ontology, jobs with "cloud" keyword matches are returned # regardless of this flag's value. # - # Use {::Google::Cloud::Talent::V4::Company#keyword_searchable_job_custom_attributes Company.keyword_searchable_job_custom_attributes} if - # company-specific globally matched custom field/attribute string values are - # needed. Enabling keyword match improves recall of subsequent search + # Use + # {::Google::Cloud::Talent::V4::Company#keyword_searchable_job_custom_attributes Company.keyword_searchable_job_custom_attributes} + # if company-specific globally matched custom field/attribute string values + # are needed. Enabling keyword match improves recall of subsequent search # requests. # # Defaults to false. # @param keyword_match_mode [::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode] # Controls what keyword match options to use. If both keyword_match_mode and # disable_keyword_match are set, keyword_match_mode will take precedence. # - # Defaults to {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} if no value - # is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} + # if no value is specified. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Talent::V4::SearchJobsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -1331,20 +1372,22 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## - # Searches for jobs using the provided {::Google::Cloud::Talent::V4::SearchJobsRequest SearchJobsRequest}. + # Searches for jobs using the provided + # {::Google::Cloud::Talent::V4::SearchJobsRequest SearchJobsRequest}. # # This API call is intended for the use case of targeting passive job # seekers (for example, job seekers who have signed up to receive email # alerts about potential job opportunities), it has different algorithmic # adjustments that are designed to specifically target passive job seekers. # - # This call constrains the {::Google::Cloud::Talent::V4::Job#visibility visibility} of jobs - # present in the database, and only returns jobs the caller has - # permission to search against. + # This call constrains the + # {::Google::Cloud::Talent::V4::Job#visibility visibility} of jobs present in the + # database, and only returns jobs the caller has permission to search + # against. # # @overload search_jobs_for_alert(request, options = nil) # Pass arguments to `search_jobs_for_alert` via a request object, either of type # {::Google::Cloud::Talent::V4::SearchJobsRequest} or an equivalent Hash. # @@ -1365,15 +1408,16 @@ # The format is "projects/\\{project_id}/tenants/\\{tenant_id}". For example, # "projects/foo/tenants/bar". # @param search_mode [::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode] # Mode of a search. # - # Defaults to {::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode.JOB_SEARCH}. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode.JOB_SEARCH}. # @param request_metadata [::Google::Cloud::Talent::V4::RequestMetadata, ::Hash] - # Required. The meta information collected about the job searcher, used to improve the - # search quality of the service. The identifiers (such as `user_id`) are - # provided by users, and must be unique and consistent. + # Required. The meta information collected about the job searcher, used to + # improve the search quality of the service. The identifiers (such as + # `user_id`) are provided by users, and must be unique and consistent. # @param job_query [::Google::Cloud::Talent::V4::JobQuery, ::Hash] # Query used to search against jobs, such as keyword, location filters, etc. # @param enable_broadening [::Boolean] # Controls whether to broaden the search when it produces sparse results. # Broadened queries append results to the end of the matching results @@ -1413,27 +1457,36 @@ # with range of [start, end). Note that the end is exclusive, for example, # bucket(1, MAX, "positive number") or bucket(1, 10). # # Job histogram facets: # - # * company_display_name: histogram by {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}. - # * employment_type: histogram by {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types}, for example, + # * company_display_name: histogram by + # {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}. + # * employment_type: histogram by + # {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types}, for + # example, # "FULL_TIME", "PART_TIME". - # * company_size (DEPRECATED): histogram by {::Google::Cloud::Talent::V4::CompanySize CompanySize}, for example, - # "SMALL", "MEDIUM", "BIG". - # * publish_time_in_day: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * company_size (DEPRECATED): histogram by + # {::Google::Cloud::Talent::V4::CompanySize CompanySize}, for example, "SMALL", + # "MEDIUM", "BIG". + # * publish_time_in_day: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in days. # Must specify list of numeric buckets in spec. - # * publish_time_in_month: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * publish_time_in_month: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in months. # Must specify list of numeric buckets in spec. - # * publish_time_in_year: histogram by the {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * publish_time_in_year: histogram by the + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # in years. # Must specify list of numeric buckets in spec. - # * degree_types: histogram by the {::Google::Cloud::Talent::V4::Job#degree_types Job.degree_types}, for example, + # * degree_types: histogram by the + # {::Google::Cloud::Talent::V4::Job#degree_types Job.degree_types}, for example, # "Bachelors", "Masters". - # * job_level: histogram by the {::Google::Cloud::Talent::V4::Job#job_level Job.job_level}, for example, "Entry + # * job_level: histogram by the + # {::Google::Cloud::Talent::V4::Job#job_level Job.job_level}, for example, "Entry # Level". # * country: histogram by the country code of jobs, for example, "US", "FR". # * admin1: histogram by the admin1 code of jobs, which is a global # placeholder referring to the state, province, or the particular term a # country uses to define the geographic structure below the country level, @@ -1444,29 +1497,35 @@ # for example, "CA, US", "IL, US". # * city_coordinate: histogram by the city center's GPS coordinates (latitude # and longitude), for example, 37.4038522,-122.0987765. Since the # coordinates of a city center can change, customers may need to refresh # them periodically. - # * locale: histogram by the {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, for example, "en-US", + # * locale: histogram by the + # {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, for example, + # "en-US", # "fr-FR". - # * language: histogram by the language subtag of the {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, + # * language: histogram by the language subtag of the + # {::Google::Cloud::Talent::V4::Job#language_code Job.language_code}, # for example, "en", "fr". - # * category: histogram by the {::Google::Cloud::Talent::V4::JobCategory JobCategory}, for example, + # * category: histogram by the + # {::Google::Cloud::Talent::V4::JobCategory JobCategory}, for example, # "COMPUTER_AND_IT", "HEALTHCARE". # * base_compensation_unit: histogram by the - # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationInfo.CompensationUnit} of base - # salary, for example, "WEEKLY", "MONTHLY". + # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit CompensationInfo.CompensationUnit} + # of base salary, for example, "WEEKLY", "MONTHLY". # * base_compensation: histogram by the base salary. Must specify list of # numeric buckets to group results by. # * annualized_base_compensation: histogram by the base annualized salary. # Must specify list of numeric buckets to group results by. # * annualized_total_compensation: histogram by the total annualized salary. # Must specify list of numeric buckets to group results by. - # * string_custom_attribute: histogram by string {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. + # * string_custom_attribute: histogram by string + # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. # Values can be accessed via square bracket notations like # string_custom_attribute["key1"]. - # * numeric_custom_attribute: histogram by numeric {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. + # * numeric_custom_attribute: histogram by numeric + # {::Google::Cloud::Talent::V4::Job#custom_attributes Job.custom_attributes}. # Values can be accessed via square bracket notations like # numeric_custom_attribute["key1"]. Must specify list of numeric buckets to # group results by. # # Example expressions: @@ -1477,15 +1536,18 @@ # * `count(string_custom_attribute["some-string-custom-attribute"])` # * `count(numeric_custom_attribute["some-numeric-custom-attribute"], # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])` # @param job_view [::Google::Cloud::Talent::V4::JobView] # The desired job attributes returned for jobs in the search response. - # Defaults to {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_SMALL JobView.JOB_VIEW_SMALL} if no value is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::JobView::JOB_VIEW_SMALL JobView.JOB_VIEW_SMALL} if + # no value is specified. # @param offset [::Integer] # 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 {::Google::Cloud::Talent::V4::SearchJobsRequest#page_token page_token} is unset. + # results. This field is only considered if + # {::Google::Cloud::Talent::V4::SearchJobsRequest#page_token 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 @@ -1495,48 +1557,52 @@ # 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. # @param page_token [::String] # The token specifying the current offset within - # search results. See {::Google::Cloud::Talent::V4::SearchJobsResponse#next_page_token SearchJobsResponse.next_page_token} for - # an explanation of how to obtain the next set of query results. + # search results. See + # {::Google::Cloud::Talent::V4::SearchJobsResponse#next_page_token SearchJobsResponse.next_page_token} + # for an explanation of how to obtain the next set of query results. # @param order_by [::String] # 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 {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} + # * `"posting_publish_time desc"`: By + # {::Google::Cloud::Talent::V4::Job#posting_publish_time Job.posting_publish_time} # descending. - # * `"posting_update_time desc"`: By {::Google::Cloud::Talent::V4::Job#posting_update_time Job.posting_update_time} + # * `"posting_update_time desc"`: By + # {::Google::Cloud::Talent::V4::Job#posting_update_time Job.posting_update_time} # descending. # * `"title"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} ascending. - # * `"title desc"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} descending. + # * `"title desc"`: By {::Google::Cloud::Talent::V4::Job#title Job.title} + # descending. # * `"annualized_base_compensation"`: By job's - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range CompensationInfo.annualized_base_compensation_range} ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range CompensationInfo.annualized_base_compensation_range} descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_base_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range CompensationInfo.annualized_total_compensation_range} ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range 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 - # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range CompensationInfo.annualized_total_compensation_range} descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # {::Google::Cloud::Talent::V4::CompensationInfo#annualized_total_compensation_range 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 - # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest.CustomRankingInfo.ranking_expression} with weight - # factor assigned by - # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#importance_level SearchJobsRequest.CustomRankingInfo.importance_level} in descending - # order. + # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest.CustomRankingInfo.ranking_expression} + # with weight factor assigned by + # {::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo#importance_level SearchJobsRequest.CustomRankingInfo.importance_level} + # in descending order. # * Location sorting: Use the special syntax to order jobs by distance:<br> # `"distance_from('Hawaii')"`: Order by distance from Hawaii.<br> # `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.<br> # `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by # multiple locations. See details below.<br> @@ -1556,48 +1622,59 @@ # 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 {::Google::Cloud::Talent::V4::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel.SIMPLE} if no value - # is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel.SIMPLE} + # if no value is specified. # @param custom_ranking_info [::Google::Cloud::Talent::V4::SearchJobsRequest::CustomRankingInfo, ::Hash] # Controls over how job documents get ranked on top of existing relevance # score (determined by API algorithm). # @param disable_keyword_match [::Boolean] # This field is deprecated. Please use - # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} going forward. + # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} + # going forward. # # To migrate, disable_keyword_match set to false maps to - # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL}, and disable_keyword_match set to - # true maps to {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_DISABLED KeywordMatchMode.KEYWORD_MATCH_DISABLED}. If - # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} is set, this field is ignored. + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL}, + # and disable_keyword_match set to true maps to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_DISABLED KeywordMatchMode.KEYWORD_MATCH_DISABLED}. + # If + # {::Google::Cloud::Talent::V4::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} + # is set, this field is ignored. # - # Controls whether to disable exact keyword match on {::Google::Cloud::Talent::V4::Job#title Job.title}, - # {::Google::Cloud::Talent::V4::Job#description Job.description}, {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}, {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}, - # {::Google::Cloud::Talent::V4::Job#qualifications 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, for the query "program manager," - # a result is returned even if the job posting has the title "software - # developer," which doesn't fall into "program manager" ontology, but does - # have "program manager" appearing in its description. + # Controls whether to disable exact keyword match on + # {::Google::Cloud::Talent::V4::Job#title Job.title}, + # {::Google::Cloud::Talent::V4::Job#description Job.description}, + # {::Google::Cloud::Talent::V4::Job#company_display_name Job.company_display_name}, + # {::Google::Cloud::Talent::V4::Job#addresses Job.addresses}, + # {::Google::Cloud::Talent::V4::Job#qualifications 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, for the query "program manager," a result is returned even if the + # job posting has the title "software developer," which doesn't fall into + # "program manager" ontology, but does have "program manager" appearing in + # its description. # # For queries like "cloud" that don't contain title or # location specific ontology, jobs with "cloud" keyword matches are returned # regardless of this flag's value. # - # Use {::Google::Cloud::Talent::V4::Company#keyword_searchable_job_custom_attributes Company.keyword_searchable_job_custom_attributes} if - # company-specific globally matched custom field/attribute string values are - # needed. Enabling keyword match improves recall of subsequent search + # Use + # {::Google::Cloud::Talent::V4::Company#keyword_searchable_job_custom_attributes Company.keyword_searchable_job_custom_attributes} + # if company-specific globally matched custom field/attribute string values + # are needed. Enabling keyword match improves recall of subsequent search # requests. # # Defaults to false. # @param keyword_match_mode [::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode] # Controls what keyword match options to use. If both keyword_match_mode and # disable_keyword_match are set, keyword_match_mode will take precedence. # - # Defaults to {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} if no value - # is specified. + # Defaults to + # {::Google::Cloud::Talent::V4::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} + # if no value is specified. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Talent::V4::SearchJobsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] #