Package types (2.3.0)

API documentation for talent_v4.types package.

Classes

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/tenants/bar".

:type: str

BatchCreateJobsResponse

The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

BatchDeleteJobsRequest

Request to delete 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/tenants/bar".

The parent of all of the jobs specified in names must match this field.

:type: str

BatchDeleteJobsResponse

The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

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/tenants/bar".

:type: str

BatchUpdateJobsResponse

The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success.

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.

:type: google.cloud.talent_v4.types.CommuteMethod

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_v4.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_v4.types.CompensationInfo.CompensationEntry]

CompleteQueryRequest

Auto-complete parameters. .. attribute:: tenant

Required. Resource name of tenant the completion is performed within.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

:type: str

CompleteQueryResponse

Response of auto-complete query. .. attribute:: completion_results

Results of the matching job/company candidates.

:type: Sequence[google.cloud.talent_v4.types.CompleteQueryResponse.CompletionResult]

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/tenants/bar".

: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/tenants/bar".

: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/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.

DegreeType

Educational degree level defined in International Standard Classification of Education (ISCED).

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".

: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".

: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.

EmploymentType

An enum that represents the employment type of a job.

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".

: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".

: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 jobs for searches.

See SearchJobsRequest.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.

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.

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

JobResult

Mutation result of a job from a batch operation. .. attribute:: job

Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job.

:type: google.cloud.talent_v4.types.Job

JobView

An enum that specifies the job attributes that are returned in the MatchingJob.job or ListJobsResponse.jobs fields.

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/tenants/bar".

:type: str

ListCompaniesResponse

The List companies response object. .. attribute:: companies

Companies for the current client.

:type: Sequence[google.cloud.talent_v4.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/tenants/bar".

: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_v4.types.Job]

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_v4.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

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.

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.

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/tenants/bar".

:type: str

SearchJobsResponse

Response for SearchJob method. .. attribute:: matching_jobs

The Job entities that match the specified SearchJobsRequest.

:type: Sequence[google.cloud.talent_v4.types.SearchJobsResponse.MatchingJob]

SpellingCorrection

Spell check result. .. attribute:: corrected

Indicates if the query was corrected by the spell checker.

:type: bool

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 jobs. Customer may create multiple tenants to provide data isolation for different groups.