Types for Google Cloud Talent v4beta1 API¶
- class google.cloud.talent_v4beta1.types.BatchCreateJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to create a batch of jobs.
- parent¶
Required. The resource name of the tenant under which the job is created.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.
- Type
- jobs¶
Required. The jobs to be created.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Job]
- class google.cloud.talent_v4beta1.types.BatchDeleteJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBatch delete jobs request.
- parent¶
Required. The resource name of the tenant under which the job is created.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.
- Type
- class google.cloud.talent_v4beta1.types.BatchOperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMetadata used for long running operations returned by CTS batch APIs. It’s used to replace [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].
- state¶
The state of a long running operation.
- create_time¶
The time when the batch operation is created.
- update_time¶
The time when the batch operation status is updated. The metadata and the [update_time][google.cloud.talent.v4beta1.BatchOperationMetadata.update_time] is refreshed every minute otherwise cached data is returned.
- end_time¶
The time when the batch operation is finished and [google.longrunning.Operation.done][google.longrunning.Operation.done] is set to
true.
- class State(value)[source]¶
Bases:
proto.enums.Enum- Values:
- STATE_UNSPECIFIED (0):
Default value.
- INITIALIZING (1):
The batch operation is being prepared for processing.
- PROCESSING (2):
The batch operation is actively being processed.
- SUCCEEDED (3):
The batch operation is processed, and at least one item has been successfully processed.
- FAILED (4):
The batch operation is done and no item has been successfully processed.
- CANCELLING (5):
The batch operation is in the process of cancelling after [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called.
- CANCELLED (6):
The batch operation is done after [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called. Any items processed before cancelling are returned in the response.
- class google.cloud.talent_v4beta1.types.BatchUpdateJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to update a batch of jobs.
- parent¶
Required. The resource name of the tenant under which the job is created.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.
- Type
- jobs¶
Required. The jobs to be updated.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Job]
- update_mask¶
Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.
If [update_mask][google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask] is provided, only the specified fields in [Job][google.cloud.talent.v4beta1.Job] are updated. Otherwise all the fields are updated.
A field mask to restrict the fields that are updated. Only top level fields of [Job][google.cloud.talent.v4beta1.Job] are supported.
If [update_mask][google.cloud.talent.v4beta1.BatchUpdateJobsRequest.update_mask] is provided, The [Job][google.cloud.talent.v4beta1.Job] inside [JobResult][google.cloud.talent.v4beta1.JobOperationResult.JobResult] will only contains fields that is updated, plus the Id of the Job. Otherwise, [Job][google.cloud.talent.v4beta1.Job] will include all fields, which can yield a very large response.
- class google.cloud.talent_v4beta1.types.ClientEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.
- request_id¶
Strongly recommended for the best service experience.
A unique ID generated in the API responses. It can be found in [ResponseMetadata.request_id][google.cloud.talent.v4beta1.ResponseMetadata.request_id].
- Type
- create_time¶
Required. The timestamp of the event.
- class google.cloud.talent_v4beta1.types.CommuteFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageParameters needed for commute search.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- commute_method¶
Required. The method of transportation to calculate the commute time for.
- start_coordinates¶
Required. The latitude and longitude of the location to calculate the commute time from.
- Type
google.type.latlng_pb2.LatLng
- travel_duration¶
Required. The maximum travel time in seconds. The maximum allowed value is
3600s(one hour). Format is123s.
- allow_imprecise_addresses¶
If
true, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set tofalseor isn’t specified, only jobs that include street level addresses will be returned by commute search.- Type
- road_traffic¶
Specifies the traffic density to use when calculating commute time.
This field is a member of oneof
traffic_option.
- departure_time¶
The departure time used to calculate traffic impact, represented as [google.type.TimeOfDay][google.type.TimeOfDay] in local time zone.
Currently traffic model is restricted to hour level resolution.
This field is a member of oneof
traffic_option.- Type
google.type.timeofday_pb2.TimeOfDay
- class RoadTraffic(value)[source]¶
Bases:
proto.enums.EnumThe traffic density to use when calculating commute time.
- Values:
- ROAD_TRAFFIC_UNSPECIFIED (0):
Road traffic situation isn’t specified.
- TRAFFIC_FREE (1):
Optimal commute time without considering any traffic impact.
- BUSY_HOUR (2):
Commute time calculation takes in account the peak traffic impact.
- class google.cloud.talent_v4beta1.types.CommuteMethod(value)[source]¶
Bases:
proto.enums.EnumMethod for commute.
- Values:
- COMMUTE_METHOD_UNSPECIFIED (0):
Commute method isn’t specified.
- DRIVING (1):
Commute time is calculated based on driving time.
- TRANSIT (2):
Commute time is calculated based on public transit including bus, metro, subway, and so on.
- WALKING (3):
Commute time is calculated based on walking time.
- CYCLING (4):
Commute time is calculated based on biking time.
- class google.cloud.talent_v4beta1.types.Company(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.
- name¶
Required during company update.
The resource name for a company. This is generated by the service when a company is created.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”.
If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”.
- Type
- external_id¶
Required. Client side company identifier, used to uniquely identify the company.
The maximum number of allowed characters is 255.
- Type
- size¶
The employer’s company size.
- headquarters_address¶
The street address of the company’s main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in [DerivedInfo.headquarters_location][google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location].
- Type
- hiring_agency¶
Set to true if it is the hiring agency that post jobs for other employers.
Defaults to false if not provided.
- Type
- eeo_text¶
Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles.
The maximum number of allowed characters is 500.
- Type
- website_uri¶
The URI representing the company’s primary web site or home page, for example, “https://www.google.com”.
The maximum number of allowed characters is 255.
- Type
- career_site_uri¶
The URI to employer’s career site or careers page on the employer’s web site, for example, “https://careers.google.com”.
- Type
- keyword_searchable_job_custom_attributes¶
This field is deprecated. Please set the searchability of the custom attribute in the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] going forward.
A list of keys of filterable [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes], whose corresponding
string_valuesare used in keyword searches. Jobs withstring_valuesunder these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.- Type
MutableSequence[str]
- derived_info¶
Output only. Derived details about the company.
- suspended¶
Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.
- Type
- class DerivedInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDerived details about the company.
- headquarters_location¶
A structured headquarters location of the company, resolved from [Company.headquarters_address][google.cloud.talent.v4beta1.Company.headquarters_address] if provided.
- class google.cloud.talent_v4beta1.types.CompanySize(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents the size of the company.
- Values:
- COMPANY_SIZE_UNSPECIFIED (0):
Default value if the size isn’t specified.
- MINI (1):
The company has less than 50 employees.
- SMALL (2):
The company has between 50 and 99 employees.
- SMEDIUM (3):
The company has between 100 and 499 employees.
- MEDIUM (4):
The company has between 500 and 999 employees.
- BIG (5):
The company has between 1,000 and 4,999 employees.
- BIGGER (6):
The company has between 5,000 and 9,999 employees.
- GIANT (7):
The company has 10,000 or more employees.
- class google.cloud.talent_v4beta1.types.CompensationFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilter on job compensation type and amount.
- type_¶
Required. Type of filter.
- units¶
Required. Specify desired
base compensation entry's[CompensationInfo.CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit].- Type
MutableSequence[google.cloud.talent_v4beta1.types.CompensationInfo.CompensationUnit]
- range_¶
Compensation range.
- include_jobs_with_unspecified_compensation_range¶
If set to true, jobs with unspecified compensation range fields are included.
- Type
- class FilterType(value)[source]¶
Bases:
proto.enums.EnumSpecify the type of filtering.
- Values:
- FILTER_TYPE_UNSPECIFIED (0):
Filter type unspecified. Position holder, INVALID, should never be used.
- UNIT_ONLY (1):
Filter by
base compensation entry'sunit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry’s unit matches provided [units][google.cloud.talent.v4beta1.CompensationFilter.units]. Populate one or more [units][google.cloud.talent.v4beta1.CompensationFilter.units].See [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for definition of base compensation entry.
- UNIT_AND_AMOUNT (2):
Filter by
base compensation entry'sunit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry’s unit matches provided [CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit] and amount or range overlaps with provided [CompensationRange][google.cloud.talent.v4beta1.CompensationInfo.CompensationRange].See [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for definition of base compensation entry.
Set exactly one [units][google.cloud.talent.v4beta1.CompensationFilter.units] and populate [range][google.cloud.talent.v4beta1.CompensationFilter.range].
- ANNUALIZED_BASE_AMOUNT (3):
Filter by annualized base compensation amount and
base compensation entry'sunit. Populate [range][google.cloud.talent.v4beta1.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4beta1.CompensationFilter.units].- ANNUALIZED_TOTAL_AMOUNT (4):
Filter by annualized total compensation amount and
base compensation entry'sunit . Populate [range][google.cloud.talent.v4beta1.CompensationFilter.range] and zero or more [units][google.cloud.talent.v4beta1.CompensationFilter.units].
- class google.cloud.talent_v4beta1.types.CompensationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJob compensation details.
- entries¶
Job compensation information.
At most one entry can be of type [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE], which is referred as base compensation entry for the job.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.CompensationInfo.CompensationEntry]
- annualized_base_compensation_range¶
Output only. Annualized base compensation range. Computed as base compensation entry’s [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
- annualized_total_compensation_range¶
Output only. Annualized total compensation range. Computed as all compensation entries’ [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] times [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
- class CompensationEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type.
Annualization: One compensation entry can be annualized if
it contains valid [amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range].
and its [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year] is set or can be derived. Its annualized range is determined as ([amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]) times [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- type_¶
Compensation type.
Default is [CompensationType.COMPENSATION_TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.COMPENSATION_TYPE_UNSPECIFIED].
- unit¶
Frequency of the specified amount.
Default is [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED].
- amount¶
Compensation amount.
This field is a member of oneof
compensation_amount.- Type
google.type.money_pb2.Money
- description¶
Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
- Type
- expected_units_per_year¶
Expected number of units paid each year. If not specified, when [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types] is FULLTIME, a default value is inferred based on [unit][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.unit]. Default values:
HOURLY: 2080
DAILY: 260
WEEKLY: 52
MONTHLY: 12
ANNUAL: 1
- class CompensationRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCompensation range.
- max_compensation¶
The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the [currency code][google.type.Money.currency_code] of min_compensation.
- Type
google.type.money_pb2.Money
- min_compensation¶
The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the [currency code][google.type.Money.currency_code] of max_compensation.
- Type
google.type.money_pb2.Money
- class CompensationType(value)[source]¶
Bases:
proto.enums.EnumThe type of compensation.
For compensation amounts specified in non-monetary amounts, describe the compensation scheme in the [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description].
For example, tipping format is described in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] (for example, “expect 15-20% tips based on customer bill.”) and an estimate of the tips provided in [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range] ($10 per hour).
For example, equity is described in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] (for example, “1% - 2% equity vesting over 4 years, 1 year cliff”) and value estimated in [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]. If no value estimate is possible, units are [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED] and then further clarified in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] field.
- Values:
- COMPENSATION_TYPE_UNSPECIFIED (0):
Default value.
- BASE (1):
Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.
- BONUS (2):
Bonus.
- SIGNING_BONUS (3):
Signing bonus.
- EQUITY (4):
Equity.
- PROFIT_SHARING (5):
Profit sharing.
- COMMISSIONS (6):
Commission.
- TIPS (7):
Tips.
- OTHER_COMPENSATION_TYPE (8):
Other compensation type.
- class CompensationUnit(value)[source]¶
Bases:
proto.enums.EnumPay frequency.
- Values:
- COMPENSATION_UNIT_UNSPECIFIED (0):
Default value.
- HOURLY (1):
Hourly.
- DAILY (2):
Daily.
- WEEKLY (3):
Weekly
- MONTHLY (4):
Monthly.
- YEARLY (5):
Yearly.
- ONE_TIME (6):
One time.
- OTHER_COMPENSATION_UNIT (7):
Other compensation units.
- class google.cloud.talent_v4beta1.types.CompleteQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAuto-complete parameters.
- parent¶
Required. Resource name of tenant the completion is performed within.
The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”.
If tenant id is unspecified, the default tenant is used, for example, “projects/foo”.
- Type
- query¶
Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
- Type
- language_codes¶
The list of languages of the query. This is the BCP-47 language code, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages.
The maximum number of allowed characters is 255.
- Type
MutableSequence[str]
- company¶
If provided, restricts completion to specified company.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”.
If tenant id is unspecified, the default tenant is used, for example, “projects/foo”.
- Type
- scope¶
The scope of the completion. The defaults is [CompletionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope.PUBLIC].
- type_¶
The completion topic. The default is [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED].
- class CompletionScope(value)[source]¶
Bases:
proto.enums.EnumEnum to specify the scope of completion.
- Values:
- COMPLETION_SCOPE_UNSPECIFIED (0):
Default value.
- TENANT (1):
Suggestions are based only on the data provided by the client.
- PUBLIC (2):
Suggestions are based on all jobs data in the system that’s visible to the client
- class CompletionType(value)[source]¶
Bases:
proto.enums.EnumEnum to specify auto-completion topics.
- Values:
- COMPLETION_TYPE_UNSPECIFIED (0):
Default value.
- JOB_TITLE (1):
Suggest job titles for jobs autocomplete.
For [CompletionType.JOB_TITLE][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.JOB_TITLE] type, only open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned.
- COMPANY_NAME (2):
Suggest company names for jobs autocomplete.
For [CompletionType.COMPANY_NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NAME] type, only companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned.
- COMBINED (3):
Suggest both job titles and company names for jobs autocomplete.
For [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED] type, only open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] or companies having open jobs with the same [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] are returned.
- class google.cloud.talent_v4beta1.types.CompleteQueryResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse of auto-complete query.
- completion_results¶
Results of the matching job/company candidates.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.CompleteQueryResponse.CompletionResult]
- metadata¶
Additional information for the API invocation, such as the request tracking id.
- class CompletionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResource that represents completion results.
- type_¶
The completion topic.
- class google.cloud.talent_v4beta1.types.CreateClientEventRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe report event request.
- parent¶
Required. Resource name of the tenant under which the event is created.
The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created, for example, “projects/foo”.
- Type
- client_event¶
Required. Events issued when end user interacts with customer’s application that uses Cloud Talent Solution.
- class google.cloud.talent_v4beta1.types.CreateCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Request of the CreateCompany method.
- parent¶
Required. Resource name of the tenant under which the company is created.
The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created, for example, “projects/foo”.
- Type
- company¶
Required. The company to be created.
- class google.cloud.talent_v4beta1.types.CreateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCreate job request.
- parent¶
Required. The resource name of the tenant under which the job is created.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified a default tenant is created. For example, “projects/foo”.
- Type
- job¶
Required. The Job to be created.
- class google.cloud.talent_v4beta1.types.CreateTenantRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Request of the CreateTenant method.
- parent¶
Required. Resource name of the project under which the tenant is created.
The format is “projects/{project_id}”, for example, “projects/foo”.
- Type
- tenant¶
Required. The tenant to be created.
- class google.cloud.talent_v4beta1.types.CustomAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCustom attribute values that are either filterable or non-filterable.
- string_values¶
Exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] must be specified.
This field is used to perform a string match (
CASE_SENSITIVE_MATCHorCASE_INSENSITIVE_MATCH) search. For filterablestring_values, a maximum total number of 200 values is allowed, with eachstring_valuehas a byte size of no more than 500B. For unfilterablestring_values, the maximum total byte size of unfilterablestring_valuesis 50KB.Empty string isn’t allowed.
- Type
MutableSequence[str]
- long_values¶
Exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] must be specified.
This field is used to perform number range search. (
EQ,GT,GE,LE,LT) over filterablelong_value.Currently at most 1 [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] is supported.
- Type
MutableSequence[int]
- filterable¶
If the
filterableflag is true, the custom field values may be used for custom attribute filters [JobQuery.custom_attribute_filter][google.cloud.talent.v4beta1.JobQuery.custom_attribute_filter]. If false, these values may not be used for custom attribute filters.Default is false.
- Type
- class google.cloud.talent_v4beta1.types.DegreeType(value)[source]¶
Bases:
proto.enums.EnumEducational degree level defined in International Standard Classification of Education (ISCED).
- Values:
- DEGREE_TYPE_UNSPECIFIED (0):
Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten
- PRIMARY_EDUCATION (1):
Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school
- LOWER_SECONDARY_EDUCATION (2):
Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school
- UPPER_SECONDARY_EDUCATION (3):
Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school
- ADULT_REMEDIAL_EDUCATION (4):
Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.
- ASSOCIATES_OR_EQUIVALENT (5):
Associate’s or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.
- BACHELORS_OR_EQUIVALENT (6):
Bachelor’s or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.
- MASTERS_OR_EQUIVALENT (7):
Master’s or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.
- DOCTORAL_OR_EQUIVALENT (8):
Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8.
- class google.cloud.talent_v4beta1.types.DeleteCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to delete a company.
- name¶
Required. The resource name of the company to be deleted.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”, for example, “projects/foo/tenants/bar/companies/baz”.
If tenant id is unspecified, the default tenant is used, for example, “projects/foo/companies/bar”.
- Type
- class google.cloud.talent_v4beta1.types.DeleteJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDelete job request.
- class google.cloud.talent_v4beta1.types.DeleteTenantRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to delete a tenant.
- class google.cloud.talent_v4beta1.types.DeviceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDevice information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.
- device_type¶
Type of the device.
- id¶
A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
- Type
- class DeviceType(value)[source]¶
Bases:
proto.enums.EnumAn enumeration describing an API access portal and exposure mechanism.
- Values:
- DEVICE_TYPE_UNSPECIFIED (0):
The device type isn’t specified.
- WEB (1):
A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)
- MOBILE_WEB (2):
A mobile device web browser, such as a phone or tablet with a Chrome browser.
- ANDROID (3):
An Android device native application.
- IOS (4):
An iOS device native application.
- BOT (5):
A bot, as opposed to a device operated by human beings, such as a web crawler.
- OTHER (6):
Other devices types.
- class google.cloud.talent_v4beta1.types.EmploymentType(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents the employment type of a job.
- Values:
- EMPLOYMENT_TYPE_UNSPECIFIED (0):
The default value if the employment type isn’t specified.
- FULL_TIME (1):
The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.
- PART_TIME (2):
The job entails working fewer hours than a full time job, typically less than 40 hours a week.
- CONTRACTOR (3):
The job is offered as a contracted, as opposed to a salaried employee, position.
- CONTRACT_TO_HIRE (4):
The job is offered as a contracted position with the understanding that it’s converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for [EmploymentType.CONTRACTOR][google.cloud.talent.v4beta1.EmploymentType.CONTRACTOR] jobs.
- TEMPORARY (5):
The job is offered as a temporary employment opportunity, usually a short-term engagement.
- INTERN (6):
The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.
- VOLUNTEER (7):
The is an opportunity for an individual to volunteer, where there’s no expectation of compensation for the provided services.
- PER_DIEM (8):
The job requires an employee to work on an as-needed basis with a flexible schedule.
- FLY_IN_FLY_OUT (9):
The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.
- OTHER_EMPLOYMENT_TYPE (10):
The job does not fit any of the other listed types.
- class google.cloud.talent_v4beta1.types.GetCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for getting a company by name.
- name¶
Required. The resource name of the company to be retrieved.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”, for example, “projects/api-test-project/tenants/foo/companies/bar”.
If tenant id is unspecified, the default tenant is used, for example, “projects/api-test-project/companies/bar”.
- Type
- class google.cloud.talent_v4beta1.types.GetJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGet job request.
- class google.cloud.talent_v4beta1.types.GetTenantRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for getting a tenant by name.
- class google.cloud.talent_v4beta1.types.HistogramQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe histogram request.
- histogram_query¶
An expression specifies a histogram request against matching resources (for example, jobs, profiles) for searches.
See [SearchJobsRequest.histogram_queries][google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries] and [SearchProfilesRequest.histogram_queries][google.cloud.talent.v4beta1.SearchProfilesRequest.histogram_queries] for details about syntax.
- Type
- class google.cloud.talent_v4beta1.types.HistogramQueryResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageHistogram result that matches [HistogramQuery][google.cloud.talent.v4beta1.HistogramQuery] specified in searches.
- histogram¶
A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value.
The key format is:
(for string histogram) string values stored in the field.
(for named numeric bucket) name specified in
bucket()function, like forbucket(0, MAX, "non-negative"), the key will benon-negative.(for anonymous numeric bucket) range formatted as
<low>-<high>, for example,0-1000,MIN-0, and0-MAX.
- class HistogramEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.talent_v4beta1.types.HtmlSanitization(value)[source]¶
Bases:
proto.enums.EnumOption for HTML content sanitization on user input fields, for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields.
- Values:
- HTML_SANITIZATION_UNSPECIFIED (0):
Default value.
- HTML_SANITIZATION_DISABLED (1):
Disables sanitization on HTML input.
- SIMPLE_FORMATTING_ONLY (2):
Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags.
- class google.cloud.talent_v4beta1.types.Job(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Job resource represents a job posting (also referred to as a “job listing” or “job requisition”). A job belongs to a [Company][google.cloud.talent.v4beta1.Company], which is the hiring entity responsible for the job.
- name¶
Required during job update.
The resource name for the job. This is generated by the service when a job is created.
The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”. For example, “projects/foo/tenants/bar/jobs/baz”.
If tenant id is unspecified, the default tenant is used. For example, “projects/foo/jobs/bar”.
Use of this field in job queries and API calls is preferred over the use of [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] since this value is unique.
- Type
- company¶
Required. The resource name of the company listing the job.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”. For example, “projects/foo/tenants/bar/companies/baz”.
If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”.
- Type
- requisition_id¶
Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn’t allowed to be created if there is another job with the same [company][google.cloud.talent.v4beta1.Job.name], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id].
The maximum number of allowed characters is 255.
- Type
- title¶
Required. The title of the job, such as “Software Engineer” The maximum number of allowed characters is 500.
- Type
- description¶
Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for [responsibilities][google.cloud.talent.v4beta1.Job.responsibilities], [qualifications][google.cloud.talent.v4beta1.Job.qualifications], and other job characteristics. Use of these separate job fields is recommended.
This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.
The maximum number of allowed characters is 100,000.
- Type
- addresses¶
Strongly recommended for the best service experience.
Location(s) where the employer is looking to hire for this job posting.
Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time.
At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id]s (e.g. ‘ReqA’ becomes ‘ReqA-1’, ‘ReqA-2’, and so on.) as multiple jobs with the same [company][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] are not allowed. If the original [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience.
The maximum number of allowed characters is 500.
- Type
MutableSequence[str]
- application_info¶
Job application information.
- job_benefits¶
The benefits included with the job.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.JobBenefit]
- compensation_info¶
Job compensation information (a.k.a. “pay rate”) i.e., the compensation that will paid to the employee.
- custom_attributes¶
A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields.
The keys of the map are strings up to 64 bytes and must match the pattern:
[a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.At most 100 filterable and at most 100 unfilterable keys are supported. For filterable
string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterablestring_values, the maximum total size ofstring_valuesacross all keys is 50KB.- Type
MutableMapping[str, google.cloud.talent_v4beta1.types.CustomAttribute]
- degree_types¶
The desired education degrees for the job, such as Bachelors, Masters.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.DegreeType]
- department¶
The department or functional area within the company with the open position.
The maximum number of allowed characters is 255.
- Type
- employment_types¶
The employment type(s) of a job, for example, [full time][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME] or [part time][google.cloud.talent.v4beta1.EmploymentType.PART_TIME].
- Type
MutableSequence[google.cloud.talent_v4beta1.types.EmploymentType]
- incentives¶
A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay.
The maximum number of allowed characters is 10,000.
- Type
- language_code¶
The language of the posting. This field is distinct from any requirements for fluency that are associated with the job.
Language codes must be in BCP-47 format, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages{: class=”external” target=”_blank” }.
If this field is unspecified and [Job.description][google.cloud.talent.v4beta1.Job.description] is present, detected language code based on [Job.description][google.cloud.talent.v4beta1.Job.description] is assigned, otherwise defaults to ‘en_US’.
- Type
- job_level¶
The experience level associated with the job, such as “Entry Level”.
- promotion_value¶
A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.
Default value is 0, and negative values are treated as 0.
- Type
- qualifications¶
A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] field.
This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.
The maximum number of allowed characters is 10,000.
- Type
- responsibilities¶
A description of job responsibilities. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] field.
This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.
The maximum number of allowed characters is 10,000.
- Type
- posting_region¶
The job [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for example, state, country) throughout which the job is available. If this field is set, a [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in a search query within the job region finds this job posting if an exact location match isn’t specified. If this field is set to [PostingRegion.NATION][google.cloud.talent.v4beta1.PostingRegion.NATION] or [PostingRegion.ADMINISTRATIVE_AREA][google.cloud.talent.v4beta1.PostingRegion.ADMINISTRATIVE_AREA], setting job [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] to the same location level as this field is strongly recommended.
- visibility¶
Deprecated. The job is only visible to the owner.
The visibility of the job.
Defaults to [Visibility.ACCOUNT_ONLY][google.cloud.talent.v4beta1.Visibility.ACCOUNT_ONLY] if not specified.
- job_start_time¶
The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
- job_end_time¶
The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
- posting_publish_time¶
The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.
- posting_expire_time¶
Strongly recommended for the best service experience.
The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can’t be listed by the [ListJobs][google.cloud.talent.v4beta1.JobService.ListJobs] API, but it can be retrieved with the [GetJob][google.cloud.talent.v4beta1.JobService.GetJob] API or updated with the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] API or deleted with the [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same [company][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id].
The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out.
Invalid timestamps are ignored, and treated as expire time not provided.
If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the [posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] must be set before [posting_expire_time][google.cloud.talent.v4beta1.Job.posting_expire_time]. The purpose of this feature is to allow other objects, such as [Application][google.cloud.talent.v4beta1.Application], to refer a job that didn’t exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one.
If this value isn’t provided at the time of job creation or is invalid, the job posting expires after 30 days from the job’s creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.
If this value isn’t provided on job update, it depends on the field masks set by [UpdateJobRequest.update_mask][google.cloud.talent.v4beta1.UpdateJobRequest.update_mask]. If the field masks include [job_end_time][google.cloud.talent.v4beta1.Job.job_end_time], or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job’s last update time. Otherwise the expiration date isn’t updated.
- posting_create_time¶
Output only. The timestamp when this job posting was created.
- posting_update_time¶
Output only. The timestamp when this job posting was last updated.
- derived_info¶
Output only. Derived details about the job posting.
- processing_options¶
Options for job processing.
- class ApplicationInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageApplication related details of a job posting.
- emails¶
Use this field to specify email address(es) to which resumes or applications can be sent.
The maximum number of allowed characters for each entry is 255.
- Type
MutableSequence[str]
- instruction¶
Use this field to provide instructions, such as “Mail your application to …”, that a candidate can follow to apply for the job.
This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags.
The maximum number of allowed characters is 3,000.
- Type
- class CustomAttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class DerivedInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDerived details about the job posting.
- locations¶
Structured locations of the job, resolved from [Job.addresses][google.cloud.talent.v4beta1.Job.addresses].
[locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations] are exactly matched to [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] in the same order.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Location]
- job_categories¶
Job categories derived from [Job.title][google.cloud.talent.v4beta1.Job.title] and [Job.description][google.cloud.talent.v4beta1.Job.description].
- Type
MutableSequence[google.cloud.talent_v4beta1.types.JobCategory]
- class ProcessingOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions for job processing.
- disable_street_address_resolution¶
If set to
true, the service does not attempt to resolve a more precise address for the job.- Type
- html_sanitization¶
Option for job HTML content sanitization. Applied fields are:
description
applicationInfo.instruction
incentives
qualifications
responsibilities
HTML tags in these fields may be stripped if sanitiazation isn’t disabled.
Defaults to [HtmlSanitization.SIMPLE_FORMATTING_ONLY][google.cloud.talent.v4beta1.HtmlSanitization.SIMPLE_FORMATTING_ONLY].
- class google.cloud.talent_v4beta1.types.JobBenefit(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents employee benefits included with the job.
- Values:
- JOB_BENEFIT_UNSPECIFIED (0):
Default value if the type isn’t specified.
- CHILD_CARE (1):
The job includes access to programs that support child care, such as daycare.
- DENTAL (2):
The job includes dental services covered by a dental insurance plan.
- DOMESTIC_PARTNER (3):
The job offers specific benefits to domestic partners.
- FLEXIBLE_HOURS (4):
The job allows for a flexible work schedule.
- MEDICAL (5):
The job includes health services covered by a medical insurance plan.
- LIFE_INSURANCE (6):
The job includes a life insurance plan provided by the employer or available for purchase by the employee.
- PARENTAL_LEAVE (7):
The job allows for a leave of absence to a parent to care for a newborn child.
- RETIREMENT_PLAN (8):
The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.
- SICK_DAYS (9):
The job allows for paid time off due to illness.
- VACATION (10):
The job includes paid time off for vacation.
- VISION (11):
The job includes vision services covered by a vision insurance plan.
- class google.cloud.talent_v4beta1.types.JobCategory(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents the categorization or primary focus of specific role. This value is different than the “industry” associated with a role, which is related to the categorization of the company listing the job.
- Values:
- JOB_CATEGORY_UNSPECIFIED (0):
The default value if the category isn’t specified.
- ACCOUNTING_AND_FINANCE (1):
An accounting and finance job, such as an Accountant.
- ADMINISTRATIVE_AND_OFFICE (2):
An administrative and office job, such as an Administrative Assistant.
- ADVERTISING_AND_MARKETING (3):
An advertising and marketing job, such as Marketing Manager.
- ANIMAL_CARE (4):
An animal care job, such as Veterinarian.
- ART_FASHION_AND_DESIGN (5):
An art, fashion, or design job, such as Designer.
- BUSINESS_OPERATIONS (6):
A business operations job, such as Business Operations Manager.
- CLEANING_AND_FACILITIES (7):
A cleaning and facilities job, such as Custodial Staff.
- COMPUTER_AND_IT (8):
A computer and IT job, such as Systems Administrator.
- CONSTRUCTION (9):
A construction job, such as General Laborer.
- CUSTOMER_SERVICE (10):
A customer service job, such s Cashier.
- EDUCATION (11):
An education job, such as School Teacher.
- ENTERTAINMENT_AND_TRAVEL (12):
An entertainment and travel job, such as Flight Attendant.
- FARMING_AND_OUTDOORS (13):
A farming or outdoor job, such as Park Ranger.
- HEALTHCARE (14):
A healthcare job, such as Registered Nurse.
- HUMAN_RESOURCES (15):
A human resources job, such as Human Resources Director.
- INSTALLATION_MAINTENANCE_AND_REPAIR (16):
An installation, maintenance, or repair job, such as Electrician.
- LEGAL (17):
A legal job, such as Law Clerk.
- MANAGEMENT (18):
A management job, often used in conjunction with another category, such as Store Manager.
- MANUFACTURING_AND_WAREHOUSE (19):
A manufacturing or warehouse job, such as Assembly Technician.
- MEDIA_COMMUNICATIONS_AND_WRITING (20):
A media, communications, or writing job, such as Media Relations.
- OIL_GAS_AND_MINING (21):
An oil, gas or mining job, such as Offshore Driller.
- PERSONAL_CARE_AND_SERVICES (22):
A personal care and services job, such as Hair Stylist.
- PROTECTIVE_SERVICES (23):
A protective services job, such as Security Guard.
- REAL_ESTATE (24):
A real estate job, such as Buyer’s Agent.
- RESTAURANT_AND_HOSPITALITY (25):
A restaurant and hospitality job, such as Restaurant Server.
- SALES_AND_RETAIL (26):
A sales and/or retail job, such Sales Associate.
- SCIENCE_AND_ENGINEERING (27):
A science and engineering job, such as Lab Technician.
- SOCIAL_SERVICES_AND_NON_PROFIT (28):
A social services or non-profit job, such as Case Worker.
- SPORTS_FITNESS_AND_RECREATION (29):
A sports, fitness, or recreation job, such as Personal Trainer.
- TRANSPORTATION_AND_LOGISTICS (30):
A transportation or logistics job, such as Truck Driver.
- class google.cloud.talent_v4beta1.types.JobEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
- type_¶
Required. The type of the event (see [JobEventType][google.cloud.talent.v4beta1.JobEvent.JobEventType]).
- jobs¶
Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this event. For example, if this is an [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] event, this field contains the identifiers of all jobs shown to the job seeker. If this was a [view][google.cloud.talent.v4beta1.JobEvent.JobEventType.VIEW] event, this field contains the identifier of the viewed job.
The format is “projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}”, for example, “projects/foo/tenants/bar/jobs/baz”.
- Type
MutableSequence[str]
- profile¶
The [profile name][google.cloud.talent.v4beta1.Profile.name] associated with this client event.
The format is “projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}”, for example, “projects/foo/tenants/bar/profiles/baz”.
- Type
- class JobEventType(value)[source]¶
Bases:
proto.enums.EnumAn enumeration of an event attributed to the behavior of the end user, such as a job seeker.
- Values:
- JOB_EVENT_TYPE_UNSPECIFIED (0):
The event is unspecified by other provided values.
- IMPRESSION (1):
The job seeker or other entity interacting with the service has had a job rendered in their view, such as in a list of search results in a compressed or clipped format. This event is typically associated with the viewing of a jobs list on a single page by a job seeker.
- VIEW (2):
The job seeker, or other entity interacting with the service, has viewed the details of a job, including the full description. This event doesn’t apply to the viewing a snippet of a job appearing as a part of the job search results. Viewing a snippet is associated with an [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION]).
- VIEW_REDIRECT (3):
The job seeker or other entity interacting with the service performed an action to view a job and was redirected to a different website for job.
- APPLICATION_START (4):
The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.
- APPLICATION_FINISH (5):
The job seeker or other entity interacting with the service submitted an application for a job.
- APPLICATION_QUICK_SUBMISSION (6):
The job seeker or other entity interacting with the service submitted an application for a job with a single click without entering information. If a job seeker performs this action, send only this event to the service. Do not also send [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START] or [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] events.
- APPLICATION_REDIRECT (7):
The job seeker or other entity interacting with the service performed an action to apply to a job and was redirected to a different website to complete the application.
- APPLICATION_START_FROM_SEARCH (8):
The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job from the search results page without viewing the details of the job posting. If sending this event, JobEventType.VIEW event shouldn’t be sent.
- APPLICATION_REDIRECT_FROM_SEARCH (9):
The job seeker, or other entity interacting with the service, performs an action with a single click from the search results page to apply to a job (without viewing the details of the job posting), and is redirected to a different website to complete the application. If a candidate performs this action, send only this event to the service. Do not also send [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START], [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] or [JobEventType.VIEW][google.cloud.talent.v4beta1.JobEvent.JobEventType.VIEW] events.
- APPLICATION_COMPANY_SUBMIT (10):
This event should be used when a company submits an application on behalf of a job seeker. This event is intended for use by staffing agencies attempting to place candidates.
- BOOKMARK (11):
The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.
- NOTIFICATION (12):
The job seeker or other entity interacting with the service was sent a notification, such as an email alert or device notification, containing one or more jobs listings generated by the service.
- HIRED (13):
The job seeker or other entity interacting with the service was employed by the hiring entity (employer). Send this event only if the job seeker was hired through an application that was initiated by a search conducted through the Cloud Talent Solution service.
- SENT_CV (14):
A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.
- INTERVIEW_GRANTED (15):
The entity interacting with the service (for example, the job seeker), was granted an initial interview by the hiring entity (employer). This event should only be sent if the job seeker was granted an interview as part of an application that was initiated by a search conducted through / recommendation provided by the Cloud Talent Solution service.
- class google.cloud.talent_v4beta1.types.JobLevel(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents the required experience level required for the job.
- Values:
- JOB_LEVEL_UNSPECIFIED (0):
The default value if the level isn’t specified.
- ENTRY_LEVEL (1):
Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.
- EXPERIENCED (2):
Experienced individual contributors, typically with 2+ years of experience in a similar role.
- MANAGER (3):
Entry- to mid-level managers responsible for managing a team of people.
- DIRECTOR (4):
Senior-level managers responsible for managing teams of managers.
- EXECUTIVE (5):
Executive-level managers and above, including C-level positions.
- class google.cloud.talent_v4beta1.types.JobOperationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It’s used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.
- job_results¶
List of job mutation results from a batch mutate operation. It can change until operation status is FINISHED, FAILED or CANCELLED.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.JobOperationResult.JobResult]
- class JobResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMutation result of a job.
- job¶
Here [Job][google.cloud.talent.v4beta1.Job] only contains basic information including [name][google.cloud.talent.v4beta1.Job.name], [company][google.cloud.talent.v4beta1.Job.company], [language_code][google.cloud.talent.v4beta1.Job.language_code] and [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], use getJob method to retrieve detailed information of the created/updated job.
- status¶
The status of the job processed. This field is populated if the processing of the [job][google.cloud.talent.v4beta1.JobOperationResult.JobResult.job] fails.
- Type
google.rpc.status_pb2.Status
- class google.cloud.talent_v4beta1.types.JobQuery(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe query required to perform a search query.
- query¶
The query string that matches against the job title, description, and location fields.
The maximum number of allowed characters is 255.
- Type
- query_language_code¶
The language code of [query][google.cloud.talent.v4beta1.JobQuery.query]. For example, “en-US”. This field helps to better interpret the query.
If a value isn’t specified, the query language code is automatically detected, which may not be accurate.
Language code should be in BCP-47 format, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages.
- Type
- companies¶
This filter specifies the company entities to search against.
If a value isn’t specified, jobs are searched for against all companies.
If multiple values are specified, jobs are searched against the companies specified.
The format is “projects/{project_id}/tenants/{tenant_id}/companies/{company_id}”. For example, “projects/foo/tenants/bar/companies/baz”.
If tenant id is unspecified, the default tenant is used. For example, “projects/foo/companies/bar”.
At most 20 company filters are allowed.
- Type
MutableSequence[str]
- location_filters¶
The location filter specifies geo-regions containing the jobs to search against. See [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] for more information.
If a location value isn’t specified, jobs fitting the other search criteria are retrieved regardless of where they’re located.
If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the [LocationFilter.distance_in_miles][google.cloud.talent.v4beta1.LocationFilter.distance_in_miles] parameter, the maximum provided distance is used for all locations.
At most 5 location filters are allowed.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.LocationFilter]
- job_categories¶
The category filter specifies the categories of jobs to search against. See [JobCategory][google.cloud.talent.v4beta1.JobCategory] for more information.
If a value isn’t specified, jobs from any category are searched against.
If multiple values are specified, jobs from any of the specified categories are searched against.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.JobCategory]
- commute_filter¶
Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).
Note: This only works when you specify a [CommuteMethod][google.cloud.talent.v4beta1.CommuteMethod]. In this case, [location_filters][google.cloud.talent.v4beta1.JobQuery.location_filters] is ignored.
Currently we don’t support sorting by commute time.
- company_display_names¶
This filter specifies the company [Company.display_name][google.cloud.talent.v4beta1.Company.display_name] of the jobs to search against. The company name must match the value exactly.
Alternatively, the value being searched for can be wrapped in different match operators.
SUBSTRING_MATCH([value])The company name must contain a case insensitive substring match of the value. Using this function may increase latency.Sample Value:
SUBSTRING_MATCH(google)MULTI_WORD_TOKEN_MATCH([value])The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.Sample Value:
MULTI_WORD_TOKEN_MATCH(google)If a value isn’t specified, jobs within the search results are associated with any company.
If multiple values are specified, jobs within the search results may be associated with any of the specified companies.
At most 20 company display name filters are allowed.
- Type
MutableSequence[str]
- compensation_filter¶
This search filter is applied only to [Job.compensation_info][google.cloud.talent.v4beta1.Job.compensation_info]. For example, if the filter is specified as “Hourly job with per-hour compensation > $15”, only jobs meeting these criteria are searched. If a filter isn’t defined, all open jobs are searched.
- custom_attribute_filter¶
This filter specifies a structured syntax to match against the [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] marked as
filterable.The syntax for this expression is a subset of SQL syntax.
Supported operators are:
=,!=,<,<=,>, and>=where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash () and quote (“) characters.Supported functions are
LOWER([field_name])to perform a case insensitive match andEMPTY([field_name])to filter on the existence of a key.Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, “((A AND B AND C) OR NOT D) AND E”), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.
Sample Query:
(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10- Type
- disable_spell_check¶
This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, “enginee” is corrected to “engineer”.
Defaults to false: a spell check is performed.
- Type
- employment_types¶
The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL_TIME][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME].
If a value isn’t specified, jobs in the search results includes any employment type.
If multiple values are specified, jobs in the search results include any of the specified employment types.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.EmploymentType]
- language_codes¶
This filter specifies the locale of jobs to search against, for example, “en-US”.
If a value isn’t specified, the search results can contain jobs in any locale.
Language codes should be in BCP-47 format, such as “en-US” or “sr-Latn”. For more information, see Tags for Identifying Languages.
At most 10 language code filters are allowed.
- Type
MutableSequence[str]
- publish_time_range¶
Jobs published within a range specified by this filter are searched against.
- class google.cloud.talent_v4beta1.types.JobView(value)[source]¶
Bases:
proto.enums.EnumAn enum that specifies the job attributes that are returned in the [MatchingJob.job][google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob.job] or [ListJobsResponse.jobs][google.cloud.talent.v4beta1.ListJobsResponse.jobs] fields.
- Values:
- JOB_VIEW_UNSPECIFIED (0):
Default value.
- JOB_VIEW_ID_ONLY (1):
A ID only view of job, with following attributes: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code].
- JOB_VIEW_MINIMAL (2):
A minimal view of the job, with the following attributes: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.company][google.cloud.talent.v4beta1.Job.company], [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code].
- JOB_VIEW_SMALL (3):
A small view of the job, with the following attributes in the search results: [Job.name][google.cloud.talent.v4beta1.Job.name], [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.company][google.cloud.talent.v4beta1.Job.company], [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], [Job.visibility][google.cloud.talent.v4beta1.Job.visibility], [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], [Job.description][google.cloud.talent.v4beta1.Job.description].
- JOB_VIEW_FULL (4):
All available attributes are included in the search results.
- class google.cloud.talent_v4beta1.types.ListCompaniesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList companies for which the client has ACL visibility.
- parent¶
Required. Resource name of the tenant under which the company is created.
The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenant/bar”.
If tenant id is unspecified, the default tenant will be used, for example, “projects/foo”.
- Type
- page_size¶
The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
- Type
- class google.cloud.talent_v4beta1.types.ListCompaniesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe List companies response object.
- companies¶
Companies for the current client.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Company]
- metadata¶
Additional information for the API invocation, such as the request tracking id.
- class google.cloud.talent_v4beta1.types.ListJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList jobs request.
- parent¶
Required. The resource name of the tenant under which the job is created.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.
- Type
- filter¶
Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
The fields eligible for filtering are:
companyNamerequisitionIdstatusAvailable values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.
At least one of
companyNameandrequisitionIdmust present or an INVALID_ARGUMENT error is thrown.Sample Query:
companyName = “projects/foo/tenants/bar/companies/baz”
companyName = “projects/foo/tenants/bar/companies/baz” AND requisitionId = “req-1”
companyName = “projects/foo/tenants/bar/companies/baz” AND status = “EXPIRED”
requisitionId = “req-1”
requisitionId = “req-1” AND status = “EXPIRED”.
- Type
- page_size¶
The maximum number of jobs to be returned per page of results.
If [job_view][google.cloud.talent.v4beta1.ListJobsRequest.job_view] is set to [JobView.JOB_VIEW_ID_ONLY][google.cloud.talent.v4beta1.JobView.JOB_VIEW_ID_ONLY], the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100.
Default is 100 if empty or a number < 1 is specified.
- Type
- job_view¶
The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_FULL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_FULL] if no value is specified.
- class google.cloud.talent_v4beta1.types.ListJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList jobs response.
- jobs¶
The Jobs for a given company.
The maximum number of items returned is based on the limit field provided in the request.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Job]
- metadata¶
Additional information for the API invocation, such as the request tracking id.
- class google.cloud.talent_v4beta1.types.ListTenantsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageList tenants for which the client has ACL visibility.
- parent¶
Required. Resource name of the project under which the tenant is created.
The format is “projects/{project_id}”, for example, “projects/foo”.
- Type
- class google.cloud.talent_v4beta1.types.ListTenantsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe List tenants response object.
- tenants¶
Tenants for the current client.
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Tenant]
- metadata¶
Additional information for the API invocation, such as the request tracking id.
- class google.cloud.talent_v4beta1.types.Location(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource that represents a location with full geographic information.
- location_type¶
The type of a location, which corresponds to the address lines field of [google.type.PostalAddress][google.type.PostalAddress]. For example, “Downtown, Atlanta, GA, USA” has a type of [LocationType.NEIGHBORHOOD][google.cloud.talent.v4beta1.Location.LocationType.NEIGHBORHOOD], and “Kansas City, KS, USA” has a type of [LocationType.LOCALITY][google.cloud.talent.v4beta1.Location.LocationType.LOCALITY].
- postal_address¶
Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.
- Type
google.type.postal_address_pb2.PostalAddress
- lat_lng¶
An object representing a latitude/longitude pair.
- Type
google.type.latlng_pb2.LatLng
- radius_miles¶
Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from [google.type.LatLng][google.type.LatLng] covers the area associated with the job location. For example, currently, “Mountain View, CA, USA” has a radius of 6.17 miles.
- Type
- class LocationType(value)[source]¶
Bases:
proto.enums.EnumAn enum which represents the type of a location.
- Values:
- LOCATION_TYPE_UNSPECIFIED (0):
Default value if the type isn’t specified.
- COUNTRY (1):
A country level location.
- ADMINISTRATIVE_AREA (2):
A state or equivalent level location.
- SUB_ADMINISTRATIVE_AREA (3):
A county or equivalent level location.
- LOCALITY (4):
A city or equivalent level location.
- POSTAL_CODE (5):
A postal code level location.
- SUB_LOCALITY (6):
A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.
- SUB_LOCALITY_1 (7):
A district or equivalent level location.
- SUB_LOCALITY_2 (8):
A smaller district or equivalent level display.
- NEIGHBORHOOD (9):
A neighborhood level location.
- STREET_ADDRESS (10):
A street address level location.
- class google.cloud.talent_v4beta1.types.LocationFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGeographic region of the search.
- region_code¶
CLDR region code of the country/region. This field may be used in two ways:
If telecommute preference is not set, this field is used address ambiguity of the user-input address. For example, “Liverpool” may refer to “Liverpool, NY, US” or “Liverpool, UK”. This region code biases the address resolution toward a specific country or territory. If this field is not set, address resolution is biased toward the United States by default.
If telecommute preference is set to TELECOMMUTE_ALLOWED, the telecommute location filter will be limited to the region specified in this field. If this field is not set, the telecommute job locations will not be
See https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/territory_information.html for details. Example: “CH” for Switzerland.
- Type
- lat_lng¶
The latitude and longitude of the geographic center to search from. This field is ignored if
addressis provided.- Type
google.type.latlng_pb2.LatLng
- distance_in_miles¶
The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.
- Type
- telecommute_preference¶
Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location). [Job.posting_region][google.cloud.talent.v4beta1.Job.posting_region] indicates if a job permits telecommuting. If this field is set to [TelecommutePreference.TELECOMMUTE_ALLOWED][google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference.TELECOMMUTE_ALLOWED], telecommuting jobs are searched, and [address][google.cloud.talent.v4beta1.LocationFilter.address] and [lat_lng][google.cloud.talent.v4beta1.LocationFilter.lat_lng] are ignored. If not set or set to [TelecommutePreference.TELECOMMUTE_EXCLUDED][google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference.TELECOMMUTE_EXCLUDED], the telecommute status of the jobs is ignored. Jobs that have [PostingRegion.TELECOMMUTE][google.cloud.talent.v4beta1.PostingRegion.TELECOMMUTE] and have additional [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] may still be matched based on other location filters using [address][google.cloud.talent.v4beta1.LocationFilter.address] or [latlng][].
This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as “Mountain View” or “telecommuting” jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response.
This field is only used for job search requests.
- negated¶
Whether to apply negation to the filter so profiles matching the filter are excluded.
- Type
- class TelecommutePreference(value)[source]¶
Bases:
proto.enums.EnumSpecify whether to include telecommute jobs.
- Values:
- TELECOMMUTE_PREFERENCE_UNSPECIFIED (0):
Default value if the telecommute preference isn’t specified.
- TELECOMMUTE_EXCLUDED (1):
Deprecated: Ignore telecommute status of jobs. Use TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute jobs.
- TELECOMMUTE_ALLOWED (2):
Allow telecommute jobs.
- TELECOMMUTE_JOBS_EXCLUDED (3):
Exclude telecommute jobs.
- class google.cloud.talent_v4beta1.types.PostingRegion(value)[source]¶
Bases:
proto.enums.EnumAn enum that represents the job posting region. In most cases, job postings don’t need to specify a region. If a region is given, jobs are eligible for searches in the specified region.
- Values:
- POSTING_REGION_UNSPECIFIED (0):
If the region is unspecified, the job is only returned if it matches the [LocationFilter][google.cloud.talent.v4beta1.LocationFilter].
- ADMINISTRATIVE_AREA (1):
In addition to exact location matching, job posting is returned when the [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in the search query is in the same administrative area as the returned job posting. For example, if a
ADMINISTRATIVE_AREAjob is posted in “CA, USA”, it’s returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has “Mountain View”.Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.
- NATION (2):
In addition to exact location matching, job is returned when [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in search query is in the same country as this job. For example, if a
NATION_WIDEjob is posted in “USA”, it’s returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has ‘Mountain View’.- TELECOMMUTE (3):
Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed.
- class google.cloud.talent_v4beta1.types.RequestMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMeta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.
- domain¶
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or
false.The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run.
For example, if the service is being run by client Foo, Inc., on job board www.foo.com and career site www.bar.com, then this field is set to “foo.com” for use on the job board, and “bar.com” for use on the career site.
Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain.
The maximum number of allowed characters is 255.
- Type
- session_id¶
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or
false.A unique session identification string. A session is defined as the duration of an end user’s interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service.
Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID.
The maximum number of allowed characters is 255.
- Type
- user_id¶
Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or
false.A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service.
Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID.
The maximum number of allowed characters is 255.
- Type
- allow_missing_ids¶
Only set when any of [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] isn’t available for some reason. It is highly recommended not to set this field and provide accurate [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] for the best service experience.
- Type
- device_info¶
The type of device used by the job seeker at the time of the call to the service.
- class google.cloud.talent_v4beta1.types.ResponseMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAdditional information returned to client, such as debugging information.
- class google.cloud.talent_v4beta1.types.SearchJobsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Request body of the
SearchJobscall.- parent¶
Required. The resource name of the tenant to search within.
The format is “projects/{project_id}/tenants/{tenant_id}”. For example, “projects/foo/tenant/bar”. If tenant id is unspecified, a default tenant is created. For example, “projects/foo”.
- Type
- search_mode¶
Mode of a search.
Defaults to [SearchMode.JOB_SEARCH][google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode.JOB_SEARCH].
- request_metadata¶
Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as
user_id) are provided by users, and must be unique and consistent.
- job_query¶
Query used to search against jobs, such as keyword, location filters, etc.
- enable_broadening¶
Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list.
Defaults to false.
- Type
- histogram_queries¶
An expression specifies a histogram request against matching jobs.
Expression syntax is an aggregation function call with histogram facets and other options.
Available aggregation function calls are:
count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value.count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket.
A maximum of 200 histogram buckets are supported.
Data types:
Histogram facet: facet names with format
[a-zA-Z][a-zA-Z0-9_]+.String: string like “any string with backslash escape for quote(“).”
Number: whole number and floating point number like 10, -1 and -0.01.
List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and [“one”, “two”, “three”].
Built-in constants:
MIN (minimum number similar to java Double.MIN_VALUE)
MAX (maximum number similar to java Double.MAX_VALUE)
Built-in functions:
bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, “positive number”) or bucket(1, 10).
Job histogram facets:
company_display_name: histogram by [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name].
employment_type: histogram by [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types], for example, “FULL_TIME”, “PART_TIME”.
company_size (DEPRECATED): histogram by [CompanySize][google.cloud.talent.v4beta1.CompanySize], for example, “SMALL”, “MEDIUM”, “BIG”.
publish_time_in_day: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] in days. Must specify list of numeric buckets in spec.
publish_time_in_month: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] in months. Must specify list of numeric buckets in spec.
publish_time_in_year: histogram by the [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] in years. Must specify list of numeric buckets in spec.
degree_types: histogram by the [Job.degree_types][google.cloud.talent.v4beta1.Job.degree_types], for example, “Bachelors”, “Masters”.
job_level: histogram by the [Job.job_level][google.cloud.talent.v4beta1.Job.job_level], for example, “Entry Level”.
country: histogram by the country code of jobs, for example, “US”, “FR”.
admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, “CA”, “IL”.
city: histogram by a combination of the “city name, admin1 code”. For example, “Mountain View, CA”, “New York, NY”.
admin1_country: histogram by a combination of the “admin1 code, country”, for example, “CA, US”, “IL, US”.
city_coordinate: histogram by the city center’s GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically.
locale: histogram by the [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], for example, “en-US”, “fr-FR”.
language: histogram by the language subtag of the [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], for example, “en”, “fr”.
category: histogram by the [JobCategory][google.cloud.talent.v4beta1.JobCategory], for example, “COMPUTER_AND_IT”, “HEALTHCARE”.
base_compensation_unit: histogram by the [CompensationInfo.CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit] of base salary, for example, “WEEKLY”, “MONTHLY”.
base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by.
annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by.
annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by.
string_custom_attribute: histogram by string [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes]. Values can be accessed via square bracket notations like string_custom_attribute[“key1”].
numeric_custom_attribute: histogram by numeric [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes]. Values can be accessed via square bracket notations like numeric_custom_attribute[“key1”]. Must specify list of numeric buckets to group results by.
Example expressions:
count(admin1)count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])count(string_custom_attribute["some-string-custom-attribute"])count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
- Type
MutableSequence[google.cloud.talent_v4beta1.types.HistogramQuery]
- job_view¶
The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB_VIEW_SMALL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_SMALL] if no value is specified.
- offset¶
An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.talent.v4beta1.SearchJobsRequest.page_token] is unset.
The maximum allowed value is 5000. Otherwise an error is thrown.
For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
- Type
- page_size¶
A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
- Type
- page_token¶
The token specifying the current offset within search results. See [SearchJobsResponse.next_page_token][google.cloud.talent.v4beta1.SearchJobsResponse.next_page_token] for an explanation of how to obtain the next set of query results.
- Type
- order_by¶
The criteria determining how search results are sorted. Default is
"relevance desc".Supported options are:
"relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering."posting_publish_time desc": By [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] descending."posting_update_time desc": By [Job.posting_update_time][google.cloud.talent.v4beta1.Job.posting_update_time] descending."title": By [Job.title][google.cloud.talent.v4beta1.Job.title] ascending."title desc": By [Job.title][google.cloud.talent.v4beta1.Job.title] descending."annualized_base_compensation": By job’s [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results."annualized_base_compensation desc": By job’s [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results."annualized_total_compensation": By job’s [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results."annualized_total_compensation desc": By job’s [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] descending. Jobs whose annualized base compensation is unspecified are put at the end of search results."custom_ranking desc": By the relevance score adjusted to the [SearchJobsRequest.CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] with weight factor assigned by [SearchJobsRequest.CustomRankingInfo.importance_level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.importance_level] in descending order.Location sorting: Use the special syntax to order jobs by distance:
"distance_from('Hawaii')": Order by distance from Hawaii."distance_from(19.89, 155.5)": Order by distance from a coordinate."distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below."distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don’t have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in [diversification_level][google.cloud.talent.v4beta1.SearchJobsRequest.diversification_level].
- Type
- diversification_level¶
Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.
Defaults to [DiversificationLevel.SIMPLE][google.cloud.talent.v4beta1.SearchJobsRequest.DiversificationLevel.SIMPLE] if no value is specified.
- custom_ranking_info¶
Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
- disable_keyword_match¶
This field is deprecated. Please use [SearchJobsRequest.keyword_match_mode][google.cloud.talent.v4beta1.SearchJobsRequest.keyword_match_mode] going forward.
To migrate, disable_keyword_match set to false maps to [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4beta1.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL], and disable_keyword_match set to true maps to [KeywordMatchMode.KEYWORD_MATCH_DISABLED][google.cloud.talent.v4beta1.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_DISABLED]. If [SearchJobsRequest.keyword_match_mode][google.cloud.talent.v4beta1.SearchJobsRequest.keyword_match_mode] is set, this field is ignored.
Controls whether to disable exact keyword match on [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.description][google.cloud.talent.v4beta1.Job.description], [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name], [Job.addresses][google.cloud.talent.v4beta1.Job.addresses], [Job.qualifications][google.cloud.talent.v4beta1.Job.qualifications]. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query “program manager,” a result is returned even if the job posting has the title “software developer,” which doesn’t fall into “program manager” ontology, but does have “program manager” appearing in its description.
For queries like “cloud” that don’t contain title or location specific ontology, jobs with “cloud” keyword matches are returned regardless of this flag’s value.
Use [Company.keyword_searchable_job_custom_attributes][google.cloud.talent.v4beta1.Company.keyword_searchable_job_custom_attributes] if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests.
Defaults to false.
- Type
- keyword_match_mode¶
Controls what keyword match options to use.
Defaults to [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4beta1.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL] if no value is specified.
- class CustomRankingInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCustom ranking information for [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
- importance_level¶
Required. Controls over how important the score of [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] gets applied to job’s final ranking position.
An error is thrown if not specified.
- ranking_expression¶
Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job’s final ranking position.
The syntax for this expression is a subset of Google SQL syntax.
Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] key, integer/double value or an expression that can be evaluated to a number.
Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length.
The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results.
Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)
- Type
- class ImportanceLevel(value)[source]¶
Bases:
proto.enums.EnumThe importance level for [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression].
- Values:
- IMPORTANCE_LEVEL_UNSPECIFIED (0):
Default value if the importance level isn’t specified.
- NONE (1):
The given ranking expression is of None importance, existing relevance score (determined by API algorithm) dominates job’s final ranking position.
- LOW (2):
The given ranking expression is of Low importance in terms of job’s final ranking position compared to existing relevance score (determined by API algorithm).
- MILD (3):
The given ranking expression is of Mild importance in terms of job’s final ranking position compared to existing relevance score (determined by API algorithm).
- MEDIUM (4):
The given ranking expression is of Medium importance in terms of job’s final ranking position compared to existing relevance score (determined by API algorithm).
- HIGH (5):
The given ranking expression is of High importance in terms of job’s final ranking position compared to existing relevance score (determined by API algorithm).
- EXTREME (6):
The given ranking expression is of Extreme importance, and dominates job’s final ranking position with existing relevance score (determined by API algorithm) ignored.
- class DiversificationLevel(value)[source]¶
Bases:
proto.enums.EnumControls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.
- Values:
- DIVERSIFICATION_LEVEL_UNSPECIFIED (0):
The diversification level isn’t specified.
- DISABLED (1):
Disables diversification. Jobs that would normally be pushed to the last page would not have their positions altered. This may result in highly similar jobs appearing in sequence in the search results.
- SIMPLE (2):
Default diversifying behavior. The result list is ordered so that highly similar results are pushed to the end of the last page of search results. If you are using pageToken to page through the result set, latency might be lower but we can’t guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned.
- class KeywordMatchMode(value)[source]¶
Bases:
proto.enums.EnumControls what keyword matching behavior the search has. When keyword matching is enabled, a keyword match returns jobs that may not match given category filters when there are matching keywords. For example, for the query “program manager” with KeywordMatchMode set to KEYWORD_MATCH_ALL, a job posting with the title “software developer,” which doesn’t fall into “program manager” ontology, and “program manager” appearing in its description will be surfaced.
For queries like “cloud” that don’t contain title or location specific ontology, jobs with “cloud” keyword matches are returned regardless of this enum’s value.
Use [Company.keyword_searchable_job_custom_attributes][google.cloud.talent.v4beta1.Company.keyword_searchable_job_custom_attributes] if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests.
- Values:
- KEYWORD_MATCH_MODE_UNSPECIFIED (0):
The keyword match option isn’t specified. Defaults to [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4beta1.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL] behavior.
- KEYWORD_MATCH_DISABLED (1):
Disables keyword matching.
- KEYWORD_MATCH_ALL (2):
Enable keyword matching over [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.description][google.cloud.talent.v4beta1.Job.description], [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name], [Job.addresses][google.cloud.talent.v4beta1.Job.addresses], [Job.qualifications][google.cloud.talent.v4beta1.Job.qualifications], and keyword searchable [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] fields.
- KEYWORD_MATCH_TITLE_ONLY (3):
Only enable keyword matching over [Job.title][google.cloud.talent.v4beta1.Job.title].
- class SearchMode(value)[source]¶
Bases:
proto.enums.EnumA string-represented enumeration of the job search mode. The service operate differently for different modes of service.
- Values:
- SEARCH_MODE_UNSPECIFIED (0):
The mode of the search method isn’t specified. The default search behavior is identical to JOB_SEARCH search behavior.
- JOB_SEARCH (1):
The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.
- FEATURED_JOB_SEARCH (2):
The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn’t return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.
- class google.cloud.talent_v4beta1.types.SearchJobsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for SearchJob method.
- matching_jobs¶
The Job entities that match the specified [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
- Type
MutableSequence[google.cloud.talent_v4beta1.types.SearchJobsResponse.MatchingJob]
- histogram_query_results¶
The histogram results that match with specified [SearchJobsRequest.histogram_queries][google.cloud.talent.v4beta1.SearchJobsRequest.histogram_queries].
- Type
MutableSequence[google.cloud.talent_v4beta1.types.HistogramQueryResult]
- next_page_token¶
The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
- Type
- location_filters¶
The location filters that the service applied to the specified query. If any filters are lat-lng based, the [Location.location_type][google.cloud.talent.v4beta1.Location.location_type] is [Location.LocationType.LOCATION_TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.Location.LocationType.LOCATION_TYPE_UNSPECIFIED].
- Type
MutableSequence[google.cloud.talent_v4beta1.types.Location]
- estimated_total_size¶
An estimation of the number of jobs that match the specified query.
This number isn’t guaranteed to be accurate. For accurate results, see [SearchJobsResponse.total_size][google.cloud.talent.v4beta1.SearchJobsResponse.total_size].
- Type
- metadata¶
Additional information for the API invocation, such as the request tracking id.
- broadened_query_jobs_count¶
If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn’t set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.
- Type
- spell_correction¶
The spell checking result, and correction.
- class CommuteInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCommute details related to this job.
- job_location¶
Location used as the destination in the commute calculation.
- travel_duration¶
The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn’t reachable within the requested duration, but was returned as part of an expanded query.
- class MatchingJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJob entry with metadata inside [SearchJobsResponse][google.cloud.talent.v4beta1.SearchJobsResponse].
- job¶
Job resource that matches the specified [SearchJobsRequest][google.cloud.talent.v4beta1.SearchJobsRequest].
- job_summary¶
A summary of the job with core information that’s displayed on the search results listing page.
- Type
- job_title_snippet¶
Contains snippets of text from the [Job.title][google.cloud.talent.v4beta1.Job.title] field most closely matching a search query’s keywords, if available. The matching query keywords are enclosed in HTML bold tags.
- Type
- search_text_snippet¶
Contains snippets of text from the [Job.description][google.cloud.talent.v4beta1.Job.description] and similar fields that most closely match a search query’s keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.
- Type
- commute_info¶
Commute information which is generated based on specified [CommuteFilter][google.cloud.talent.v4beta1.CommuteFilter].
- class google.cloud.talent_v4beta1.types.SpellingCorrection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageSpell check result.
- corrected_html¶
Corrected output with html tags to highlight the corrected words. Corrected words are called out with the “<b><i>…</i></b>” html tags.
For example, the user input query is “software enginear”, where the second word, “enginear,” is incorrect. It should be “engineer”. When spelling correction is enabled, this value is “software <b><i>engineer</i></b>”.
- Type
- class google.cloud.talent_v4beta1.types.Tenant(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups.
- name¶
Required during tenant update.
The resource name for a tenant. This is generated by the service when a tenant is created.
The format is “projects/{project_id}/tenants/{tenant_id}”, for example, “projects/foo/tenants/bar”.
- Type
- external_id¶
Required. Client side tenant identifier, used to uniquely identify the tenant.
The maximum number of allowed characters is 255.
- Type
- usage_type¶
Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.
Defaults behavior is [DataUsageType.ISOLATED][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED] if it’s unset.
- keyword_searchable_profile_custom_attributes¶
A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose corresponding
string_valuesare used in keyword searches. Profiles withstring_valuesunder these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and must be surrounded by quotes.- Type
MutableSequence[str]
- class DataUsageType(value)[source]¶
Bases:
proto.enums.EnumEnum that represents how user data owned by the tenant is used.
- Values:
- DATA_USAGE_TYPE_UNSPECIFIED (0):
Default value.
- AGGREGATED (1):
Data owned by this tenant is used to improve search/recommendation quality across tenants.
- ISOLATED (2):
Data owned by this tenant is used to improve search/recommendation quality for this tenant only.
- class google.cloud.talent_v4beta1.types.TimestampRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessage representing a period of time between two timestamps.
- start_time¶
Begin of the period (inclusive).
- end_time¶
End of the period (exclusive).
- class google.cloud.talent_v4beta1.types.UpdateCompanyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for updating a specified company.
- company¶
Required. The company resource to replace the current resource in the system.
- update_mask¶
Strongly recommended for the best service experience.
If [update_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.update_mask] is provided, only the specified fields in [company][google.cloud.talent.v4beta1.UpdateCompanyRequest.company] are updated. Otherwise all the fields are updated.
A field mask to specify the company fields to be updated. Only top level fields of [Company][google.cloud.talent.v4beta1.Company] are supported.
- class google.cloud.talent_v4beta1.types.UpdateJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageUpdate job request.
- job¶
Required. The Job to be updated.
- update_mask¶
Strongly recommended for the best service experience.
If [update_mask][google.cloud.talent.v4beta1.UpdateJobRequest.update_mask] is provided, only the specified fields in [job][google.cloud.talent.v4beta1.UpdateJobRequest.job] are updated. Otherwise all the fields are updated.
A field mask to restrict the fields that are updated. Only top level fields of [Job][google.cloud.talent.v4beta1.Job] are supported.
- class google.cloud.talent_v4beta1.types.UpdateTenantRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for updating a specified tenant.
- tenant¶
Required. The tenant resource to replace the current resource in the system.
- update_mask¶
Strongly recommended for the best service experience.
If [update_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask] is provided, only the specified fields in [tenant][google.cloud.talent.v4beta1.UpdateTenantRequest.tenant] are updated. Otherwise all the fields are updated.
A field mask to specify the tenant fields to be updated. Only top level fields of [Tenant][google.cloud.talent.v4beta1.Tenant] are supported.
- class google.cloud.talent_v4beta1.types.Visibility(value)[source]¶
Bases:
proto.enums.EnumDeprecated. All resources are only visible to the owner.
An enum that represents who has view access to the resource.
- Values:
- VISIBILITY_UNSPECIFIED (0):
Default value.
- ACCOUNT_ONLY (1):
The resource is only visible to the GCP account who owns it.
- SHARED_WITH_GOOGLE (2):
The resource is visible to the owner and may be visible to other applications and processes at Google.
- SHARED_WITH_PUBLIC (3):
The resource is visible to the owner and may be visible to all other API clients.
