proto_docs/google/cloud/talent/v4beta1/job_service.rb in google-cloud-talent-v4beta1-0.4.6 vs proto_docs/google/cloud/talent/v4beta1/job_service.rb in google-cloud-talent-v4beta1-0.5.0

- old
+ new

@@ -127,22 +127,27 @@ # # Supported operator: =, AND # # The fields eligible for filtering are: # - # * `companyName` (Required) + # * `companyName` # * `requisitionId` # * `status` Available values: OPEN, EXPIRED, ALL. Defaults to # OPEN if no value is specified. # + # At least one of `companyName` and `requisitionId` must present or an + # INVALID_ARGUMENT error is thrown. + # # Sample Query: # # * companyName = "projects/foo/tenants/bar/companies/baz" # * companyName = "projects/foo/tenants/bar/companies/baz" AND # requisitionId = "req-1" # * companyName = "projects/foo/tenants/bar/companies/baz" AND # status = "EXPIRED" + # * requisitionId = "req-1" + # * requisitionId = "req-1" AND status = "EXPIRED" # @!attribute [rw] page_token # @return [::String] # The starting point of a query result. # @!attribute [rw] page_size # @return [::Integer] @@ -209,19 +214,11 @@ # list. # # Defaults to false. # @!attribute [rw] require_precise_result_size # @return [::Boolean] - # 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. + # This field is deprecated. # @!attribute [rw] histogram_queries # @return [::Array<::Google::Cloud::Talent::V4beta1::HistogramQuery>] # An expression specifies a histogram request against matching jobs. # # Expression syntax is an aggregation function call with histogram facets and @@ -231,10 +228,12 @@ # * `count(string_histogram_facet)`: Count the number of matching entities, # for each distinct attribute value. # * `count(numeric_histogram_facet, list of buckets)`: Count the number of # matching entities within each bucket. # + # A maximum of 200 histogram buckets are supported. + # # Data types: # # * Histogram facet: facet names with format `[a-zA-Z][a-zA-Z0-9_]+`. # * String: string like "any string with backslash escape for quote(\")." # * Number: whole number and floating point number like 10, -1 and -0.01. @@ -257,10 +256,13 @@ # * company_display_name: histogram by {::Google::Cloud::Talent::V4beta1::Job#company_display_name Job.company_display_name}. # * employment_type: histogram by {::Google::Cloud::Talent::V4beta1::Job#employment_types Job.employment_types}, for example, # "FULL_TIME", "PART_TIME". # * company_size: histogram by {::Google::Cloud::Talent::V4beta1::CompanySize CompanySize}, for example, "SMALL", # "MEDIUM", "BIG". + # * publish_time_in_day: histogram by the {::Google::Cloud::Talent::V4beta1::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::V4beta1::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::V4beta1::Job#posting_publish_time Job.posting_publish_time} # in years. @@ -310,11 +312,11 @@ # * `count(admin1)` # * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), # bucket(100000, MAX)])` # * `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"])` + # [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])` # @!attribute [rw] job_view # @return [::Google::Cloud::Talent::V4beta1::JobView] # The desired job attributes returned for jobs in the search response. # Defaults to {::Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_SMALL JobView.JOB_VIEW_SMALL} if no value is specified. # @!attribute [rw] offset @@ -406,10 +408,18 @@ # @return [::Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo] # Controls over how job documents get ranked on top of existing relevance # score (determined by API algorithm). # @!attribute [rw] disable_keyword_match # @return [::Boolean] + # This field is deprecated. Please use + # {::Google::Cloud::Talent::V4beta1::SearchJobsRequest#keyword_match_mode SearchJobsRequest.keyword_match_mode} going forward. + # + # To migrate, disable_keyword_match set to false maps to + # {::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL}, and disable_keyword_match set to + # true maps to {::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_DISABLED KeywordMatchMode.KEYWORD_MATCH_DISABLED}. If + # {::Google::Cloud::Talent::V4beta1::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::V4beta1::Job#title Job.title}, # {::Google::Cloud::Talent::V4beta1::Job#description Job.description}, {::Google::Cloud::Talent::V4beta1::Job#company_display_name Job.company_display_name}, {::Google::Cloud::Talent::V4beta1::Job#addresses Job.addresses}, # {::Google::Cloud::Talent::V4beta1::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," @@ -425,10 +435,16 @@ # company-specific globally matched custom field/attribute string values are # needed. Enabling keyword match improves recall of subsequent search # requests. # # Defaults to false. + # @!attribute [rw] keyword_match_mode + # @return [::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode] + # Controls what keyword match options to use. + # + # Defaults to {::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} if no value + # is specified. class SearchJobsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Custom ranking information for {::Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}. @@ -451,11 +467,11 @@ # Supported operators are: +, -, *, /, where the left and right side of # the operator is either a numeric {::Google::Cloud::Talent::V4beta1::Job#custom_attributes Job.custom_attributes} key, # integer/double value or an expression that can be evaluated to a number. # # Parenthesis are supported to adjust calculation precedence. The - # expression must be < 100 characters in length. + # expression must be < 200 characters in length. # # The expression is considered invalid for a job if the expression # references custom attributes that are not populated on the job or if the # expression results in a divide by zero. If an expression is invalid for a # job, that job is demoted to the end of the results. @@ -543,10 +559,44 @@ # latency might be lower but we can't guarantee that all results are # returned. If you are using page offset, latency might be higher but all # results are returned. SIMPLE = 2 end + + # Controls what keyword matching behavior the search has. When keyword + # matching is enabled, a keyword match returns jobs that may not match given + # category filters when there are matching keywords. For example, for the + # query "program manager" with KeywordMatchMode set to KEYWORD_MATCH_ALL, a + # job posting with the title "software developer," which doesn't fall into + # "program manager" ontology, and "program manager" appearing in its + # description will be surfaced. + # + # For queries like "cloud" that don't contain title or + # location specific ontology, jobs with "cloud" keyword matches are returned + # regardless of this enum's value. + # + # Use {::Google::Cloud::Talent::V4beta1::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. + module KeywordMatchMode + # The keyword match option isn't specified. Defaults to + # {::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode::KEYWORD_MATCH_ALL KeywordMatchMode.KEYWORD_MATCH_ALL} behavior. + KEYWORD_MATCH_MODE_UNSPECIFIED = 0 + + # Disables keyword matching. + KEYWORD_MATCH_DISABLED = 1 + + # Enable keyword matching over {::Google::Cloud::Talent::V4beta1::Job#title Job.title}, + # {::Google::Cloud::Talent::V4beta1::Job#description Job.description}, {::Google::Cloud::Talent::V4beta1::Job#company_display_name Job.company_display_name}, {::Google::Cloud::Talent::V4beta1::Job#addresses Job.addresses}, + # {::Google::Cloud::Talent::V4beta1::Job#qualifications Job.qualifications}, and keyword searchable {::Google::Cloud::Talent::V4beta1::Job#custom_attributes Job.custom_attributes} + # fields. + KEYWORD_MATCH_ALL = 2 + + # Only enable keyword matching over {::Google::Cloud::Talent::V4beta1::Job#title Job.title}. + KEYWORD_MATCH_TITLE_ONLY = 3 + end end # Response for SearchJob method. # @!attribute [rw] matching_jobs # @return [::Array<::Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob>] @@ -567,15 +617,13 @@ # @!attribute [rw] estimated_total_size # @return [::Integer] # An estimation of the number of jobs that match the specified query. # # This number isn't guaranteed to be accurate. For accurate results, - # see {::Google::Cloud::Talent::V4beta1::SearchJobsRequest#require_precise_result_size SearchJobsRequest.require_precise_result_size}. + # see {::Google::Cloud::Talent::V4beta1::SearchJobsResponse#total_size SearchJobsResponse.total_size}. # @!attribute [rw] total_size # @return [::Integer] - # The precise result count, which is available only if the client set - # {::Google::Cloud::Talent::V4beta1::SearchJobsRequest#require_precise_result_size SearchJobsRequest.require_precise_result_size} to `true`, or if the - # response is the last page of results. Otherwise, the value is `-1`. + # The precise result count with limit 100,000. # @!attribute [rw] metadata # @return [::Google::Cloud::Talent::V4beta1::ResponseMetadata] # Additional information for the API invocation, such as the request # tracking id. # @!attribute [rw] broadened_query_jobs_count