lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb in google-cloud-talent-0.3.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb in google-cloud-talent-0.4.0

- old
+ new

@@ -20,35 +20,29 @@ # Input only. # # Create job request. # @!attribute [rw] parent # @return [String] - # Required. + # Required. The resource name of the tenant under which the job is created. # - # The resource name of the tenant under which the job is created. - # # The format is "projects/{project_id}/tenants/{tenant_id}", for example, # "projects/api-test-project/tenant/foo". # # Tenant id is optional and a default tenant is created if unspecified, for # example, "projects/api-test-project". # @!attribute [rw] job # @return [Google::Cloud::Talent::V4beta1::Job] - # Required. - # - # The Job to be created. + # Required. The Job to be created. class CreateJobRequest; end # Input only. # # Get job request. # @!attribute [rw] name # @return [String] - # Required. + # Required. The resource name of the job to retrieve. # - # The resource name of the job to retrieve. - # # The format is # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for # example, "projects/api-test-project/tenants/foo/jobs/1234". # # Tenant id is optional and the default tenant is used if unspecified, for @@ -58,34 +52,32 @@ # Input only. # # Update job request. # @!attribute [rw] job # @return [Google::Cloud::Talent::V4beta1::Job] - # Required. - # - # The Job to be updated. + # Required. The Job to be updated. # @!attribute [rw] update_mask # @return [Google::Protobuf::FieldMask] # Optional but strongly recommended to be provided for the best service # experience. # - # If {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask update_mask} is provided, only the specified fields in - # {Google::Cloud::Talent::V4beta1::UpdateJobRequest#job job} are updated. Otherwise all the fields are updated. + # If {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask update_mask} + # is provided, only the specified fields in + # {Google::Cloud::Talent::V4beta1::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::V4beta1::Job Job} are supported. class UpdateJobRequest; end # Input only. # # Delete job request. # @!attribute [rw] name # @return [String] - # Required. + # Required. The resource name of the job to be deleted. # - # The resource name of the job to be deleted. - # # The format is # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for # example, "projects/api-test-project/tenants/foo/jobs/1234". # # Tenant id is optional and the default tenant is used if unspecified, for @@ -95,25 +87,21 @@ # Input only. # # Batch delete jobs request. # @!attribute [rw] parent # @return [String] - # Required. + # Required. The resource name of the tenant under which the job is created. # - # The resource name of the tenant under which the job is created. - # # The format is "projects/{project_id}/tenants/{tenant_id}", for example, # "projects/api-test-project/tenant/foo". # # Tenant id is optional and the default tenant is used if unspecified, for # example, "projects/api-test-project". # @!attribute [rw] filter # @return [String] - # Required. + # Required. The filter string specifies the jobs to be deleted. # - # The filter string specifies the jobs to be deleted. - # # Supported operator: =, AND # # The fields eligible for filtering are: # # * `companyName` (Required) @@ -126,25 +114,21 @@ # Input only. # # List jobs request. # @!attribute [rw] parent # @return [String] - # Required. + # Required. The resource name of the tenant under which the job is created. # - # The resource name of the tenant under which the job is created. - # # The format is "projects/{project_id}/tenants/{tenant_id}", for example, # "projects/api-test-project/tenant/foo". # # Tenant id is optional and the default tenant is used if unspecified, for # example, "projects/api-test-project". # @!attribute [rw] filter # @return [String] - # Required. + # Required. The filter string specifies the jobs to be enumerated. # - # The filter string specifies the jobs to be enumerated. - # # Supported operator: =, AND # # The fields eligible for filtering are: # # * `companyName` (Required) @@ -159,30 +143,28 @@ # requisitionId = "req-1" # * companyName = "projects/api-test-project/tenants/foo/companies/bar" AND # status = "EXPIRED" # @!attribute [rw] page_token # @return [String] - # Optional. - # - # The starting point of a query result. + # Optional. The starting point of a query result. # @!attribute [rw] page_size # @return [Integer] - # Optional. + # Optional. The maximum number of jobs to be returned per page of results. # - # The maximum number of jobs to be returned per page of results. + # If {Google::Cloud::Talent::V4beta1::ListJobsRequest#job_view job_view} is set + # to + # {Google::Cloud::Talent::V4beta1::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::V4beta1::ListJobsRequest#job_view job_view} is set to {Google::Cloud::Talent::V4beta1::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. # @!attribute [rw] job_view # @return [Google::Cloud::Talent::V4beta1::JobView] - # Optional. - # - # The desired job attributes returned for jobs in the - # search response. Defaults to {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_FULL JobView::JOB_VIEW_FULL} if no value is - # specified. + # Optional. The desired job attributes returned for jobs in the + # search response. Defaults to + # {Google::Cloud::Talent::V4beta1::JobView::JOB_VIEW_FULL JobView::JOB_VIEW_FULL} + # if no value is specified. class ListJobsRequest; end # Output only. # # List jobs response. @@ -204,66 +186,55 @@ # Input only. # # The Request body of the `SearchJobs` call. # @!attribute [rw] parent # @return [String] - # Required. + # Required. The resource name of the tenant to search within. # - # The resource name of the tenant to search within. - # # The format is "projects/{project_id}/tenants/{tenant_id}", for example, # "projects/api-test-project/tenant/foo". # # Tenant id is optional and the default tenant is used if unspecified, for # example, "projects/api-test-project". # @!attribute [rw] search_mode # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode] - # Optional. + # Optional. Mode of a search. # - # Mode of a search. - # - # Defaults to {Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode::JOB_SEARCH}. + # Defaults to + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode::JOB_SEARCH SearchMode::JOB_SEARCH}. # @!attribute [rw] request_metadata # @return [Google::Cloud::Talent::V4beta1::RequestMetadata] - # 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. # @!attribute [rw] job_query # @return [Google::Cloud::Talent::V4beta1::JobQuery] - # Optional. - # - # Query used to search against jobs, such as keyword, location filters, etc. + # Optional. Query used to search against jobs, such as keyword, location + # filters, etc. # @!attribute [rw] enable_broadening # @return [true, false] - # Optional. + # Optional. Controls whether to broaden the search when it produces sparse + # results. Broadened queries append results to the end of the matching + # results list. # - # 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. # @!attribute [rw] require_precise_result_size # @return [true, false] - # Optional. - # - # Controls if the search job request requires the return of a precise - # count of the first 300 results. Setting this to `true` ensures + # 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. # @!attribute [rw] histogram_queries # @return [Array<Google::Cloud::Talent::V4beta1::HistogramQuery>] - # Optional. + # Optional. An expression specifies a histogram request against matching + # jobs. # - # An expression specifies a histogram request against matching jobs. - # # Expression syntax is an aggregation function call with histogram facets and # other options. # # Available aggregation function calls are: # * `count(string_histogram_facet)`: Count the number of matching entities, @@ -290,23 +261,34 @@ # 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_id: histogram by {Job#distributor_company_id}. - # * 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, + # * 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_month: histogram by the {Job#publish_time} in months. + # * company_size: histogram by + # {Google::Cloud::Talent::V4beta1::CompanySize CompanySize}, for example, + # "SMALL", "MEDIUM", "BIG". + # * 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 {Job#publish_time} in years. + # * publish_time_in_year: histogram by the + # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time Job#posting_publish_time} + # in years. # Must specify list of numeric buckets in spec. - # * degree_type: histogram by the {Job#degree_type}, for example, + # * degree_types: histogram by the + # {Google::Cloud::Talent::V4beta1::Job#degree_types Job#degree_types}, for + # example, # "Bachelors", "Masters". - # * job_level: histogram by the {Google::Cloud::Talent::V4beta1::Job#job_level Job#job_level}, for example, "Entry + # * job_level: histogram by the + # {Google::Cloud::Talent::V4beta1::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, @@ -314,202 +296,213 @@ # * city: histogram by a combination of the "city name, admin1 code". For # example, "Mountain View, CA", "New York, NY". # * admin1_country: histogram by a combination of the "admin1 code, country", # 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::V4beta1::Job#language_code Job#language_code}, for example, "en-US", + # 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::V4beta1::Job#language_code Job#language_code}, for + # example, "en-US", # "fr-FR". - # * language: histogram by the language subtag of the {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}, + # * language: histogram by the language subtag of the + # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}, # for example, "en", "fr". - # * category: histogram by the {Google::Cloud::Talent::V4beta1::JobCategory JobCategory}, for example, + # * category: histogram by the + # {Google::Cloud::Talent::V4beta1::JobCategory JobCategory}, for example, # "COMPUTER_AND_IT", "HEALTHCARE". - # * base_compensation_unit: histogram by the {CompensationUnit} of base - # salary, for example, "WEEKLY", "MONTHLY". + # * base_compensation_unit: histogram by the + # {Google::Cloud::Talent::V4beta1::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::V4beta1::Job#custom_attributes Job#custom_attributes}. + # * string_custom_attribute: histogram by string + # {Google::Cloud::Talent::V4beta1::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::V4beta1::Job#custom_attributes Job#custom_attributes}. + # * numeric_custom_attribute: histogram by numeric + # {Google::Cloud::Talent::V4beta1::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: - # * 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"]) + # + # * `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"])` # @!attribute [rw] job_view # @return [Google::Cloud::Talent::V4beta1::JobView] - # Optional. - # - # The desired job attributes returned for jobs in the - # search response. Defaults to {JobView::SMALL} if no value is specified. + # Optional. 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 # @return [Integer] - # Optional. + # 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 + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#page_token page_token} is + # unset. # - # 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::V4beta1::SearchJobsRequest#page_token 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). # @!attribute [rw] page_size # @return [Integer] - # Optional. - # - # A limit on the number of jobs returned in the search results. + # 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. # @!attribute [rw] page_token # @return [String] - # Optional. - # - # The token specifying the current offset within - # search results. See {Google::Cloud::Talent::V4beta1::SearchJobsResponse#next_page_token SearchJobsResponse#next_page_token} for - # an explanation of how to obtain the next set of query results. + # Optional. The token specifying the current offset within + # search results. See + # {Google::Cloud::Talent::V4beta1::SearchJobsResponse#next_page_token SearchJobsResponse#next_page_token} + # for an explanation of how to obtain the next set of query results. # @!attribute [rw] order_by # @return [String] - # Optional. + # Optional. The criteria determining how search results are sorted. Default + # is + # `"relevance desc"`. # - # 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 + # * `"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::V4beta1::Job#posting_publish_time Job#posting_publish_time} + # * `"posting_publish_time desc"`: By + # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time Job#posting_publish_time} # descending. - # * "posting`_`update`_`time desc": By {Google::Cloud::Talent::V4beta1::Job#posting_update_time Job#posting_update_time} + # * `"posting_update_time desc"`: By + # {Google::Cloud::Talent::V4beta1::Job#posting_update_time Job#posting_update_time} # descending. - # * "title": By {Google::Cloud::Talent::V4beta1::Job#title Job#title} ascending. - # * "title desc": By {Google::Cloud::Talent::V4beta1::Job#title Job#title} descending. - # * "annualized`_`base`_`compensation": By job's - # {Google::Cloud::Talent::V4beta1::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::V4beta1::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::V4beta1::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::V4beta1::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 - # {SearchJobsRequest#custom_ranking_info#ranking_expression} with weight - # factor assigned by - # {SearchJobsRequest#custom_ranking_info#importance_level} in descending - # order. - # * "location`_`distance": By the distance between the location on jobs and - # locations specified in the - # {SearchJobsRequest#job_query#location_filters}. - # When this order is selected, the - # {SearchJobsRequest#job_query#location_filters} must not be empty. When - # a job has multiple locations, the location closest to one of the locations - # specified in the location filter will be used to calculate location - # distance. Distance is calculated by the distance between two lat/long - # coordinates, with a precision of 10e-4 degrees (11.3 meters). - # Jobs that don't have locations specified will be ranked below jobs having - # locations. - # Diversification strategy is still applied unless explicitly disabled in - # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#diversification_level SearchJobsRequest#diversification_level}. + # * `"title"`: By {Google::Cloud::Talent::V4beta1::Job#title Job#title} + # ascending. + # * `"title desc"`: By {Google::Cloud::Talent::V4beta1::Job#title Job#title} + # descending. + # * `"annualized_base_compensation"`: By job's + # {Google::Cloud::Talent::V4beta1::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::V4beta1::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::V4beta1::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::V4beta1::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::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression SearchJobsRequest::CustomRankingInfo#ranking_expression} + # with weight factor assigned by + # {Google::Cloud::Talent::V4beta1::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> + # `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by + # multiple locations. See details below.<br> + # 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 + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#diversification_level diversification_level}. # @!attribute [rw] diversification_level # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel] - # Optional. - # - # Controls whether highly similar jobs are returned next to each other in - # the search results. Jobs are identified as highly similar based on + # 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 {Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel::SIMPLE} if no value - # is specified. + # Defaults to + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel::SIMPLE DiversificationLevel::SIMPLE} + # if no value is specified. # @!attribute [rw] custom_ranking_info # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo] - # Optional. - # - # Controls over how job documents get ranked on top of existing relevance - # score (determined by API algorithm). + # Optional. Controls over how job documents get ranked on top of existing + # relevance score (determined by API algorithm). # @!attribute [rw] disable_keyword_match # @return [true, false] - # Optional. + # Optional. 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," 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 {Job#job_title}, - # {Google::Cloud::Talent::V4beta1::Job#description Job#description}, {Google::Cloud::Talent::V4beta1::Job#company_display_name Job#company_display_name}, [Job.locations][0], - # {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," - # 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. # - # 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. + # 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. # # Defaults to false. class SearchJobsRequest # Input only. # - # Custom ranking information for {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}. + # Custom ranking information for + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}. # @!attribute [rw] importance_level # @return [Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo::ImportanceLevel] - # Required. + # Required. Controls over how important the score of + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression} + # gets applied to job's final ranking position. # - # Controls over how important the score of - # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression} gets applied to job's final - # ranking position. - # # An error is thrown if not specified. # @!attribute [rw] ranking_expression # @return [String] - # Required. + # Required. Controls over how job documents get ranked on top of existing + # relevance score (determined by API algorithm). The product of ranking + # expression and relevance score is used to determine job's final ranking + # position. # - # Controls over how job documents get ranked on top of existing relevance - # score (determined by API algorithm). The product of ranking expression - # and relevance score is used to determine job's final ranking position. - # # The syntax for this expression is a subset of Google SQL syntax. # # 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. + # 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. # # Sample ranking expression # (year + 25) * 0.25 - (freshness / 0.5) class CustomRankingInfo - # The importance level for {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression}. + # The importance level for + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo#ranking_expression CustomRankingInfo#ranking_expression}. module ImportanceLevel # Default value if the importance level isn't specified. IMPORTANCE_LEVEL_UNSPECIFIED = 0 # The given ranking expression is of None importance, existing relevance @@ -587,11 +580,12 @@ # Output only. # # Response for SearchJob method. # @!attribute [rw] matching_jobs # @return [Array<Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob>] - # The Job entities that match the specified {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}. + # The Job entities that match the specified + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest SearchJobsRequest}. # @!attribute [rw] histogram_query_results # @return [Array<Google::Cloud::Talent::V4beta1::HistogramQueryResult>] # The histogram results that match with specified # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#histogram_queries SearchJobsRequest#histogram_queries}. # @!attribute [rw] next_page_token @@ -599,23 +593,27 @@ # The token that specifies the starting position of the next page of results. # This field is empty if there are no more results. # @!attribute [rw] location_filters # @return [Array<Google::Cloud::Talent::V4beta1::Location>] # The location filters that the service applied to the specified query. If - # any filters are lat-lng based, the {JobLocation#location_type} is - # {JobLocation::LocationType#LOCATION_TYPE_UNSPECIFIED}. + # any filters are lat-lng based, the + # {Google::Cloud::Talent::V4beta1::Location#location_type Location#location_type} + # is + # {Google::Cloud::Talent::V4beta1::Location::LocationType::LOCATION_TYPE_UNSPECIFIED Location::LocationType::LOCATION_TYPE_UNSPECIFIED}. # @!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 {Enable_precise_result_size}. + # see + # {Google::Cloud::Talent::V4beta1::SearchJobsRequest#require_precise_result_size SearchJobsRequest#require_precise_result_size}. # @!attribute [rw] total_size # @return [Integer] # The precise result count, which is available only if the client set - # {Enable_precise_result_size} to `true`, or if the response - # is the last page of results. Otherwise, the value is `-1`. + # {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`. # @!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 @@ -631,29 +629,34 @@ # @return [Google::Cloud::Talent::V4beta1::SpellingCorrection] # The spell checking result, and correction. class SearchJobsResponse # Output only. # - # Job entry with metadata inside {Google::Cloud::Talent::V4beta1::SearchJobsResponse 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}. + # 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 {Job#job_title} field most - # closely matching a search query's keywords, if available. The matching - # query keywords are enclosed in HTML bold tags. + # 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. + # 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 @@ -671,29 +674,91 @@ # reachable within the requested duration, but was returned as part of an # expanded query. class CommuteInfo; end end + # Request to create a batch of jobs. + # @!attribute [rw] parent + # @return [String] + # Required. The resource name of the tenant under which the job is created. + # + # The format is "projects/{project_id}/tenants/{tenant_id}", for example, + # "projects/api-test-project/tenant/foo". + # + # Tenant id is optional and a default tenant is created if unspecified, for + # example, "projects/api-test-project". + # @!attribute [rw] jobs + # @return [Array<Google::Cloud::Talent::V4beta1::Job>] + # Required. The jobs to be created. + class BatchCreateJobsRequest; end + + # Request to update a batch of jobs. + # @!attribute [rw] parent + # @return [String] + # Required. The resource name of the tenant under which the job is created. + # + # The format is "projects/{project_id}/tenants/{tenant_id}", for example, + # "projects/api-test-project/tenant/foo". + # + # Tenant id is optional and the default tenant is used if unspecified, for + # example, "projects/api-test-project". + # @!attribute [rw] jobs + # @return [Array<Google::Cloud::Talent::V4beta1::Job>] + # Required. The jobs to be updated. + # @!attribute [rw] update_mask + # @return [Google::Protobuf::FieldMask] + # Optional but strongly recommended to be provided for the best service + # experience, also increase latency when checking status of batch operation. + # + # If + # {Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest#update_mask update_mask} + # is provided, only the specified fields in + # {Google::Cloud::Talent::V4beta1::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::V4beta1::Job Job} are supported. + # + # If + # {Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest#update_mask update_mask} + # is provided, The {Google::Cloud::Talent::V4beta1::Job Job} inside + # {JobResult} will only contains fields that is updated, plus the Id of the + # Job. Otherwise, {Google::Cloud::Talent::V4beta1::Job Job} will include all + # fields, which can yield a very large response. + class BatchUpdateJobsRequest; end + # An enum that specifies the job attributes that are returned in the - # {MatchingJob::Job} in {Google::Cloud::Talent::V4beta1::SearchJobsResponse SearchJobsResponse} or {Google::Cloud::Talent::V4beta1::Job Job} objects in - # {Google::Cloud::Talent::V4beta1::ListJobsResponse ListJobsResponse}. + # {Google::Cloud::Talent::V4beta1::SearchJobsResponse::MatchingJob#job MatchingJob#job} + # or {Google::Cloud::Talent::V4beta1::ListJobsResponse#jobs ListJobsResponse#jobs} + # fields. module JobView # Default value. JOB_VIEW_UNSPECIFIED = 0 # A ID only view of job, with following attributes: - # {Google::Cloud::Talent::V4beta1::Job#name Job#name}, {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}. + # {Google::Cloud::Talent::V4beta1::Job#name Job#name}, + # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, + # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}. JOB_VIEW_ID_ONLY = 1 # A minimal view of the job, with the following attributes: - # {Google::Cloud::Talent::V4beta1::Job#name Job#name}, {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, {Job#job_title}, - # {Google::Cloud::Talent::V4beta1::Job#company Job#company}, {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations}, {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}. + # {Google::Cloud::Talent::V4beta1::Job#name Job#name}, + # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, + # {Google::Cloud::Talent::V4beta1::Job#title Job#title}, + # {Google::Cloud::Talent::V4beta1::Job#company Job#company}, + # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations}, + # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}. JOB_VIEW_MINIMAL = 2 # A small view of the job, with the following attributes in the search - # results: {Google::Cloud::Talent::V4beta1::Job#name Job#name}, {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, {Job#job_title}, - # {Google::Cloud::Talent::V4beta1::Job#company Job#company}, {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations}, {Google::Cloud::Talent::V4beta1::Job#visibility Job#visibility}, - # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}, {Google::Cloud::Talent::V4beta1::Job#description Job#description}. + # results: {Google::Cloud::Talent::V4beta1::Job#name Job#name}, + # {Google::Cloud::Talent::V4beta1::Job#requisition_id Job#requisition_id}, + # {Google::Cloud::Talent::V4beta1::Job#title Job#title}, + # {Google::Cloud::Talent::V4beta1::Job#company Job#company}, + # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations Job::DerivedInfo#locations}, + # {Google::Cloud::Talent::V4beta1::Job#visibility Job#visibility}, + # {Google::Cloud::Talent::V4beta1::Job#language_code Job#language_code}, + # {Google::Cloud::Talent::V4beta1::Job#description Job#description}. JOB_VIEW_SMALL = 3 # All available attributes are included in the search results. JOB_VIEW_FULL = 4 end \ No newline at end of file