build: library of v4 jobs onboarded to SAM

Google APIs · copybara-github · commit 6ff6b4939749 · 2022-06-28T11:43:09.000-07:00
PiperOrigin-RevId: 457783072
diff --git a/google/cloud/talent/v4/common.proto b/google/cloud/talent/v4/common.proto
@@ -551,13 +551,22 @@ message RequestMetadata {
   // The type of device used by the job seeker at the time of the call to the
   // service.
   DeviceInfo device_info = 5;
+
+  // Delegated user information only used for internal purpose.
+  DelegatedUserInfo delegated_user_info = 6;
+
+  // Enables debugging mode and controls various debug parameters in the search
+  // process. Internal only.
+  DebugOptions debug_options = 7;
 }
 
 // Additional information returned to client, such as debugging information.
 message ResponseMetadata {
   // A unique id associated with this call.
   // This id is logged for tracking purposes.
   string request_id = 1;
+
+  DebugInfo debug_info = 2;
 }
 
 // Device information collected from the job seeker, candidate, or
@@ -811,6 +820,70 @@ message CompensationInfo {
   CompensationRange annualized_total_compensation_range = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
+// Delegated partner information where for admin or debug purpose, our
+// internal source needs to act as a partner to do READ_ONLY operations (for
+// example, SearchJobs).
+message DelegatedUserInfo {
+  // The GCP project number of the customer that the caller is acting on
+  // behalf of.
+  //
+  // If both project number and distributor id are provided,
+  // distributor id has the higher priority.
+  int64 project_number = 1;
+
+  // The pretended distributor id.
+  //
+  // If both project number and distributor id are provided,
+  // distributor id has the higher priority.
+  string distributor_id = 2;
+
+  // The pretended tenant id.
+  string tenant_id = 3;
+}
+
+// Various debug options available for debugging mode. Internal only.
+message DebugOptions {
+  // Specifies the level of debug output. The higher the number, the more
+  // debug information is returned and printed in backend server logs.
+  // Current levels are 1-4.
+  int32 level = 1;
+
+  // Specifies which search backend to use. Current available options are:
+  // st-bti, model-t, and st-muppet.
+  string searcher = 2;
+
+  // Specifies the scoring parameters to override during search. This is
+  // equivalent to the 'dsp' url parameter in the legacy system. For details,
+  // consult go/gjobs-scoring-params.
+  string scoring_parameter_override = 3;
+
+  // Overrides the ST sorting/scoring expression.
+  string st_expression_override = 4;
+
+  // Search documents of all tenants (only implemented for job search as of
+  // 6/14/2019).
+  google.protobuf.BoolValue search_all_tenant = 5;
+
+  // Temporarily added this flag for profile wildcard search
+  // Flag to indicate whether wildcard search is enabled
+  google.protobuf.BoolValue enable_wildcard_search = 6;
+}
+
+// Debug information.
+message DebugInfo {
+  string query_debug_info = 1;
+
+  string moonshine_debug_info = 2;
+
+  // Identifiers for the versions of the search algorithm used during
+  // this API invocation if multiple algorithms are used.
+  // The default value is empty.
+  repeated int32 experiment_ids = 3;
+
+  // The model id for profiles recommendation.
+  string recommend_model_id = 4;
+}
+
 // Metadata used for long running operations returned by CTS batch APIs.
 // It's used to replace [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].
 message BatchOperationMetadata {
diff --git a/google/cloud/talent/v4/job.proto b/google/cloud/talent/v4/job.proto
@@ -68,6 +68,19 @@ message Job {
     // order.
     repeated Location locations = 1;
 
+    // Structured street locations of the job.
+    //
+    // Unlike [locations][google.cloud.talent.v4.Job.DerivedInfo.locations], [street_locations][google.cloud.talent.v4.Job.DerivedInfo.street_locations] contains street locations
+    // inferred from job posting details, e.g. [Job.addresses][google.cloud.talent.v4.Job.addresses],
+    // [Job.company_display_name][google.cloud.talent.v4.Job.company_display_name], and so on.
+    //
+    // Note that the inference of [street_locations][google.cloud.talent.v4.Job.DerivedInfo.street_locations] isn't guaranteed to
+    // be 100% correct.
+    //
+    // [street_locations][google.cloud.talent.v4.Job.DerivedInfo.street_locations] are exactly matched to [Job.addresses][google.cloud.talent.v4.Job.addresses] in the same
+    // order.
+    repeated Location street_locations = 2;
+
     // Job categories derived from [Job.title][google.cloud.talent.v4.Job.title] and [Job.description][google.cloud.talent.v4.Job.description].
     repeated JobCategory job_categories = 3;
   }
@@ -93,6 +106,58 @@ message Job {
     HtmlSanitization html_sanitization = 2;
   }
 
+  // Debugging information for internal users.
+  message JobDebugInfo {
+    enum JobStatus {
+      JOB_DEBUG_INFO_UNSPECIFIED = 0;
+
+      EXPIRED = 1;
+
+      OPEN = 2;
+
+      DELETED = 3;
+    }
+
+    // A belief that a job has particular soc with some probability.
+    message SocBelief {
+      string soc_code = 1;
+
+      double probability = 2;
+
+      int32 svp = 3;
+    }
+
+    // Job Status.
+    JobStatus status = 1;
+
+    // Soc Beliefs.
+    repeated SocBelief soc_beliefs = 2;
+
+    // project id.
+    string project_id = 3;
+
+    // distributor id
+    string distributor_id = 4;
+
+    // tenant id.
+    string tenant_id = 5;
+
+    // project number
+    int64 project_number = 6;
+
+    // Job Classifications
+    repeated string job_classifications = 7;
+
+    // Seniority
+    string seniority = 8;
+
+    // Confidence Scores
+    repeated double confidence_scores = 9;
+
+    // Last Update TIme
+    google.protobuf.Timestamp last_update_time = 10;
+  }
+
   // Required during job update.
   //
   // The resource name for the job. This is generated by the service when a
@@ -347,4 +412,7 @@ message Job {
 
   // Options for job processing.
   ProcessingOptions processing_options = 30;
+
+  // Debugging information for internal users.
+  JobDebugInfo job_debug_info = 58;
 }
diff --git a/google/cloud/talent/v4/job_service.proto b/google/cloud/talent/v4/job_service.proto
@@ -25,6 +25,7 @@ import "google/cloud/talent/v4/filters.proto";
 import "google/cloud/talent/v4/histogram.proto";
 import "google/cloud/talent/v4/job.proto";
 import "google/longrunning/operations.proto";
+import "google/protobuf/any.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
@@ -126,6 +127,24 @@ service JobService {
     };
   }
 
+  // Purges all jobs associated with requested target.
+  //
+  // Note: Jobs in OPEN status remain searchable until the operation completes.
+  //
+  // Note: The operation returned may take hours or longer to complete,
+  // depending on the number of jobs that need to be deleted.
+  rpc PurgeJobs(PurgeJobsRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v4/{parent=projects/*}/jobs:purge"
+      body: "*"
+    };
+    option (google.api.method_signature) = "parent,filter";
+    option (google.longrunning.operation_info) = {
+      response_type: "PurgeJobsResponse"
+      metadata_type: "BatchOperationMetadata"
+    };
+  }
+
   // Lists jobs by filter.
   rpc ListJobs(ListJobsRequest) returns (ListJobsResponse) {
     option (google.api.http) = {
@@ -710,6 +729,12 @@ message SearchJobsRequest {
   // score (determined by API algorithm).
   CustomRankingInfo custom_ranking_info = 14;
 
+  // Controls whether to add search debug information
+  // (sortExpr, partial expressions) into SearchResponse.
+  //
+  // Defaults to false.
+  bool enable_debug_info = 15;
+
   // This field is deprecated. Please use
   // [SearchJobsRequest.keyword_match_mode][google.cloud.talent.v4.SearchJobsRequest.keyword_match_mode] going forward.
   //
@@ -745,6 +770,10 @@ message SearchJobsRequest {
   // Defaults to [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL] if no value
   // is specified.
   KeywordMatchMode keyword_match_mode = 18;
+
+  // This field allows us to pass in a MendelDebugInput proto to force mendel
+  // experiment traffic in FORCEABLE experiments.
+  google.protobuf.Any mendel_debug_input = 17;
 }
 
 // Response for SearchJob method.
@@ -772,6 +801,8 @@ message SearchJobsResponse {
     // Commute information which is generated based on specified
     //  [CommuteFilter][google.cloud.talent.v4.CommuteFilter].
     CommuteInfo commute_info = 5;
+
+    string debug_info = 6;
   }
 
   // Commute details related to this job.
@@ -902,6 +933,39 @@ message BatchDeleteJobsRequest {
                              }];
 }
 
+// Request to purge a set of jobs.
+message PurgeJobsRequest {
+  // Required. The resource name of the project under which the jobs should be deleted.
+  //
+  // The format is "projects/{project_id}". For example, "projects/foo".
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "cloudresourcemanager.googleapis.com/Project"
+    }
+  ];
+
+  // Required. A filter matching the jobs to be purged.
+  //
+  // The filter can be one of the following three parent resources.
+  // 1. Company. Resource name of the company under which all the jobs should be
+  // deleted. The format is
+  // "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For
+  // example, "projects/foo/tenants/bar/companies/baz"
+  // 2. Tenant. Resource name of the tenant under which all the jobs should be
+  // deleted. The format is "projects/{project_id}/tenants/{tenant_id}". For
+  // example, "projects/foo/tenants/bar".
+  // 3. Project. Resource name of the project under which all the jobs should be
+  // deleted. The format is "projects/{project_id}". For example,
+  // "projects/foo/".
+  string filter = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Actually perform the purge.
+  // If `force` is set to false, the method will return a sample of
+  // resource names that will be deleted.
+  bool force = 3;
+}
+
 // Mutation result of a job from a batch operation.
 message JobResult {
   // Here [Job][google.cloud.talent.v4.Job] only contains basic information including [name][google.cloud.talent.v4.Job.name],
@@ -938,3 +1002,27 @@ message BatchDeleteJobsResponse {
   // until operation status is FINISHED, FAILED or CANCELLED.
   repeated JobResult job_results = 1;
 }
+
+// The result of [JobService.PurgeJobs][google.cloud.talent.v4.JobService.PurgeJobs]. It's used to
+// replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.
+message PurgeJobsResponse {
+  // The number of jobs that this request deleted (or, if `force` is false,
+  // the number of jobs that will be deleted).
+  //
+  // Note: This number isn't guaranteed to be accurate.
+  // Note: This number might change until operation status is FINISHED, FAILED
+  // or CANCELLED.
+  int32 purge_count = 1;
+
+  // A sample of the resource names of jobs that will be deleted.
+  // Only populated if `force` is set to false.
+  // At most 100 job names are returned as a sample.
+  repeated string purge_sample = 2;
+
+  // List of job purge results from a purge jobs operation.
+  // Only populated if `force` is set to true.
+  //
+  // Note: This may change until operation status is FINISHED, FAILED or
+  // CANCELLED.
+  repeated JobResult job_results = 3;
+}
diff --git a/google/cloud/talent/v4/jobs_v4.yaml b/google/cloud/talent/v4/jobs_v4.yaml
@@ -16,6 +16,7 @@ types:
 - name: google.cloud.talent.v4.BatchDeleteJobsResponse
 - name: google.cloud.talent.v4.BatchOperationMetadata
 - name: google.cloud.talent.v4.BatchUpdateJobsResponse
+- name: google.cloud.talent.v4.PurgeJobsResponse
 
 documentation:
   summary: |-
