diff --git a/google/cloud/talent/v4beta1/talent_gapic.yaml b/google/cloud/talent/v4beta1/talent_gapic.yaml index 93c70c78..f1552479 100644 --- a/google/cloud/talent/v4beta1/talent_gapic.yaml +++ b/google/cloud/talent/v4beta1/talent_gapic.yaml @@ -222,7 +222,7 @@ interfaces: field_name_patterns: parent: profile timeout_millis: 30000 - # The fully qualified name of the API interface. +# The fully qualified name of the API interface. - name: google.cloud.talent.v4beta1.CompanyService # Definition for retryable codes. retry_codes_def: @@ -298,6 +298,35 @@ interfaces: # the call is retrying, refer to retry_params_name instead. methods: - name: CreateCompany + samples: + standalone: + - value_sets: [job_search_create_company] + region_tag: job_search_create_company + sample_value_sets: + - id: job_search_create_company + description: Create Company + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - company.display_name="My Company Name" + - company.external_id="Identifier of this company in my system" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenant + - parameter: company.display_name + sample_argument_name: display_name + - parameter: company.external_id + sample_argument_name: external_id + on_success: + - print: ["Created Company"] + - print: ["Name: %s", $resp.name] + - print: ["Display Name: %s", $resp.display_name] + - print: ["External ID: %s", $resp.external_id] flattening: groups: - parameters: @@ -325,6 +354,28 @@ interfaces: field_name_patterns: name: company_oneof timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_get_company] + region_tag: job_search_get_company + sample_value_sets: + - id: job_search_get_company + description: Get Company + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID (using tenancy is optional)" + - name%company="Company ID" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + - parameter: name%company + sample_argument_name: company_id + on_success: + - print: ["Company name: %s", $resp.name] + - print: ["Display name: %s", $resp.display_name] - name: UpdateCompany flattening: groups: @@ -338,6 +389,27 @@ interfaces: company.name: company_oneof timeout_millis: 30000 - name: DeleteCompany + samples: + standalone: + - value_sets: [job_search_delete_company] + region_tag: job_search_delete_company + sample_value_sets: + - id: job_search_delete_company + description: Delete Company + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID (using tenancy is optional)" + - name%company="ID of the company to delete" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + - parameter: name%company + sample_argument_name: company_id + on_success: + - print: ["Deleted company"] flattening: groups: - parameters: @@ -351,6 +423,28 @@ interfaces: name: company_oneof timeout_millis: 30000 - name: ListCompanies + samples: + standalone: + - value_sets: [job_search_list_companies] + region_tag: job_search_list_companies + sample_value_sets: + - id: job_search_list_companies + description: List Companies + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenant + on_success: + - print: ["Company Name: %s", $resp.name] + - print: ["Display Name: %s", $resp.display_name] + - print: ["External ID: %s", $resp.external_id] flattening: groups: - parameters: @@ -370,7 +464,7 @@ interfaces: field_name_patterns: parent: tenant_or_project timeout_millis: 30000 - # The fully qualified name of the API interface. +# The fully qualified name of the API interface. - name: google.cloud.talent.v4beta1.Completion # Definition for retryable codes. retry_codes_def: @@ -457,7 +551,43 @@ interfaces: parent: tenant_or_project company: company_oneof timeout_millis: 30000 - # The fully qualified name of the API interface. + samples: + standalone: + - value_sets: [job_search_autocomplete_job_title] + region_tag: job_search_autocomplete_job_title + sample_value_sets: + - id: job_search_autocomplete_job_title + description: Complete job title given partial text (autocomplete) + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - query="[partially typed job title]" + - page_size=5 + - language_codes[0]="en-US" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenantd + - parameter: query + sample_argument_name: query + - parameter: page_size + sample_argument_name: num_results + - parameter: language_codes[0] + sample_argument_name: language_code + on_success: + - loop: + collection: $resp.completion_results + variable: result + body: + - print: ["Suggested title: %s", result.suggestion] + - comment: ["Suggestion type is JOB_TITLE or COMPANY_TITLE"] + - print: ["Suggestion type: %s", result.type] + +# The fully qualified name of the API interface. - name: google.cloud.talent.v4beta1.EventService # Definition for retryable codes. retry_codes_def: @@ -547,7 +677,52 @@ interfaces: field_name_patterns: parent: tenant_or_project timeout_millis: 30000 - # The fully qualified name of the API interface. + samples: + standalone: + - value_sets: [job_search_create_client_event] + region_tag: job_search_create_client_event + sample_value_sets: + - id: job_search_create_client_event + description: Creates a client event + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - client_event.request_id="[request_id from ResponseMetadata]" + - client_event.event_id="[Set this to a unique identifier]" + # https://github.com/googleapis/gapic-generator/issues/2762 + # - client_event.create_time="1972-01-01T10:00:20.021Z" + - client_event.create_time.seconds=0 + - client_event.job_event.type=VIEW + - client_event.job_event.jobs[0]="projects/[Project ID]/tenants/[Tenant ID]/jobs/[Job ID]" + - client_event.job_event.jobs[1]="projects/[Project ID]/tenants/[Tenant ID]/jobs/[Job ID]" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenant + - parameter: client_event.request_id + sample_argument_name: request_id + description: | + A unique ID generated in the API responses. + Value should be set to the request_id from an API response. + - parameter: client_event.event_id + sample_argument_name: event_id + description: A unique identifier, generated by the client application + - parameter: client_event.create_time.seconds + description: | + The timestamp of the event as seconds of UTC time since Unix epoch + For more information on how to create google.protobuf.Timestamps + See: https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto + - parameter: client_event.job_event.type + description: The type of event attributed to the behavior of the end user + - parameter: client_event.job_event.jobs[0] + description: List of job names associated with this event + on_success: + - print: ["Created client event"] +# The fully qualified name of the API interface. - name: google.cloud.talent.v4beta1.JobService # Definition for retryable codes. retry_codes_def: @@ -638,6 +813,88 @@ interfaces: parent: tenant_or_project job.company: company_oneof timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_create_job] + region_tag: job_search_create_job + - value_sets: [job_search_create_job_custom_attributes] + region_tag: job_search_create_job_custom_attributes + sample_value_sets: + - id: job_search_create_job + description: Create Job + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + ## # Currently cannot generate code which uses the helper methods to generate + ## # the company name using the projectId and companyId. Instead the user + ## # has to provide the full projects/X/companies/Y string path. + ## # See: https://github.com/googleapis/gapic-generator/issues/2621 + # - job.company.project%project="Your Google Cloud Project ID" + # - job.company.company%company="Company ID" + - job.company="Company name, e.g. projects/your-project/companies/company-id" + ## + - job.requisition_id="Job requisition ID, aka Posting ID. Unique per job." + - job.title="Software Engineer" + - job.description="This is a description of this wonderful job!" + - job.application_info.uris[0]="https://www.example.org/job-posting/123" + - job.addresses[0]="1600 Amphitheatre Parkway, Mountain View, CA 94043" + - job.addresses[1]="111 8th Avenue, New York, NY 10011" + - job.language_code="en-US" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenant + - parameter: job.company + sample_argument_name: company_name + - parameter: job.requisition_id + sample_argument_name: requisition_id + - parameter: job.title + sample_argument_name: title + - parameter: job.description + sample_argument_name: description + - parameter: job.application_info.uris[0] + sample_argument_name: job_application_url + - parameter: job.addresses[0] + sample_argument_name: address_one + - parameter: job.addresses[1] + sample_argument_name: address_two + - parameter: job.language_code + sample_argument_name: language_code + on_success: + - print: + - "Created job: %s" + - $resp.name + - id: job_search_create_job_custom_attributes + description: Create Job with Custom Attributes + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - job.company="Company name, e.g. projects/your-project/companies/company-id" + - job.requisition_id="Job requisition ID, aka Posting ID. Unique per job." + - job.language_code="en-US" + # - custom_attributes["my_attribute"][0]="My attribute value" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenantd + - parameter: job.company + sample_argument_name: company_name + - parameter: job.requisition_id + sample_argument_name: requisition_id + - parameter: job.language_code + sample_argument_name: language_code + on_success: + - print: + - "Created job: %s" + - $resp.name - name: GetJob flattening: groups: @@ -651,6 +908,46 @@ interfaces: field_name_patterns: name: job_oneof timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_get_job] + region_tag: job_search_get_job + sample_value_sets: + - id: job_search_get_job + description: Get Job + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID (using tenancy is optional)" + - name%jobs="Job ID" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + - parameter: name%jobs + sample_argument_name: job_id + on_success: + - print: ["Job name: %s", $resp.name] + - print: ["Requisition ID: %s", $resp.requisition_id] + - print: ["Title: %s", $resp.title] + - print: ["Description: %s", $resp.description] + - print: ["Posting language: %s", $resp.language_code] + - loop: + collection: $resp.addresses + variable: address + body: + - print: ["Address: %s", address] + - loop: + collection: $resp.application_info.emails + variable: email + body: + - print: ["Email: %s", email] + - loop: + collection: $resp.application_info.uris + variable: website_uri + body: + - print: ["Website: %s", website_uri] - name: UpdateJob flattening: groups: @@ -677,7 +974,63 @@ interfaces: field_name_patterns: name: job_oneof timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_delete_job] + region_tag: job_search_delete_job + sample_value_sets: + - id: job_search_delete_job + description: Delete Job + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID (using tenancy is optional)" + - name%jobs="Company ID" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + - parameter: name%jobs + sample_argument_name: job_id + on_success: + - print: + - "Deleted job." - name: ListJobs + samples: + standalone: + - value_sets: [job_search_list_jobs] + region_tag: job_search_list_jobs + sample_value_sets: + - id: job_search_list_jobs + description: List Jobs + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - filter="companyName=projects/my-project/companies/company-id" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenant + - parameter: filter + sample_argument_name: filter + on_success: + - print: + - "Job name: %s" + - $resp.name + - print: + - "Job requisition ID: %s" + - $resp.requisition_id + - print: + - "Job title: %s" + - $resp.title + - print: + - "Job description: %s" + - $resp.description flattening: groups: - parameters: @@ -714,6 +1067,33 @@ interfaces: field_name_patterns: parent: tenant_or_project timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_batch_delete_job] + region_tag: job_search_batch_delete_job + sample_value_sets: + - id: job_search_batch_delete_job + description: Batch delete jobs using a filter + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - filter="[Query]" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenantd + - parameter: filter + sample_argument_name: filter + description: | + The filter string specifies the jobs to be deleted. + For example: + companyName = "projects/api-test-project/companies/123" AND equisitionId = "req-1" + on_success: + - print: ["Batch deleted jobs from filter"] - name: SearchJobs required_fields: - parent @@ -731,6 +1111,94 @@ interfaces: field_name_patterns: parent: tenant_or_project timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_custom_ranking_search] + region_tag: job_search_custom_ranking_search + - value_sets: [job_search_commute_search] + region_tag: job_search_commute_search + - value_sets: [job_search_histogram_search] + region_tag: job_search_histogram_search + sample_value_sets: + - id: job_search_custom_ranking_search + description: Search Jobs using custom rankings + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + # - job_query.company_names[0]="projects/[Project ID]/companies/[Company ID]" + - request_metadata.domain="www.example.com" + - request_metadata.session_id="Hashed session identifier" + - request_metadata.user_id="Hashed user identifier" + - custom_ranking_info.importance_level=EXTREME + - custom_ranking_info.ranking_expression="(someFieldLong + 25) * 0.25" + - order_by="custom_ranking desc" + attributes: + - parameter: parent%project + sample_argument_name: project_id + description: Your Google Cloud Project ID + - parameter: parent%tenant + sample_argument_name: tenant_id + description: Identifier of the Tenantd + on_success: + - print: ["Job summary: %s", $resp.job_summary] + - print: ["Job title snippet: %s", $resp.job_title_snippet] + - define: job=$resp.job + - print: ["Job name: %s", job.name] + - print: ["Job title: %s", job.title] + - id: job_search_commute_search + description: Search Jobs using commute distance + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + # - job_query.company_names[0]="projects/[Project ID]/companies/[Company ID]" + - request_metadata.domain="www.example.com" + - request_metadata.session_id="Hashed session identifier" + - request_metadata.user_id="Hashed user identifier" + - job_query.commute_filter.commute_method=TRANSIT + # 30 minutes + - job_query.commute_filter.travel_duration.seconds=1800 + - job_query.commute_filter.start_coordinates.latitude=37.422408 + - job_query.commute_filter.start_coordinates.longitude=-122.084068 + attributes: + - parameter: parent%project + sample_argument_name: project_id + - parameter: parent%tenant + sample_argument_name: tenant_id + on_success: + - print: ["Job summary: %s", $resp.job_summary] + - print: ["Job title snippet: %s", $resp.job_title_snippet] + - define: job=$resp.job + - print: ["Job name: %s", job.name] + - print: ["Job title: %s", job.title] + - id: job_search_histogram_search + description: Search Jobs with histogram queries + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID (using tenancy is optional)" + - request_metadata.domain="www.example.com" + - request_metadata.session_id="Hashed session identifier" + - request_metadata.user_id="Hashed user identifier" + - histogram_queries[0].histogram_query="count(base_compensation, [bucket(12, 20)])" + attributes: + - parameter: parent%project + sample_argument_name: project_id + - parameter: parent%tenant + sample_argument_name: tenant_id + - parameter: histogram_queries[0].histogram_query + sample_argument_name: query + description: | + Histogram query + More info on histogram facets, constants, and built-in functions: + https://godoc.org/google.golang.org/genproto/googleapis/cloud/talent/v4beta1#SearchJobsRequest + on_success: + - print: ["Job summary: %s", $resp.job_summary] + - print: ["Job title snippet: %s", $resp.job_title_snippet] + - define: job=$resp.job + - print: ["Job name: %s", job.name] + - print: ["Job title: %s", job.title] - name: SearchJobsForAlert required_fields: - parent @@ -748,7 +1216,7 @@ interfaces: field_name_patterns: parent: tenant_or_project timeout_millis: 30000 - # The fully qualified name of the API interface. +# The fully qualified name of the API interface. - name: google.cloud.talent.v4beta1.ProfileService # Definition for retryable codes. retry_codes_def: @@ -1003,6 +1471,26 @@ interfaces: field_name_patterns: parent: project timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_create_tenant] + region_tag: job_search_create_tenant + sample_value_sets: + - id: job_search_create_tenant + description: Create Tenant for scoping resources, e.g. companies and jobs + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - tenant.external_id="Your Unique Identifier for Tenant" + attributes: + - parameter: parent%project + sample_argument_name: project_id + - parameter: tenant.external_id + sample_argument_name: external_id + on_success: + - print: ["Created Tenant"] + - print: ["Name: %s", $resp.name] + - print: ["External ID: %s", $resp.external_id] - name: GetTenant flattening: groups: @@ -1016,6 +1504,25 @@ interfaces: field_name_patterns: name: tenant timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_get_tenant] + region_tag: job_search_get_tenant + sample_value_sets: + - id: job_search_get_tenant + description: Get Tenant by name + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + on_success: + - print: ["Name: %s", $resp.name] + - print: ["External ID: %s", $resp.external_id] - name: UpdateTenant flattening: groups: @@ -1041,6 +1548,24 @@ interfaces: field_name_patterns: name: tenant timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_delete_tenant] + region_tag: job_search_delete_tenant + sample_value_sets: + - id: job_search_delete_tenant + description: Delete Tenant + parameters: + defaults: + - name%project="Your Google Cloud Project ID" + - name%tenant="Your Tenant ID)" + attributes: + - parameter: name%project + sample_argument_name: project_id + - parameter: name%tenant + sample_argument_name: tenant_id + on_success: + - print: ["Deleted Tenant."] - name: ListTenants flattening: groups: @@ -1061,6 +1586,23 @@ interfaces: field_name_patterns: parent: project timeout_millis: 30000 + samples: + standalone: + - value_sets: [job_search_list_tenants] + region_tag: job_search_list_tenants + sample_value_sets: + - id: job_search_list_tenants + description: List Tenants + parameters: + defaults: + - parent%project="Your Google Cloud Project ID" + - parent%tenant="Your Tenant ID" + attributes: + - parameter: parent%project + sample_argument_name: project_id + on_success: + - print: ["Tenant Name: %s", $resp.name] + - print: ["External ID: %s", $resp.external_id] resource_name_generation: - message_name: Application field_entity_map: