type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
# The settings of generated code in a specific language.
language_settings:
java:
package_name: com.google.cloud.talent.v4beta1
python:
package_name: google.cloud.talent_v4beta1.gapic
go:
package_name: cloud.google.com/go/talent/apiv4beta1
csharp:
package_name: Google.Cloud.Talent.V4Beta1
ruby:
package_name: Google::Cloud::Talent::V4beta1
php:
package_name: Google\Cloud\Talent\V4beta1
nodejs:
package_name: talent.v4beta1
domain_layer_location: google-cloud
# A list of resource collection configurations.
# Consists of a name_pattern and an entity_name.
# The name_pattern is a pattern to describe the names of the resources of this
# collection, using the platform's conventions for URI patterns. A generator
# may use this to generate methods to compose and decompose such names. The
# pattern should use named placeholders as in `shelves/{shelf}/books/{book}`;
# those will be taken as hints for the parameter names of the generated
# methods. If empty, no name methods are generated.
# The entity_name is the name to be used as a basis for generated methods and
# classes.
collections:
- name_pattern: projects/{project}
entity_name: project
language_overrides:
- language: csharp
common_resource_name: Google.Api.Gax.ResourceNames.ProjectName
- name_pattern: projects/{project}/companies/{company}
entity_name: company_without_tenant
- name_pattern: projects/{project}/tenants/{tenant}/companies/{company}
entity_name: company
# Override on Java, or we'll get an exception caused by conflicting with company_oneof:
# "CompanyName.java: Tried to write the same file twice".
language_overrides:
- language: java
entity_name: company_with_tenant
- name_pattern: projects/{project}/jobs/{jobs}
entity_name: job_without_tenant
- name_pattern: projects/{project}/tenants/{tenant}/jobs/{jobs}
entity_name: job
# Override on Java, or we'll get an exception caused by conflicting with job_oneof:
# "JobName.java: Tried to write the same file twice".
language_overrides:
- language: java
entity_name: job_with_tenant
- name_pattern: projects/{project}/tenants/{tenant}/profiles/{profile}
entity_name: profile
- name_pattern: projects/{project}/tenants/{tenant}/profiles/{profile}/applications/{application}
entity_name: application
- name_pattern: projects/{project}/tenants/{tenant}
entity_name: tenant
collection_oneofs:
- oneof_name: company_oneof
collection_names:
- company
- company_without_tenant
- oneof_name: job_oneof
collection_names:
- job
- job_without_tenant
- oneof_name: tenant_or_project
collection_names:
- tenant
- project
# A list of API interface configurations.
interfaces:
# The fully qualified name of the API interface.
- name: google.cloud.talent.v4beta1.ApplicationService
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateApplication
flattening:
groups:
- parameters:
- parent
- application
required_fields:
- parent
- application
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: profile
timeout_millis: 60000
- name: GetApplication
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: application
timeout_millis: 60000
- name: UpdateApplication
flattening:
groups:
- parameters:
- application
required_fields:
- application
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
application.name: application
timeout_millis: 60000
- name: DeleteApplication
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: application
timeout_millis: 60000
- name: ListApplications
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: applications
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: profile
timeout_millis: 60000
# The fully qualified name of the API interface.
- name: google.cloud.talent.v4beta1.CompanyService
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# 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:
- parent
- company
required_fields:
- parent
- company
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
- name: GetCompany
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: company_oneof
timeout_millis: 60000
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:
- parameters:
- company
required_fields:
- company
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
company.name: company_oneof
timeout_millis: 60000
- 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:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: company_oneof
timeout_millis: 60000
- 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:
- parent
required_fields:
- parent
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: companies
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
# The fully qualified name of the API interface.
- name: google.cloud.talent.v4beta1.Completion
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CompleteQuery
required_fields:
- parent
- query
- page_size
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
company: company_oneof
timeout_millis: 30000
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:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateClientEvent
flattening:
groups:
- parameters:
- parent
- client_event
required_fields:
- parent
- client_event
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 30000
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:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateJob
flattening:
groups:
- parameters:
- parent
- job
required_fields:
- parent
- job
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
job.company: company_oneof
timeout_millis: 60000
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:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: job_oneof
timeout_millis: 60000
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:
- parameters:
- job
required_fields:
- job
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
job.name: job_oneof
job.company: company_oneof
timeout_millis: 60000
- name: DeleteJob
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: job_oneof
timeout_millis: 60000
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:
- parent
- filter
required_fields:
- parent
- filter
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: jobs
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
- name: BatchDeleteJobs
flattening:
groups:
- parameters:
- parent
- filter
required_fields:
- parent
- filter
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
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
- request_metadata
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: matching_jobs
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
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
- request_metadata
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: matching_jobs
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant_or_project
timeout_millis: 60000
- name: BatchCreateJobs
flattening:
groups:
- parameters:
- parent
- jobs
required_fields:
- parent
- jobs
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant
long_running:
return_type: google.cloud.talent.v4beta1.JobOperationResult
metadata_type: google.cloud.talent.v4beta1.BatchOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 60000
samples:
standalone:
- value_sets: [job_search_batch_create_jobs]
region_tag: job_search_batch_create_jobs
sample_value_sets:
- id: job_search_batch_create_jobs
description: Batch Create Jobs
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"
- jobs[0].company="Company name, e.g. projects/your-project/companies/company-id"
- jobs[0].requisition_id="Job requisition ID, aka Posting ID. Unique per job."
- jobs[0].title="Software Engineer"
- jobs[0].description="This is a description of this wonderful job!"
- jobs[0].application_info.uris[0]="https://www.example.org/job-posting/123"
- jobs[0].addresses[0]="1600 Amphitheatre Parkway, Mountain View, CA 94043"
- jobs[0].language_code="en-US"
- jobs[1].company="Company name, e.g. projects/your-project/companies/company-id"
- jobs[1].requisition_id="Job requisition ID, aka Posting ID. Unique per job."
- jobs[1].title="Quality Assurance"
- jobs[1].description="This is a description of this wonderful job!"
- jobs[1].application_info.uris[0]="https://www.example.org/job-posting/123"
- jobs[1].addresses[0]="111 8th Avenue, New York, NY 10011"
- jobs[1].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: jobs[0].company
sample_argument_name: company_name_one
- parameter: jobs[0].requisition_id
sample_argument_name: requisition_id_one
- parameter: jobs[0].title
sample_argument_name: title_one
- parameter: jobs[0].description
sample_argument_name: description_one
- parameter: jobs[0].application_info.uris[0]
sample_argument_name: job_application_url_one
- parameter: jobs[0].addresses[0]
sample_argument_name: address_one
- parameter: jobs[0].language_code
sample_argument_name: language_code_one
- parameter: jobs[1].company
sample_argument_name: company_name_two
- parameter: jobs[1].requisition_id
sample_argument_name: requisition_id_two
- parameter: jobs[1].title
sample_argument_name: title_two
- parameter: jobs[1].description
sample_argument_name: description_two
- parameter: jobs[1].application_info.uris[0]
sample_argument_name: job_application_url_two
- parameter: jobs[1].addresses[0]
sample_argument_name: address_two
- parameter: jobs[1].language_code
sample_argument_name: language_code_two
on_success:
- print:
- "Batch response: %s"
- $resp
- name: BatchUpdateJobs
flattening:
groups:
- parameters:
- parent
- jobs
required_fields:
- parent
- jobs
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant
long_running:
return_type: google.cloud.talent.v4beta1.JobOperationResult
metadata_type: google.cloud.talent.v4beta1.BatchOperationMetadata
initial_poll_delay_millis: 500
poll_delay_multiplier: 1.5
max_poll_delay_millis: 5000
total_poll_timeout_millis: 300000
timeout_millis: 60000
samples:
standalone:
- value_sets: [job_search_batch_update_jobs]
region_tag: job_search_batch_update_jobs
sample_value_sets:
- id: job_search_batch_update_jobs
description: Batch Update Jobs
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"
- jobs[0].name = "job name, e.g. projects/your-project/tenants/tenant-id/jobs/job-id"
- jobs[0].company="Company name, e.g. projects/your-project/companies/company-id"
- jobs[0].requisition_id="Job requisition ID, aka Posting ID. Unique per job."
- jobs[0].title="Software Engineer"
- jobs[0].description="This is a description of this wonderful job!"
- jobs[0].application_info.uris[0]="https://www.example.org/job-posting/123"
- jobs[0].addresses[0]="1600 Amphitheatre Parkway, Mountain View, CA 94043"
- jobs[0].language_code="en-US"
- jobs[1].name = "job name, e.g. projects/your-project/tenants/tenant-id/jobs/job-id"
- jobs[1].company="Company name, e.g. projects/your-project/companies/company-id"
- jobs[1].requisition_id="Job requisition ID, aka Posting ID. Unique per job."
- jobs[1].title="Quality Assurance"
- jobs[1].description="This is a description of this wonderful job!"
- jobs[1].application_info.uris[0]="https://www.example.org/job-posting/123"
- jobs[1].addresses[0]="111 8th Avenue, New York, NY 10011"
- jobs[1].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: jobs[0].name
sample_argument_name: job_name_one
- parameter: jobs[0].company
sample_argument_name: company_name_one
- parameter: jobs[0].requisition_id
sample_argument_name: requisition_id_one
- parameter: jobs[0].title
sample_argument_name: title_one
- parameter: jobs[0].description
sample_argument_name: description_one
- parameter: jobs[0].application_info.uris[0]
sample_argument_name: job_application_url_one
- parameter: jobs[0].addresses[0]
sample_argument_name: address_one
- parameter: jobs[0].language_code
sample_argument_name: language_code_one
- parameter: jobs[1].name
sample_argument_name: job_name_two
- parameter: jobs[1].company
sample_argument_name: company_name_two
- parameter: jobs[1].requisition_id
sample_argument_name: requisition_id_two
- parameter: jobs[1].title
sample_argument_name: title_two
- parameter: jobs[1].description
sample_argument_name: description_two
- parameter: jobs[1].application_info.uris[0]
sample_argument_name: job_application_url_two
- parameter: jobs[1].addresses[0]
sample_argument_name: address_two
- parameter: jobs[1].language_code
sample_argument_name: language_code_two
on_success:
- print:
- "Batch response: %s"
- $resp
# The fully qualified name of the API interface.
- name: google.cloud.talent.v4beta1.ProfileService
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: ListProfiles
flattening:
groups:
- parameters:
- parent
required_fields:
- parent
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: profiles
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: tenant
timeout_millis: 60000
- name: CreateProfile
flattening:
groups:
- parameters:
- parent
- profile
required_fields:
- parent
- profile
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant
timeout_millis: 60000
- name: GetProfile
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: profile
timeout_millis: 60000
- name: UpdateProfile
flattening:
groups:
- parameters:
- profile
required_fields:
- profile
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
profile.name: profile
timeout_millis: 60000
- name: DeleteProfile
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: profile
timeout_millis: 60000
- name: SearchProfiles
required_fields:
- parent
- request_metadata
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: summarized_profiles
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: tenant
timeout_millis: 60000
# The fully qualified name of the API interface.
- name: google.cloud.talent.v4beta1.TenantService
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- DEADLINE_EXCEEDED
- UNAVAILABLE
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: CreateTenant
flattening:
groups:
- parameters:
- parent
- tenant
required_fields:
- parent
- tenant
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
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:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: tenant
timeout_millis: 60000
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:
- parameters:
- tenant
required_fields:
- tenant
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
tenant.name: tenant
timeout_millis: 60000
- name: DeleteTenant
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: tenant
timeout_millis: 60000
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:
- parameters:
- parent
required_fields:
- parent
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: tenants
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 60000
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:
name: application
- message_name: CreateApplicationRequest
field_entity_map:
parent: profile
- message_name: GetApplicationRequest
field_entity_map:
name: application
- message_name: DeleteApplicationRequest
field_entity_map:
name: application
- message_name: ListApplicationsRequest
field_entity_map:
parent: profile
- message_name: Company
field_entity_map:
name: company_oneof
- message_name: CreateCompanyRequest
field_entity_map:
parent: tenant_or_project
- message_name: GetCompanyRequest
field_entity_map:
name: company_oneof
- message_name: DeleteCompanyRequest
field_entity_map:
name: company_oneof
- message_name: ListCompaniesRequest
field_entity_map:
parent: tenant_or_project
- message_name: CompleteQueryRequest
field_entity_map:
parent: tenant_or_project
company: company_oneof
- message_name: CreateClientEventRequest
field_entity_map:
parent: tenant_or_project
- message_name: Job
field_entity_map:
name: job_oneof
company: company_oneof
- message_name: CreateJobRequest
field_entity_map:
parent: tenant_or_project
job.company: company_oneof
- message_name: GetJobRequest
field_entity_map:
name: job_oneof
- message_name: DeleteJobRequest
field_entity_map:
name: job_oneof
- message_name: ListJobsRequest
field_entity_map:
parent: tenant_or_project
- message_name: BatchDeleteJobsRequest
field_entity_map:
parent: tenant_or_project
- message_name: SearchJobsRequest
field_entity_map:
parent: tenant_or_project
- message_name: SearchJobsForAlertRequest
field_entity_map:
parent: tenant_or_project
- message_name: Profile
field_entity_map:
name: profile
- message_name: CreateProfileRequest
field_entity_map:
parent: tenant
- message_name: GetProfileRequest
field_entity_map:
name: profile
- message_name: DeleteProfileRequest
field_entity_map:
name: profile
- message_name: ListProfilesRequest
field_entity_map:
parent: tenant
- message_name: SearchProfilesRequest
field_entity_map:
parent: tenant
- message_name: Tenant
field_entity_map:
name: tenant
- message_name: CreateTenantRequest
field_entity_map:
parent: project
- message_name: GetTenantRequest
field_entity_map:
name: tenant
- message_name: DeleteTenantRequest
field_entity_map:
name: tenant
- message_name: ListTenantsRequest
field_entity_map:
parent: project