API documentation for talent_v4beta1.types package.
Classes
Activity
Resource that represents an individual or collaborative activity participated in by a candidate, for example, an open- source project, a class assignment, and so on.
AdditionalContactInfo
Resource that represents contact information other than phone, email, URI and addresses.
Address
Resource that represents a address. .. attribute:: usage
The usage of the address. For example, SCHOOL, WORK, PERSONAL.
Application
Resource that represents a job application record of a candidate.
ApplicationDateFilter
Application Date Range Filter.
The API matches profiles with Application.application_date between start date and end date (both boundaries are inclusive). The filter is ignored if both start_date and end_date are missing.
ApplicationJobFilter
Filter on the job information of Application. .. attribute:: job_requisition_id
The job requisition id in the application. The API does an exact match on the Job.requisition_id of Application.job in profiles.
:type: str
ApplicationOutcomeNotesFilter
Outcome Notes Filter. .. attribute:: outcome_notes
Required. User entered or selected outcome reason. The API does an exact match on the Application.outcome_notes in profiles.
:type: str
AvailabilityFilter
Filter on availability signals. .. attribute:: signal_type
Required. Type of signal to apply filter on.
:type: google.cloud.talent_v4beta1.types.AvailabilitySignalType
AvailabilitySignal
Candidate availability signal. .. attribute:: type_
Type of signal.
:type: google.cloud.talent_v4beta1.types.AvailabilitySignalType
AvailabilitySignalType
The type of candidate availability signal.
BatchCreateJobsRequest
Request to create a batch of jobs. .. attribute:: 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: str
BatchDeleteJobsRequest
Batch delete jobs request. .. attribute:: 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: str
BatchOperationMetadata
Metadata used for long running operations returned by CTS batch
APIs. It's used to replace
google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].
BatchUpdateJobsRequest
Request to update a batch of jobs. .. attribute:: 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: str
CandidateAvailabilityFilter
Deprecated. Use AvailabilityFilter instead. Filter on availability signals.
Certification
Resource that represents a license or certification. .. attribute:: display_name
Name of license or certification. Number of characters allowed is 100.
:type: str
ClientEvent
An 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.
CommuteFilter
Parameters needed for commute search. .. attribute:: commute_method
Required. The method of transportation to calculate the commute time for.
CommuteMethod
Method for commute.
Company
A 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.
CompanySize
An enum that represents the size of the company.
CompensationFilter
Filter on job compensation type and amount. .. attribute:: type_
Required. Type of filter.
:type: google.cloud.talent_v4beta1.types.CompensationFilter.FilterType
CompensationInfo
Job compensation details. .. attribute:: entries
Job compensation information.
At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as base compensation entry for the job.
:type: Sequence[google.cloud.talent_v4beta1.types.CompensationInfo.CompensationEntry]
CompleteQueryRequest
Auto-complete parameters. .. attribute:: 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: str
CompleteQueryResponse
Response of auto-complete query. .. attribute:: completion_results
Results of the matching job/company candidates.
:type: Sequence[google.cloud.talent_v4beta1.types.CompleteQueryResponse.CompletionResult]
ContactInfoUsage
Enum that represents the usage of the contact information.
CreateApplicationRequest
The Request of the CreateApplication method. .. attribute:: parent
Required. Resource name of the profile under which the application is created.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
:type: str
CreateClientEventRequest
The report event request. .. attribute:: 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: str
CreateCompanyRequest
The Request of the CreateCompany method. .. attribute:: 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: str
CreateJobRequest
Create job request. .. attribute:: 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: str
CreateProfileRequest
Create profile request. .. attribute:: parent
Required. The name of the tenant this profile belongs to.
The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
:type: str
CreateTenantRequest
The Request of the CreateTenant method. .. attribute:: parent
Required. Resource name of the project under which the tenant is created.
The format is "projects/{project_id}", for example, "projects/foo".
:type: str
CustomAttribute
Custom attribute values that are either filterable or non- ilterable.
Degree
Resource that represents a degree pursuing or acquired by a candidate.
DegreeType
Educational degree level defined in International Standard Classification of Education (ISCED).
DeleteApplicationRequest
Request to delete a application. .. attribute:: name
Required. The resource name of the application to be deleted.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
:type: str
DeleteCompanyRequest
Request to delete a company. .. attribute:: 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: str
DeleteJobRequest
Delete job request. .. attribute:: name
Required. The resource name of the job to be deleted.
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".
:type: str
DeleteProfileRequest
Delete profile request. .. attribute:: name
Required. Resource name of the profile to be deleted.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
:type: str
DeleteTenantRequest
Request to delete a tenant. .. attribute:: name
Required. The resource name of the tenant to be deleted.
The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
:type: str
DeviceInfo
Device 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.
EducationFilter
Education filter of the search. .. attribute:: school
The school name. For example "MIT", "University of California, Berkeley".
:type: str
EducationRecord
Resource that represents an education record of a candidate. .. attribute:: start_date
The start date of the education.
:type: google.type.date_pb2.Date
Resource that represents a person's email address. .. attribute:: usage
The usage of the email address. For example, SCHOOL, WORK, PERSONAL.
EmployerFilter
Employer filter of the search. .. attribute:: employer
Required. The name of the employer, for example "Google", "Alphabet".
:type: str
EmploymentRecord
Resource that represents an employment record of a candidate. .. attribute:: start_date
Start date of the employment.
:type: google.type.date_pb2.Date
EmploymentType
An enum that represents the employment type of a job.
GetApplicationRequest
Request for getting a application by name. .. attribute:: name
Required. The resource name of the application to be retrieved.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
:type: str
GetCompanyRequest
Request for getting a company by name. .. attribute:: 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: str
GetJobRequest
Get job request. .. attribute:: name
Required. The resource name of the job to retrieve.
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".
:type: str
GetProfileRequest
Get profile request. .. attribute:: name
Required. Resource name of the profile to get.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".
:type: str
GetTenantRequest
Request for getting a tenant by name. .. attribute:: name
Required. The resource name of the tenant to be retrieved.
The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".
:type: str
HistogramQuery
The histogram request. .. attribute:: histogram_query
An expression specifies a histogram request against matching resources (for example, jobs, profiles) for searches.
See SearchJobsRequest.histogram_queries and SearchProfilesRequest.histogram_queries for details about syntax.
:type: str
HistogramQueryResult
Histogram result that matches HistogramQuery specified in searches.
HtmlSanitization
Option 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.
Interview
Details of an interview. .. attribute:: rating
The rating on this interview.
Job
A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.
JobBenefit
An enum that represents employee benefits included with the job.
JobCategory
An 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.
JobEvent
An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.
JobLevel
An enum that represents the required experience level required for the job.
JobOperationResult
The result of
JobService.BatchCreateJobs
or
JobService.BatchUpdateJobs
APIs. It's used to replace
google.longrunning.Operation.response][google.longrunning.Operation.response]
in case of success.
JobQuery
The query required to perform a search query. .. attribute:: query
The query string that matches against the job title, description, and location fields.
The maximum number of allowed characters is 255.
:type: str
JobTitleFilter
Job title of the search. .. attribute:: job_title
Required. The job title. For example, "Software engineer", or "Product manager".
:type: str
JobView
An enum that specifies the job attributes that are returned in the MatchingJob.job or ListJobsResponse.jobs fields.
ListApplicationsRequest
List applications for which the client has ACL visibility. .. attribute:: parent
Required. Resource name of the profile under which the application is created.
The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz".
:type: str
ListApplicationsResponse
The List applications response object. .. attribute:: applications
Applications for the current client.
:type: Sequence[google.cloud.talent_v4beta1.types.Application]
ListCompaniesRequest
List companies for which the client has ACL visibility. .. attribute:: 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: str
ListCompaniesResponse
The List companies response object. .. attribute:: companies
Companies for the current client.
:type: Sequence[google.cloud.talent_v4beta1.types.Company]
ListJobsRequest
List jobs request. .. attribute:: 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: str
ListJobsResponse
List jobs response. .. attribute:: jobs
The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
:type: Sequence[google.cloud.talent_v4beta1.types.Job]
ListProfilesRequest
List profiles request. .. attribute:: parent
Required. The resource name of the tenant under which the profile is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
:type: str
ListProfilesResponse
The List profiles response object. .. attribute:: profiles
Profiles for the specific tenant.
:type: Sequence[google.cloud.talent_v4beta1.types.Profile]
ListTenantsRequest
List tenants for which the client has ACL visibility. .. attribute:: parent
Required. Resource name of the project under which the tenant is created.
The format is "projects/{project_id}", for example, "projects/foo".
:type: str
ListTenantsResponse
The List tenants response object. .. attribute:: tenants
Tenants for the current client.
:type: Sequence[google.cloud.talent_v4beta1.types.Tenant]
Location
A resource that represents a location with full geographic information.
LocationFilter
Geographic region of the search. .. attribute:: address
The address name, such as "Mountain View" or "Bay Area".
:type: str
Outcome
The overall outcome /decision / result indicator.
Patent
Resource that represents the patent acquired by a candidate. .. attribute:: display_name
Name of the patent. Number of characters allowed is 100.
:type: str
PersonName
Resource that represents the name of a person. .. attribute:: formatted_name
A string represents a person's full name. For example, "Dr. John Smith". Number of characters allowed is 100.
:type: str
PersonNameFilter
Filter on person name. .. attribute:: person_name
Required. The person name. For example, "John Smith".
Can be any combination of [PersonName.structured_name.given_name][], [PersonName.structured_name.middle_initial][], [PersonName.structured_name.family_name][], and PersonName.formatted_name.
:type: str
PersonalUri
Resource that represents a valid URI for a personal use. .. attribute:: uri
The personal URI. Number of characters allowed is 4,000.
:type: str
Phone
Resource that represents a person's telephone number. .. attribute:: usage
The usage of the phone. For example, SCHOOL, WORK, PERSONAL.
PostingRegion
An 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.
Profile
A resource that represents the profile for a job candidate (also referred to as a "single-source profile").
ProfileEvent
An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution.
ProfileQuery
Filters to apply when performing the search query. .. attribute:: query
Keywords to match any text fields of profiles. For example, "software engineer in Palo Alto".
:type: str
Publication
Resource that represents a publication resource of a candidate.
Rating
The details of the score received for an assessment or interview.
RequestMetadata
Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.
ResponseMetadata
Additional information returned to client, such as debugging information.
Resume
Resource that represents a resume. .. attribute:: structured_resume
Users can create a profile with only this field field, if resume_type is HRXML. For example, the API parses this field and creates a profile with all structured fields populated. EmploymentRecord, EducationRecord, and so on. An error is thrown if this field cannot be parsed.
Note that the use of the functionality offered by this field to extract data from resumes is an Alpha feature and as such is not covered by any SLA.
:type: str
SearchJobsRequest
The Request body of the SearchJobs call.
.. attribute:: 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: str
SearchJobsResponse
Response for SearchJob method. .. attribute:: matching_jobs
The Job entities that match the specified SearchJobsRequest.
:type: Sequence[google.cloud.talent_v4beta1.types.SearchJobsResponse.MatchingJob]
SearchProfilesRequest
The request body of the SearchProfiles call.
.. attribute:: parent
Required. The resource name of the tenant to search within.
The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
:type: str
SearchProfilesResponse
Response of SearchProfiles method. .. attribute:: estimated_total_size
An estimation of the number of profiles that match the specified query. This number isn't guaranteed to be accurate.
:type: int
Skill
Resource that represents a skill of a candidate. .. attribute:: display_name
Skill display name. For example, "Java", "Python".
Number of characters allowed is 100.
:type: str
SkillFilter
Skill filter of the search. .. attribute:: skill
Required. The skill name. For example, "java", "j2ee", and so on.
:type: str
SkillProficiencyLevel
Enum that represents the skill proficiency level.
SpellingCorrection
Spell check result. .. attribute:: corrected
Indicates if the query was corrected by the spell checker.
:type: bool
SummarizedProfile
Profile entry with metadata inside SearchProfilesResponse.
Tenant
A 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.
TimeFilter
Filter on create timestamp or update timestamp of profiles. .. attribute:: start_time
Start timestamp, matching profiles with the start time. If this field missing, The API matches profiles with create / update timestamp before the end timestamp.
:type: google.protobuf.timestamp_pb2.Timestamp
TimestampRange
Message representing a period of time between two timestamps. .. attribute:: start_time
Begin of the period (inclusive).
:type: google.protobuf.timestamp_pb2.Timestamp
UpdateApplicationRequest
Request for updating a specified application. .. attribute:: application
Required. The application resource to replace the current resource in the system.
UpdateCompanyRequest
Request for updating a specified company. .. attribute:: company
Required. The company resource to replace the current resource in the system.
UpdateJobRequest
Update job request. .. attribute:: job
Required. The Job to be updated.
UpdateProfileRequest
Update profile request .. attribute:: profile
Required. Profile to be updated.
UpdateTenantRequest
Request for updating a specified tenant. .. attribute:: tenant
Required. The tenant resource to replace the current resource in the system.
Visibility
Deprecated. All resources are only visible to the owner. An enum that represents who has view access to the resource.
WorkExperienceFilter
Work experience filter.
This filter is used to search for profiles with working experience length between min_experience and max_experience.