From 8a6b60c5737e14fd3f0ba88ef99901ab84e8878a Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Mon, 5 Oct 2020 13:15:06 -0700 Subject: [PATCH] feat(jobs)!: update the API BREAKING CHANGE: This release has breaking changes. #### jobs:v3p1beta1 The following keys were deleted: - schemas.CompensationFilter.properties.units.enumDescriptions - schemas.HistogramFacets.properties.simpleHistogramFacets.enumDescriptions - schemas.Job.properties.degreeTypes.enumDescriptions - schemas.Job.properties.employmentTypes.enumDescriptions - schemas.Job.properties.jobBenefits.enumDescriptions - schemas.JobDerivedInfo.properties.jobCategories.enumDescriptions - schemas.JobQuery.properties.employmentTypes.enumDescriptions - schemas.JobQuery.properties.jobCategories.enumDescriptions The following keys were added: - resources.projects.methods.complete.parameters.scope.enumDescriptions - resources.projects.methods.complete.parameters.type.enumDescriptions - resources.projects.resources.jobs.methods.list.parameters.jobView.enumDescriptions - schemas.CompensationFilter.properties.units.items.enumDescriptions - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.id - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.id - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.id - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enum - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.id - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.type - schemas.GoogleCloudTalentV4CompensationInfo.description - schemas.GoogleCloudTalentV4CompensationInfo.id - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.items.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.type - schemas.GoogleCloudTalentV4CompensationInfo.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.format - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.type - schemas.GoogleCloudTalentV4CustomAttribute.description - schemas.GoogleCloudTalentV4CustomAttribute.id - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.format - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.type - schemas.GoogleCloudTalentV4CustomAttribute.type - schemas.GoogleCloudTalentV4Job.description - schemas.GoogleCloudTalentV4Job.id - schemas.GoogleCloudTalentV4Job.properties.addresses.description - schemas.GoogleCloudTalentV4Job.properties.addresses.items.type - schemas.GoogleCloudTalentV4Job.properties.addresses.type - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.description - schemas.GoogleCloudTalentV4Job.properties.company.description - schemas.GoogleCloudTalentV4Job.properties.company.type - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.description - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.readOnly - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.type - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.additionalProperties.$ref - schemas.GoogleCloudTalentV4Job.properties.customAttributes.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.description - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.type - schemas.GoogleCloudTalentV4Job.properties.department.description - schemas.GoogleCloudTalentV4Job.properties.department.type - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.description - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.readOnly - schemas.GoogleCloudTalentV4Job.properties.description.description - schemas.GoogleCloudTalentV4Job.properties.description.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.description - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.type - schemas.GoogleCloudTalentV4Job.properties.incentives.description - schemas.GoogleCloudTalentV4Job.properties.incentives.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.description - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enum - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.type - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.description - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.format - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.type - schemas.GoogleCloudTalentV4Job.properties.jobLevel.description - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enum - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobLevel.type - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.description - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.format - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.type - schemas.GoogleCloudTalentV4Job.properties.languageCode.description - schemas.GoogleCloudTalentV4Job.properties.languageCode.type - schemas.GoogleCloudTalentV4Job.properties.name.description - schemas.GoogleCloudTalentV4Job.properties.name.type - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.type - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.description - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.format - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.type - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.description - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.format - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.type - schemas.GoogleCloudTalentV4Job.properties.postingRegion.description - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enum - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.postingRegion.type - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.type - schemas.GoogleCloudTalentV4Job.properties.processingOptions.$ref - schemas.GoogleCloudTalentV4Job.properties.processingOptions.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.format - schemas.GoogleCloudTalentV4Job.properties.promotionValue.type - schemas.GoogleCloudTalentV4Job.properties.qualifications.description - schemas.GoogleCloudTalentV4Job.properties.qualifications.type - schemas.GoogleCloudTalentV4Job.properties.requisitionId.description - schemas.GoogleCloudTalentV4Job.properties.requisitionId.type - schemas.GoogleCloudTalentV4Job.properties.responsibilities.description - schemas.GoogleCloudTalentV4Job.properties.responsibilities.type - schemas.GoogleCloudTalentV4Job.properties.title.description - schemas.GoogleCloudTalentV4Job.properties.title.type - schemas.GoogleCloudTalentV4Job.properties.visibility.description - schemas.GoogleCloudTalentV4Job.properties.visibility.enum - schemas.GoogleCloudTalentV4Job.properties.visibility.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.visibility.type - schemas.GoogleCloudTalentV4Job.type - schemas.GoogleCloudTalentV4JobApplicationInfo.description - schemas.GoogleCloudTalentV4JobApplicationInfo.id - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.type - schemas.GoogleCloudTalentV4JobApplicationInfo.type - schemas.GoogleCloudTalentV4JobDerivedInfo.description - schemas.GoogleCloudTalentV4JobDerivedInfo.id - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enum - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enumDescriptions - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.items.$ref - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.type - schemas.GoogleCloudTalentV4JobDerivedInfo.type - schemas.GoogleCloudTalentV4JobProcessingOptions.description - schemas.GoogleCloudTalentV4JobProcessingOptions.id - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.type - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enum - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.type - schemas.GoogleCloudTalentV4JobProcessingOptions.type - schemas.GoogleCloudTalentV4JobResult.description - schemas.GoogleCloudTalentV4JobResult.id - schemas.GoogleCloudTalentV4JobResult.properties.job.$ref - schemas.GoogleCloudTalentV4JobResult.properties.job.description - schemas.GoogleCloudTalentV4JobResult.properties.status.$ref - schemas.GoogleCloudTalentV4JobResult.properties.status.description - schemas.GoogleCloudTalentV4JobResult.type - schemas.GoogleCloudTalentV4Location.description - schemas.GoogleCloudTalentV4Location.id - schemas.GoogleCloudTalentV4Location.properties.latLng.$ref - schemas.GoogleCloudTalentV4Location.properties.latLng.description - schemas.GoogleCloudTalentV4Location.properties.locationType.description - schemas.GoogleCloudTalentV4Location.properties.locationType.enum - schemas.GoogleCloudTalentV4Location.properties.locationType.enumDescriptions - schemas.GoogleCloudTalentV4Location.properties.locationType.type - schemas.GoogleCloudTalentV4Location.properties.postalAddress.$ref - schemas.GoogleCloudTalentV4Location.properties.postalAddress.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.format - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.type - schemas.GoogleCloudTalentV4Location.type - schemas.HistogramFacets.properties.simpleHistogramFacets.items.enumDescriptions - schemas.Job.properties.degreeTypes.items.enumDescriptions - schemas.Job.properties.employmentTypes.items.enumDescriptions - schemas.Job.properties.jobBenefits.items.enumDescriptions - schemas.JobDerivedInfo.properties.jobCategories.items.enumDescriptions - schemas.JobQuery.properties.employmentTypes.items.enumDescriptions - schemas.JobQuery.properties.jobCategories.items.enumDescriptions The following keys were changed: - description - resources.projects.methods.complete.description - resources.projects.methods.complete.parameters.companyName.description - resources.projects.methods.complete.parameters.languageCode.description - resources.projects.methods.complete.parameters.languageCodes.description - resources.projects.methods.complete.parameters.name.description - resources.projects.methods.complete.parameters.pageSize.description - resources.projects.methods.complete.parameters.query.description - resources.projects.resources.clientEvents.methods.create.description - resources.projects.resources.companies.methods.create.parameters.parent.description - resources.projects.resources.companies.methods.delete.description - resources.projects.resources.companies.methods.delete.parameters.name.description - resources.projects.resources.companies.methods.get.parameters.name.description - resources.projects.resources.companies.methods.list.parameters.pageSize.description - resources.projects.resources.companies.methods.list.parameters.parent.description - resources.projects.resources.companies.methods.list.parameters.requireOpenJobs.description - resources.projects.resources.companies.methods.patch.description - resources.projects.resources.companies.methods.patch.parameters.name.description - resources.projects.resources.jobs.methods.batchDelete.parameters.parent.description - resources.projects.resources.jobs.methods.create.description - resources.projects.resources.jobs.methods.create.parameters.parent.description - resources.projects.resources.jobs.methods.delete.description - resources.projects.resources.jobs.methods.delete.parameters.name.description - resources.projects.resources.jobs.methods.get.description - resources.projects.resources.jobs.methods.get.parameters.name.description - resources.projects.resources.jobs.methods.list.parameters.filter.description - resources.projects.resources.jobs.methods.list.parameters.jobView.description - resources.projects.resources.jobs.methods.list.parameters.pageSize.description - resources.projects.resources.jobs.methods.list.parameters.parent.description - resources.projects.resources.jobs.methods.patch.description - resources.projects.resources.jobs.methods.patch.parameters.name.description - resources.projects.resources.jobs.methods.search.description - resources.projects.resources.jobs.methods.search.parameters.parent.description - resources.projects.resources.jobs.methods.searchForAlert.description - resources.projects.resources.jobs.methods.searchForAlert.parameters.parent.description - resources.projects.resources.operations.methods.get.description - schemas.ApplicationInfo.properties.emails.description - schemas.ApplicationInfo.properties.instruction.description - schemas.ApplicationInfo.properties.uris.description - schemas.BatchDeleteJobsRequest.description - schemas.BatchDeleteJobsRequest.properties.filter.description - schemas.BucketizedCount.properties.range.description - schemas.ClientEvent.description - schemas.ClientEvent.properties.eventId.description - schemas.ClientEvent.properties.extraInfo.description - schemas.ClientEvent.properties.jobEvent.description - schemas.ClientEvent.properties.parentEventId.description - schemas.ClientEvent.properties.requestId.description - schemas.CommuteFilter.description - schemas.CommuteFilter.properties.allowImpreciseAddresses.description - schemas.CommuteFilter.properties.commuteMethod.enumDescriptions - schemas.CommuteFilter.properties.departureTime.description - schemas.CommuteFilter.properties.startCoordinates.description - schemas.CommuteFilter.properties.travelDuration.description - schemas.CommuteInfo.description - schemas.CommuteInfo.properties.travelDuration.description - schemas.Company.description - schemas.Company.properties.careerSiteUri.description - schemas.Company.properties.eeoText.description - schemas.Company.properties.externalId.description - schemas.Company.properties.headquartersAddress.description - schemas.Company.properties.hiringAgency.description - schemas.Company.properties.keywordSearchableJobCustomAttributes.description - schemas.Company.properties.name.description - schemas.Company.properties.suspended.description - schemas.Company.properties.websiteUri.description - schemas.CompanyDerivedInfo.properties.headquartersLocation.description - schemas.CompensationEntry.description - schemas.CompensationEntry.properties.description.description - schemas.CompensationEntry.properties.expectedUnitsPerYear.description - schemas.CompensationEntry.properties.type.description - schemas.CompensationEntry.properties.type.enumDescriptions - schemas.CompensationEntry.properties.unit.description - schemas.CompensationFilter.description - schemas.CompensationFilter.properties.includeJobsWithUnspecifiedCompensationRange.description - schemas.CompensationFilter.properties.type.enumDescriptions - schemas.CompensationFilter.properties.units.description - schemas.CompensationHistogramRequest.description - schemas.CompensationHistogramRequest.properties.type.description - schemas.CompensationHistogramRequest.properties.type.enumDescriptions - schemas.CompensationHistogramResult.description - schemas.CompensationHistogramResult.properties.type.description - schemas.CompensationHistogramResult.properties.type.enumDescriptions - schemas.CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.CompensationInfo.properties.entries.description - schemas.CompensationRange.properties.maxCompensation.description - schemas.CompensationRange.properties.minCompensation.description - schemas.CompleteQueryResponse.description - schemas.CompleteQueryResponse.properties.metadata.description - schemas.CompletionResult.description - schemas.CreateClientEventRequest.properties.clientEvent.description - schemas.CreateCompanyRequest.description - schemas.CreateJobRequest.description - schemas.CustomAttribute.properties.filterable.description - schemas.CustomAttribute.properties.longValues.description - schemas.CustomAttribute.properties.stringValues.description - schemas.CustomAttributeHistogramRequest.description - schemas.CustomAttributeHistogramRequest.properties.key.description - schemas.CustomAttributeHistogramRequest.properties.longValueHistogramBucketingOption.description - schemas.CustomAttributeHistogramRequest.properties.stringValueHistogram.description - schemas.CustomAttributeHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.longValueHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.stringValueHistogramResult.description - schemas.CustomRankingInfo.description - schemas.CustomRankingInfo.properties.importanceLevel.description - schemas.CustomRankingInfo.properties.importanceLevel.enumDescriptions - schemas.CustomRankingInfo.properties.rankingExpression.description - schemas.DeviceInfo.description - schemas.DeviceInfo.properties.deviceType.enumDescriptions - schemas.DeviceInfo.properties.id.description - schemas.Empty.description - schemas.HistogramFacets.description - schemas.HistogramFacets.properties.compensationHistogramFacets.description - schemas.HistogramFacets.properties.customAttributeHistogramFacets.description - schemas.HistogramFacets.properties.simpleHistogramFacets.description - schemas.HistogramQuery.description - schemas.HistogramQuery.properties.histogramQuery.description - schemas.HistogramQueryResult.description - schemas.HistogramQueryResult.properties.histogram.description - schemas.HistogramResult.description - schemas.HistogramResult.properties.searchType.enumDescriptions - schemas.HistogramResult.properties.values.description - schemas.HistogramResults.description - schemas.HistogramResults.properties.compensationHistogramResults.description - schemas.HistogramResults.properties.customAttributeHistogramResults.description - schemas.HistogramResults.properties.simpleHistogramResults.description - schemas.Job.description - schemas.Job.properties.addresses.description - schemas.Job.properties.applicationInfo.description - schemas.Job.properties.companyName.description - schemas.Job.properties.customAttributes.description - schemas.Job.properties.department.description - schemas.Job.properties.description.description - schemas.Job.properties.employmentTypes.description - schemas.Job.properties.incentives.description - schemas.Job.properties.jobEndTime.description - schemas.Job.properties.jobLevel.enumDescriptions - schemas.Job.properties.jobStartTime.description - schemas.Job.properties.languageCode.description - schemas.Job.properties.name.description - schemas.Job.properties.postingExpireTime.description - schemas.Job.properties.postingPublishTime.description - schemas.Job.properties.postingRegion.description - schemas.Job.properties.postingRegion.enumDescriptions - schemas.Job.properties.promotionValue.description - schemas.Job.properties.qualifications.description - schemas.Job.properties.requisitionId.description - schemas.Job.properties.responsibilities.description - schemas.Job.properties.title.description - schemas.Job.properties.visibility.description - schemas.Job.properties.visibility.enumDescriptions - schemas.JobDerivedInfo.description - schemas.JobDerivedInfo.properties.locations.description - schemas.JobEvent.description - schemas.JobEvent.properties.jobs.description - schemas.JobEvent.properties.type.enumDescriptions - schemas.JobQuery.description - schemas.JobQuery.properties.commuteFilter.description - schemas.JobQuery.properties.companyDisplayNames.description - schemas.JobQuery.properties.companyNames.description - schemas.JobQuery.properties.compensationFilter.description - schemas.JobQuery.properties.customAttributeFilter.description - schemas.JobQuery.properties.disableSpellCheck.description - schemas.JobQuery.properties.employmentTypes.description - schemas.JobQuery.properties.excludedJobs.description - schemas.JobQuery.properties.jobCategories.description - schemas.JobQuery.properties.languageCodes.description - schemas.JobQuery.properties.locationFilters.description - schemas.JobQuery.properties.publishTimeRange.description - schemas.JobQuery.properties.query.description - schemas.JobQuery.properties.queryLanguageCode.description - schemas.LatLng.description - schemas.ListCompaniesResponse.description - schemas.ListCompaniesResponse.properties.metadata.description - schemas.ListJobsResponse.description - schemas.ListJobsResponse.properties.jobs.description - schemas.ListJobsResponse.properties.metadata.description - schemas.Location.description - schemas.Location.properties.locationType.description - schemas.Location.properties.locationType.enumDescriptions - schemas.Location.properties.postalAddress.description - schemas.Location.properties.radiusInMiles.description - schemas.LocationFilter.description - schemas.LocationFilter.properties.distanceInMiles.description - schemas.LocationFilter.properties.latLng.description - schemas.LocationFilter.properties.regionCode.description - schemas.LocationFilter.properties.telecommutePreference.description - schemas.MatchingJob.description - schemas.MatchingJob.properties.commuteInfo.description - schemas.MatchingJob.properties.jobSummary.description - schemas.MatchingJob.properties.jobTitleSnippet.description - schemas.MatchingJob.properties.searchTextSnippet.description - schemas.MendelDebugInput.description - schemas.MendelDebugInput.properties.namespacedDebugInput.description - schemas.Money.properties.nanos.description - schemas.Money.properties.units.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpNames.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpTags.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExps.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpNames.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpTags.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExps.description - schemas.NamespacedDebugInput.properties.disableAutomaticEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableExpNames.description - schemas.NamespacedDebugInput.properties.disableExpTags.description - schemas.NamespacedDebugInput.properties.disableExps.description - schemas.NamespacedDebugInput.properties.disableManualEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableOrganicSelection.description - schemas.NamespacedDebugInput.properties.forcedFlags.description - schemas.NamespacedDebugInput.properties.forcedRollouts.description - schemas.NumericBucketingOption.description - schemas.NumericBucketingOption.properties.bucketBounds.description - schemas.NumericBucketingOption.properties.requiresMinMax.description - schemas.NumericBucketingResult.description - schemas.NumericBucketingResult.properties.counts.description - schemas.NumericBucketingResult.properties.maxValue.description - schemas.NumericBucketingResult.properties.minValue.description - schemas.Operation.description - schemas.Operation.properties.done.description - schemas.Operation.properties.metadata.description - schemas.Operation.properties.name.description - schemas.Operation.properties.response.description - schemas.PostalAddress.description - schemas.PostalAddress.properties.addressLines.description - schemas.PostalAddress.properties.administrativeArea.description - schemas.PostalAddress.properties.languageCode.description - schemas.PostalAddress.properties.locality.description - schemas.PostalAddress.properties.postalCode.description - schemas.PostalAddress.properties.recipients.description - schemas.PostalAddress.properties.regionCode.description - schemas.PostalAddress.properties.revision.description - schemas.PostalAddress.properties.sortingCode.description - schemas.PostalAddress.properties.sublocality.description - schemas.ProcessingOptions.description - schemas.ProcessingOptions.properties.disableStreetAddressResolution.description - schemas.ProcessingOptions.properties.htmlSanitization.description - schemas.ProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.RequestMetadata.description - schemas.RequestMetadata.properties.deviceInfo.description - schemas.RequestMetadata.properties.domain.description - schemas.RequestMetadata.properties.sessionId.description - schemas.RequestMetadata.properties.userId.description - schemas.ResponseMetadata.description - schemas.ResponseMetadata.properties.requestId.description - schemas.SearchJobsRequest.description - schemas.SearchJobsRequest.properties.customRankingInfo.description - schemas.SearchJobsRequest.properties.disableKeywordMatch.description - schemas.SearchJobsRequest.properties.diversificationLevel.description - schemas.SearchJobsRequest.properties.diversificationLevel.enumDescriptions - schemas.SearchJobsRequest.properties.enableBroadening.description - schemas.SearchJobsRequest.properties.jobView.description - schemas.SearchJobsRequest.properties.jobView.enumDescriptions - schemas.SearchJobsRequest.properties.offset.description - schemas.SearchJobsRequest.properties.orderBy.description - schemas.SearchJobsRequest.properties.pageSize.description - schemas.SearchJobsRequest.properties.pageToken.description - schemas.SearchJobsRequest.properties.requestMetadata.description - schemas.SearchJobsRequest.properties.requirePreciseResultSize.description - schemas.SearchJobsRequest.properties.searchMode.description - schemas.SearchJobsRequest.properties.searchMode.enumDescriptions - schemas.SearchJobsResponse.description - schemas.SearchJobsResponse.properties.broadenedQueryJobsCount.description - schemas.SearchJobsResponse.properties.estimatedTotalSize.description - schemas.SearchJobsResponse.properties.histogramQueryResults.description - schemas.SearchJobsResponse.properties.histogramResults.description - schemas.SearchJobsResponse.properties.locationFilters.description - schemas.SearchJobsResponse.properties.metadata.description - schemas.SearchJobsResponse.properties.nextPageToken.description - schemas.SearchJobsResponse.properties.totalSize.description - schemas.SpellingCorrection.description - schemas.Status.description - schemas.Status.properties.details.description - schemas.Status.properties.message.description - schemas.TimeOfDay.description - schemas.TimeOfDay.properties.hours.description - schemas.TimeOfDay.properties.seconds.description - schemas.UpdateCompanyRequest.description - schemas.UpdateCompanyRequest.properties.updateMask.description - schemas.UpdateJobRequest.description - schemas.UpdateJobRequest.properties.updateMask.description #### jobs:v2 The following keys were deleted: - schemas.CompensationFilter.properties.units.enumDescriptions - schemas.ExtendedCompensationFilter.properties.compensationUnits.enumDescriptions - schemas.GetHistogramRequest.properties.searchTypes.enumDescriptions - schemas.HistogramFacets.properties.simpleHistogramFacets.enumDescriptions - schemas.Job.properties.benefits.enumDescriptions - schemas.Job.properties.educationLevels.enumDescriptions - schemas.Job.properties.employmentTypes.enumDescriptions - schemas.JobFilters.properties.categories.enumDescriptions - schemas.JobFilters.properties.employmentTypes.enumDescriptions - schemas.JobQuery.properties.categories.enumDescriptions - schemas.JobQuery.properties.employmentTypes.enumDescriptions The following keys were added: - resources.v2.methods.complete.parameters.scope.enumDescriptions - resources.v2.methods.complete.parameters.type.enumDescriptions - schemas.CompensationFilter.properties.units.items.enumDescriptions - schemas.ExtendedCompensationFilter.properties.compensationUnits.items.enumDescriptions - schemas.GetHistogramRequest.properties.searchTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.id - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.id - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.id - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enum - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.id - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.type - schemas.GoogleCloudTalentV4CompensationInfo.description - schemas.GoogleCloudTalentV4CompensationInfo.id - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.items.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.type - schemas.GoogleCloudTalentV4CompensationInfo.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.format - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.type - schemas.GoogleCloudTalentV4CustomAttribute.description - schemas.GoogleCloudTalentV4CustomAttribute.id - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.format - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.type - schemas.GoogleCloudTalentV4CustomAttribute.type - schemas.GoogleCloudTalentV4Job.description - schemas.GoogleCloudTalentV4Job.id - schemas.GoogleCloudTalentV4Job.properties.addresses.description - schemas.GoogleCloudTalentV4Job.properties.addresses.items.type - schemas.GoogleCloudTalentV4Job.properties.addresses.type - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.description - schemas.GoogleCloudTalentV4Job.properties.company.description - schemas.GoogleCloudTalentV4Job.properties.company.type - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.description - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.readOnly - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.type - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.additionalProperties.$ref - schemas.GoogleCloudTalentV4Job.properties.customAttributes.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.description - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.type - schemas.GoogleCloudTalentV4Job.properties.department.description - schemas.GoogleCloudTalentV4Job.properties.department.type - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.description - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.readOnly - schemas.GoogleCloudTalentV4Job.properties.description.description - schemas.GoogleCloudTalentV4Job.properties.description.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.description - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.type - schemas.GoogleCloudTalentV4Job.properties.incentives.description - schemas.GoogleCloudTalentV4Job.properties.incentives.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.description - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enum - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.type - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.description - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.format - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.type - schemas.GoogleCloudTalentV4Job.properties.jobLevel.description - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enum - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobLevel.type - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.description - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.format - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.type - schemas.GoogleCloudTalentV4Job.properties.languageCode.description - schemas.GoogleCloudTalentV4Job.properties.languageCode.type - schemas.GoogleCloudTalentV4Job.properties.name.description - schemas.GoogleCloudTalentV4Job.properties.name.type - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.type - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.description - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.format - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.type - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.description - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.format - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.type - schemas.GoogleCloudTalentV4Job.properties.postingRegion.description - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enum - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.postingRegion.type - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.type - schemas.GoogleCloudTalentV4Job.properties.processingOptions.$ref - schemas.GoogleCloudTalentV4Job.properties.processingOptions.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.format - schemas.GoogleCloudTalentV4Job.properties.promotionValue.type - schemas.GoogleCloudTalentV4Job.properties.qualifications.description - schemas.GoogleCloudTalentV4Job.properties.qualifications.type - schemas.GoogleCloudTalentV4Job.properties.requisitionId.description - schemas.GoogleCloudTalentV4Job.properties.requisitionId.type - schemas.GoogleCloudTalentV4Job.properties.responsibilities.description - schemas.GoogleCloudTalentV4Job.properties.responsibilities.type - schemas.GoogleCloudTalentV4Job.properties.title.description - schemas.GoogleCloudTalentV4Job.properties.title.type - schemas.GoogleCloudTalentV4Job.properties.visibility.description - schemas.GoogleCloudTalentV4Job.properties.visibility.enum - schemas.GoogleCloudTalentV4Job.properties.visibility.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.visibility.type - schemas.GoogleCloudTalentV4Job.type - schemas.GoogleCloudTalentV4JobApplicationInfo.description - schemas.GoogleCloudTalentV4JobApplicationInfo.id - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.type - schemas.GoogleCloudTalentV4JobApplicationInfo.type - schemas.GoogleCloudTalentV4JobDerivedInfo.description - schemas.GoogleCloudTalentV4JobDerivedInfo.id - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enum - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enumDescriptions - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.items.$ref - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.type - schemas.GoogleCloudTalentV4JobDerivedInfo.type - schemas.GoogleCloudTalentV4JobProcessingOptions.description - schemas.GoogleCloudTalentV4JobProcessingOptions.id - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.type - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enum - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.type - schemas.GoogleCloudTalentV4JobProcessingOptions.type - schemas.GoogleCloudTalentV4JobResult.description - schemas.GoogleCloudTalentV4JobResult.id - schemas.GoogleCloudTalentV4JobResult.properties.job.$ref - schemas.GoogleCloudTalentV4JobResult.properties.job.description - schemas.GoogleCloudTalentV4JobResult.properties.status.$ref - schemas.GoogleCloudTalentV4JobResult.properties.status.description - schemas.GoogleCloudTalentV4JobResult.type - schemas.GoogleCloudTalentV4Location.description - schemas.GoogleCloudTalentV4Location.id - schemas.GoogleCloudTalentV4Location.properties.latLng.$ref - schemas.GoogleCloudTalentV4Location.properties.latLng.description - schemas.GoogleCloudTalentV4Location.properties.locationType.description - schemas.GoogleCloudTalentV4Location.properties.locationType.enum - schemas.GoogleCloudTalentV4Location.properties.locationType.enumDescriptions - schemas.GoogleCloudTalentV4Location.properties.locationType.type - schemas.GoogleCloudTalentV4Location.properties.postalAddress.$ref - schemas.GoogleCloudTalentV4Location.properties.postalAddress.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.format - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.type - schemas.GoogleCloudTalentV4Location.type - schemas.HistogramFacets.properties.simpleHistogramFacets.items.enumDescriptions - schemas.Job.properties.benefits.items.enumDescriptions - schemas.Job.properties.educationLevels.items.enumDescriptions - schemas.Job.properties.employmentTypes.items.enumDescriptions - schemas.JobFilters.properties.categories.items.enumDescriptions - schemas.JobFilters.properties.employmentTypes.items.enumDescriptions - schemas.JobQuery.properties.categories.items.enumDescriptions - schemas.JobQuery.properties.employmentTypes.items.enumDescriptions - schemas.Status.description - schemas.Status.id - schemas.Status.properties.code.description - schemas.Status.properties.code.format - schemas.Status.properties.code.type - schemas.Status.properties.details.description - schemas.Status.properties.details.items.additionalProperties.description - schemas.Status.properties.details.items.additionalProperties.type - schemas.Status.properties.details.items.type - schemas.Status.properties.details.type - schemas.Status.properties.message.description - schemas.Status.properties.message.type - schemas.Status.type The following keys were changed: - description - resources.companies.methods.delete.parameters.name.description - resources.companies.methods.get.parameters.name.description - resources.companies.methods.list.parameters.mustHaveOpenJobs.description - resources.companies.methods.list.parameters.pageSize.description - resources.companies.methods.patch.description - resources.companies.methods.patch.parameters.name.description - resources.companies.methods.patch.parameters.updateCompanyFields.description - resources.companies.resources.jobs.methods.list.description - resources.companies.resources.jobs.methods.list.parameters.companyName.description - resources.companies.resources.jobs.methods.list.parameters.idsOnly.description - resources.companies.resources.jobs.methods.list.parameters.includeJobsCount.description - resources.companies.resources.jobs.methods.list.parameters.jobRequisitionId.description - resources.companies.resources.jobs.methods.list.parameters.pageSize.description - resources.jobs.methods.create.description - resources.jobs.methods.delete.description - resources.jobs.methods.delete.parameters.disableFastProcess.description - resources.jobs.methods.deleteByFilter.description - resources.jobs.methods.get.description - resources.jobs.methods.histogram.description - resources.jobs.methods.list.parameters.filter.description - resources.jobs.methods.list.parameters.idsOnly.description - resources.jobs.methods.list.parameters.pageSize.description - resources.jobs.methods.patch.description - resources.jobs.methods.patch.parameters.name.description - resources.jobs.methods.search.description - resources.jobs.methods.searchForAlert.description - resources.v2.methods.complete.description - resources.v2.methods.complete.parameters.languageCode.description - resources.v2.methods.complete.parameters.pageSize.description - schemas.BatchDeleteJobsRequest.description - schemas.BatchDeleteJobsRequest.properties.filter.description - schemas.BucketizedCount.properties.range.description - schemas.CommuteInfo.description - schemas.CommuteInfo.properties.travelDuration.description - schemas.CommutePreference.description - schemas.CommutePreference.properties.allowNonStreetLevelAddress.description - schemas.CommutePreference.properties.departureHourLocal.description - schemas.CommutePreference.properties.method.enumDescriptions - schemas.CommutePreference.properties.roadTraffic.description - schemas.CommutePreference.properties.startLocation.description - schemas.CommutePreference.properties.travelTime.description - schemas.Company.description - schemas.Company.properties.careerPageLink.description - schemas.Company.properties.companyInfoSources.description - schemas.Company.properties.disableLocationOptimization.description - schemas.Company.properties.displayName.description - schemas.Company.properties.distributorBillingCompanyId.description - schemas.Company.properties.distributorCompanyId.description - schemas.Company.properties.eeoText.description - schemas.Company.properties.hiringAgency.description - schemas.Company.properties.hqLocation.description - schemas.Company.properties.imageUrl.description - schemas.Company.properties.keywordSearchableCustomAttributes.description - schemas.Company.properties.keywordSearchableCustomFields.description - schemas.Company.properties.name.description - schemas.Company.properties.structuredCompanyHqLocation.description - schemas.Company.properties.suspended.description - schemas.Company.properties.title.description - schemas.Company.properties.website.description - schemas.CompanyInfoSource.description - schemas.CompanyInfoSource.properties.mapsCid.description - schemas.CompensationEntry.description - schemas.CompensationEntry.properties.description.description - schemas.CompensationEntry.properties.expectedUnitsPerYear.description - schemas.CompensationEntry.properties.type.enumDescriptions - schemas.CompensationEntry.properties.unit.description - schemas.CompensationFilter.description - schemas.CompensationFilter.properties.type.enumDescriptions - schemas.CompensationFilter.properties.units.description - schemas.CompensationHistogramRequest.description - schemas.CompensationHistogramRequest.properties.type.description - schemas.CompensationHistogramRequest.properties.type.enumDescriptions - schemas.CompensationHistogramResult.description - schemas.CompensationHistogramResult.properties.type.description - schemas.CompensationHistogramResult.properties.type.enumDescriptions - schemas.CompensationInfo.properties.amount.description - schemas.CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.CompensationInfo.properties.entries.description - schemas.CompensationInfo.properties.max.description - schemas.CompensationInfo.properties.min.description - schemas.CompensationInfo.properties.type.description - schemas.CompensationInfo.properties.type.enumDescriptions - schemas.CompensationRange.properties.max.description - schemas.CompensationRange.properties.min.description - schemas.CompleteQueryResponse.description - schemas.CompleteQueryResponse.properties.metadata.description - schemas.CompletionResult.description - schemas.CreateJobRequest.description - schemas.CreateJobRequest.properties.disableStreetAddressResolution.description - schemas.CustomAttribute.properties.filterable.description - schemas.CustomAttribute.properties.longValue.description - schemas.CustomAttribute.properties.stringValues.description - schemas.CustomAttributeHistogramRequest.description - schemas.CustomAttributeHistogramRequest.properties.key.description - schemas.CustomAttributeHistogramRequest.properties.longValueHistogramBucketingOption.description - schemas.CustomAttributeHistogramRequest.properties.stringValueHistogram.description - schemas.CustomAttributeHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.longValueHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.stringValueHistogramResult.description - schemas.CustomFieldFilter.description - schemas.CustomFieldFilter.properties.type.description - schemas.Date.description - schemas.Date.properties.day.description - schemas.Date.properties.month.description - schemas.Date.properties.year.description - schemas.DeleteJobsByFilterRequest.description - schemas.DeleteJobsByFilterRequest.properties.disableFastProcess.description - schemas.DeviceInfo.description - schemas.DeviceInfo.properties.deviceType.enumDescriptions - schemas.DeviceInfo.properties.id.description - schemas.Empty.description - schemas.ExtendedCompensationFilter.description - schemas.ExtendedCompensationFilter.properties.compensationUnits.description - schemas.ExtendedCompensationFilter.properties.currency.description - schemas.ExtendedCompensationFilter.properties.type.enumDescriptions - schemas.ExtendedCompensationInfo.description - schemas.ExtendedCompensationInfo.properties.annualizedBaseCompensationUnspecified.description - schemas.ExtendedCompensationInfo.properties.annualizedTotalCompensationUnspecified.description - schemas.ExtendedCompensationInfo.properties.currency.description - schemas.ExtendedCompensationInfo.properties.entries.description - schemas.ExtendedCompensationInfoCompensationEntry.description - schemas.ExtendedCompensationInfoCompensationEntry.properties.expectedUnitsPerYear.description - schemas.ExtendedCompensationInfoCompensationEntry.properties.type.enumDescriptions - schemas.ExtendedCompensationInfoCompensationEntry.properties.unit.description - schemas.ExtendedCompensationInfoCompensationRange.description - schemas.ExtendedCompensationInfoDecimal.description - schemas.ExtendedCompensationInfoDecimal.properties.micros.description - schemas.Filter.description - schemas.Filter.properties.requisitionId.description - schemas.GetHistogramRequest.description - schemas.GetHistogramRequest.properties.allowBroadening.description - schemas.GetHistogramRequest.properties.filters.description - schemas.GetHistogramRequest.properties.requestMetadata.description - schemas.GetHistogramRequest.properties.searchTypes.description - schemas.GetHistogramResponse.description - schemas.GetHistogramResponse.properties.metadata.description - schemas.HistogramFacets.description - schemas.HistogramFacets.properties.compensationHistogramFacets.description - schemas.HistogramFacets.properties.customAttributeHistogramFacets.description - schemas.HistogramFacets.properties.simpleHistogramFacets.description - schemas.HistogramResult.description - schemas.HistogramResult.properties.searchType.enumDescriptions - schemas.HistogramResult.properties.values.description - schemas.HistogramResults.description - schemas.HistogramResults.properties.compensationHistogramResults.description - schemas.HistogramResults.properties.customAttributeHistogramResults.description - schemas.HistogramResults.properties.simpleHistogramResults.description - schemas.Job.description - schemas.Job.properties.applicationEmailList.description - schemas.Job.properties.applicationInstruction.description - schemas.Job.properties.applicationUrls.description - schemas.Job.properties.companyName.description - schemas.Job.properties.companyTitle.description - schemas.Job.properties.customAttributes.description - schemas.Job.properties.department.description - schemas.Job.properties.description.description - schemas.Job.properties.distributorCompanyId.description - schemas.Job.properties.educationLevels.description - schemas.Job.properties.employmentTypes.description - schemas.Job.properties.endDate.description - schemas.Job.properties.expireTime.description - schemas.Job.properties.expiryDate.description - schemas.Job.properties.extendedCompensationInfo.description - schemas.Job.properties.filterableCustomFields.description - schemas.Job.properties.incentives.description - schemas.Job.properties.jobTitle.description - schemas.Job.properties.languageCode.description - schemas.Job.properties.level.enumDescriptions - schemas.Job.properties.locations.description - schemas.Job.properties.name.description - schemas.Job.properties.promotionValue.description - schemas.Job.properties.publishDate.description - schemas.Job.properties.qualifications.description - schemas.Job.properties.region.description - schemas.Job.properties.region.enumDescriptions - schemas.Job.properties.requisitionId.description - schemas.Job.properties.responsibilities.description - schemas.Job.properties.startDate.description - schemas.Job.properties.unindexedCustomFields.description - schemas.Job.properties.visibility.description - schemas.Job.properties.visibility.enumDescriptions - schemas.JobFilters.description - schemas.JobFilters.properties.categories.description - schemas.JobFilters.properties.commuteFilter.description - schemas.JobFilters.properties.companyNames.description - schemas.JobFilters.properties.companyTitles.description - schemas.JobFilters.properties.compensationFilter.description - schemas.JobFilters.properties.customAttributeFilter.description - schemas.JobFilters.properties.customFieldFilters.description - schemas.JobFilters.properties.disableSpellCheck.description - schemas.JobFilters.properties.employmentTypes.description - schemas.JobFilters.properties.extendedCompensationFilter.description - schemas.JobFilters.properties.languageCodes.description - schemas.JobFilters.properties.locationFilters.description - schemas.JobFilters.properties.publishDateRange.description - schemas.JobFilters.properties.query.description - schemas.JobFilters.properties.tenantJobOnly.description - schemas.JobLocation.description - schemas.JobLocation.properties.locationType.description - schemas.JobLocation.properties.locationType.enumDescriptions - schemas.JobLocation.properties.postalAddress.description - schemas.JobLocation.properties.radiusMeters.description - schemas.JobProcessingOptions.description - schemas.JobProcessingOptions.properties.disableStreetAddressResolution.description - schemas.JobProcessingOptions.properties.htmlSanitization.description - schemas.JobProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.JobQuery.description - schemas.JobQuery.properties.categories.description - schemas.JobQuery.properties.commuteFilter.description - schemas.JobQuery.properties.companyDisplayNames.description - schemas.JobQuery.properties.companyNames.description - schemas.JobQuery.properties.compensationFilter.description - schemas.JobQuery.properties.customAttributeFilter.description - schemas.JobQuery.properties.disableSpellCheck.description - schemas.JobQuery.properties.employmentTypes.description - schemas.JobQuery.properties.languageCodes.description - schemas.JobQuery.properties.locationFilters.description - schemas.JobQuery.properties.publishDateRange.description - schemas.JobQuery.properties.query.description - schemas.LatLng.description - schemas.ListCompaniesResponse.description - schemas.ListCompaniesResponse.properties.metadata.description - schemas.ListCompanyJobsResponse.description - schemas.ListCompanyJobsResponse.properties.jobs.description - schemas.ListCompanyJobsResponse.properties.metadata.description - schemas.ListCompanyJobsResponse.properties.totalSize.description - schemas.ListJobsResponse.description - schemas.ListJobsResponse.properties.jobs.description - schemas.ListJobsResponse.properties.metadata.description - schemas.LocationFilter.description - schemas.LocationFilter.properties.distanceInMiles.description - schemas.LocationFilter.properties.isTelecommute.description - schemas.LocationFilter.properties.latLng.description - schemas.LocationFilter.properties.regionCode.description - schemas.MatchingJob.description - schemas.MatchingJob.properties.commuteInfo.description - schemas.MatchingJob.properties.jobSummary.description - schemas.MatchingJob.properties.jobTitleSnippet.description - schemas.MatchingJob.properties.searchTextSnippet.description - schemas.MendelDebugInput.description - schemas.MendelDebugInput.properties.namespacedDebugInput.description - schemas.Money.properties.nanos.description - schemas.Money.properties.units.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpNames.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpTags.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExps.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpNames.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpTags.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExps.description - schemas.NamespacedDebugInput.properties.disableAutomaticEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableExpNames.description - schemas.NamespacedDebugInput.properties.disableExpTags.description - schemas.NamespacedDebugInput.properties.disableExps.description - schemas.NamespacedDebugInput.properties.disableManualEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableOrganicSelection.description - schemas.NamespacedDebugInput.properties.forcedFlags.description - schemas.NamespacedDebugInput.properties.forcedRollouts.description - schemas.NumericBucketingOption.description - schemas.NumericBucketingOption.properties.bucketBounds.description - schemas.NumericBucketingOption.properties.requiresMinMax.description - schemas.NumericBucketingResult.description - schemas.NumericBucketingResult.properties.counts.description - schemas.NumericBucketingResult.properties.maxValue.description - schemas.NumericBucketingResult.properties.minValue.description - schemas.PostalAddress.description - schemas.PostalAddress.properties.addressLines.description - schemas.PostalAddress.properties.administrativeArea.description - schemas.PostalAddress.properties.languageCode.description - schemas.PostalAddress.properties.locality.description - schemas.PostalAddress.properties.postalCode.description - schemas.PostalAddress.properties.recipients.description - schemas.PostalAddress.properties.regionCode.description - schemas.PostalAddress.properties.revision.description - schemas.PostalAddress.properties.sortingCode.description - schemas.PostalAddress.properties.sublocality.description - schemas.RequestMetadata.description - schemas.RequestMetadata.properties.deviceInfo.description - schemas.RequestMetadata.properties.domain.description - schemas.RequestMetadata.properties.sessionId.description - schemas.RequestMetadata.properties.userId.description - schemas.ResponseMetadata.description - schemas.ResponseMetadata.properties.experimentIdList.description - schemas.ResponseMetadata.properties.mode.enumDescriptions - schemas.ResponseMetadata.properties.requestId.description - schemas.SearchJobsRequest.description - schemas.SearchJobsRequest.properties.disableRelevanceThresholding.description - schemas.SearchJobsRequest.properties.enableBroadening.description - schemas.SearchJobsRequest.properties.enablePreciseResultSize.description - schemas.SearchJobsRequest.properties.filters.description - schemas.SearchJobsRequest.properties.histogramFacets.description - schemas.SearchJobsRequest.properties.jobView.description - schemas.SearchJobsRequest.properties.jobView.enumDescriptions - schemas.SearchJobsRequest.properties.mode.enumDescriptions - schemas.SearchJobsRequest.properties.offset.description - schemas.SearchJobsRequest.properties.orderBy.description - schemas.SearchJobsRequest.properties.orderBy.enumDescriptions - schemas.SearchJobsRequest.properties.pageSize.description - schemas.SearchJobsRequest.properties.pageToken.description - schemas.SearchJobsRequest.properties.requestMetadata.description - schemas.SearchJobsRequest.properties.sortBy.description - schemas.SearchJobsRequest.properties.sortBy.enumDescriptions - schemas.SearchJobsResponse.description - schemas.SearchJobsResponse.properties.appliedCommuteFilter.description - schemas.SearchJobsResponse.properties.appliedJobLocationFilters.description - schemas.SearchJobsResponse.properties.estimatedTotalSize.description - schemas.SearchJobsResponse.properties.histogramResults.description - schemas.SearchJobsResponse.properties.jobView.enumDescriptions - schemas.SearchJobsResponse.properties.metadata.description - schemas.SearchJobsResponse.properties.nextPageToken.description - schemas.SearchJobsResponse.properties.numJobsFromBroadenedQuery.description - schemas.SearchJobsResponse.properties.totalSize.description - schemas.SpellingCorrection.description - schemas.UpdateJobRequest.description - schemas.UpdateJobRequest.properties.disableStreetAddressResolution.description - schemas.UpdateJobRequest.properties.processingOptions.description - schemas.UpdateJobRequest.properties.updateJobFields.description #### jobs:v3 The following keys were deleted: - schemas.CompensationFilter.properties.units.enumDescriptions - schemas.HistogramFacets.properties.simpleHistogramFacets.enumDescriptions - schemas.Job.properties.degreeTypes.enumDescriptions - schemas.Job.properties.employmentTypes.enumDescriptions - schemas.Job.properties.jobBenefits.enumDescriptions - schemas.JobDerivedInfo.properties.jobCategories.enumDescriptions - schemas.JobQuery.properties.employmentTypes.enumDescriptions - schemas.JobQuery.properties.jobCategories.enumDescriptions The following keys were added: - resources.projects.methods.complete.parameters.scope.enumDescriptions - resources.projects.methods.complete.parameters.type.enumDescriptions - resources.projects.resources.jobs.methods.list.parameters.jobView.enumDescriptions - schemas.CompensationFilter.properties.units.items.enumDescriptions - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.id - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchCreateJobsResponse.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.id - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchDeleteJobsResponse.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.id - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.createTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.endTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.failureCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enum - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.enumDescriptions - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.state.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.stateDescription.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.successCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.totalCount.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.description - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.format - schemas.GoogleCloudTalentV4BatchOperationMetadata.properties.updateTime.type - schemas.GoogleCloudTalentV4BatchOperationMetadata.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.id - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.description - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.items.$ref - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.properties.jobResults.type - schemas.GoogleCloudTalentV4BatchUpdateJobsResponse.type - schemas.GoogleCloudTalentV4CompensationInfo.description - schemas.GoogleCloudTalentV4CompensationInfo.id - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedBaseCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.annualizedTotalCompensationRange.readOnly - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.description - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.items.$ref - schemas.GoogleCloudTalentV4CompensationInfo.properties.entries.type - schemas.GoogleCloudTalentV4CompensationInfo.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.amount.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.description.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.format - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.expectedUnitsPerYear.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.range.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.type.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enum - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.enumDescriptions - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.properties.unit.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationEntry.type - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.id - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.maxCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.$ref - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.properties.minCompensation.description - schemas.GoogleCloudTalentV4CompensationInfoCompensationRange.type - schemas.GoogleCloudTalentV4CustomAttribute.description - schemas.GoogleCloudTalentV4CustomAttribute.id - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.filterable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.keywordSearchable.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.format - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.longValues.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.description - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.items.type - schemas.GoogleCloudTalentV4CustomAttribute.properties.stringValues.type - schemas.GoogleCloudTalentV4CustomAttribute.type - schemas.GoogleCloudTalentV4Job.description - schemas.GoogleCloudTalentV4Job.id - schemas.GoogleCloudTalentV4Job.properties.addresses.description - schemas.GoogleCloudTalentV4Job.properties.addresses.items.type - schemas.GoogleCloudTalentV4Job.properties.addresses.type - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.applicationInfo.description - schemas.GoogleCloudTalentV4Job.properties.company.description - schemas.GoogleCloudTalentV4Job.properties.company.type - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.description - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.readOnly - schemas.GoogleCloudTalentV4Job.properties.companyDisplayName.type - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.compensationInfo.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.additionalProperties.$ref - schemas.GoogleCloudTalentV4Job.properties.customAttributes.description - schemas.GoogleCloudTalentV4Job.properties.customAttributes.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.description - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.degreeTypes.type - schemas.GoogleCloudTalentV4Job.properties.department.description - schemas.GoogleCloudTalentV4Job.properties.department.type - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.$ref - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.description - schemas.GoogleCloudTalentV4Job.properties.derivedInfo.readOnly - schemas.GoogleCloudTalentV4Job.properties.description.description - schemas.GoogleCloudTalentV4Job.properties.description.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.description - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enum - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.items.type - schemas.GoogleCloudTalentV4Job.properties.employmentTypes.type - schemas.GoogleCloudTalentV4Job.properties.incentives.description - schemas.GoogleCloudTalentV4Job.properties.incentives.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.description - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enum - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.items.type - schemas.GoogleCloudTalentV4Job.properties.jobBenefits.type - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.description - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.format - schemas.GoogleCloudTalentV4Job.properties.jobEndTime.type - schemas.GoogleCloudTalentV4Job.properties.jobLevel.description - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enum - schemas.GoogleCloudTalentV4Job.properties.jobLevel.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.jobLevel.type - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.description - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.format - schemas.GoogleCloudTalentV4Job.properties.jobStartTime.type - schemas.GoogleCloudTalentV4Job.properties.languageCode.description - schemas.GoogleCloudTalentV4Job.properties.languageCode.type - schemas.GoogleCloudTalentV4Job.properties.name.description - schemas.GoogleCloudTalentV4Job.properties.name.type - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingCreateTime.type - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.description - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.format - schemas.GoogleCloudTalentV4Job.properties.postingExpireTime.type - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.description - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.format - schemas.GoogleCloudTalentV4Job.properties.postingPublishTime.type - schemas.GoogleCloudTalentV4Job.properties.postingRegion.description - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enum - schemas.GoogleCloudTalentV4Job.properties.postingRegion.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.postingRegion.type - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.description - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.format - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.readOnly - schemas.GoogleCloudTalentV4Job.properties.postingUpdateTime.type - schemas.GoogleCloudTalentV4Job.properties.processingOptions.$ref - schemas.GoogleCloudTalentV4Job.properties.processingOptions.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.description - schemas.GoogleCloudTalentV4Job.properties.promotionValue.format - schemas.GoogleCloudTalentV4Job.properties.promotionValue.type - schemas.GoogleCloudTalentV4Job.properties.qualifications.description - schemas.GoogleCloudTalentV4Job.properties.qualifications.type - schemas.GoogleCloudTalentV4Job.properties.requisitionId.description - schemas.GoogleCloudTalentV4Job.properties.requisitionId.type - schemas.GoogleCloudTalentV4Job.properties.responsibilities.description - schemas.GoogleCloudTalentV4Job.properties.responsibilities.type - schemas.GoogleCloudTalentV4Job.properties.title.description - schemas.GoogleCloudTalentV4Job.properties.title.type - schemas.GoogleCloudTalentV4Job.properties.visibility.description - schemas.GoogleCloudTalentV4Job.properties.visibility.enum - schemas.GoogleCloudTalentV4Job.properties.visibility.enumDescriptions - schemas.GoogleCloudTalentV4Job.properties.visibility.type - schemas.GoogleCloudTalentV4Job.type - schemas.GoogleCloudTalentV4JobApplicationInfo.description - schemas.GoogleCloudTalentV4JobApplicationInfo.id - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.emails.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.instruction.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.description - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.items.type - schemas.GoogleCloudTalentV4JobApplicationInfo.properties.uris.type - schemas.GoogleCloudTalentV4JobApplicationInfo.type - schemas.GoogleCloudTalentV4JobDerivedInfo.description - schemas.GoogleCloudTalentV4JobDerivedInfo.id - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enum - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.enumDescriptions - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.items.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.jobCategories.type - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.description - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.items.$ref - schemas.GoogleCloudTalentV4JobDerivedInfo.properties.locations.type - schemas.GoogleCloudTalentV4JobDerivedInfo.type - schemas.GoogleCloudTalentV4JobProcessingOptions.description - schemas.GoogleCloudTalentV4JobProcessingOptions.id - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.disableStreetAddressResolution.type - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.description - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enum - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.GoogleCloudTalentV4JobProcessingOptions.properties.htmlSanitization.type - schemas.GoogleCloudTalentV4JobProcessingOptions.type - schemas.GoogleCloudTalentV4JobResult.description - schemas.GoogleCloudTalentV4JobResult.id - schemas.GoogleCloudTalentV4JobResult.properties.job.$ref - schemas.GoogleCloudTalentV4JobResult.properties.job.description - schemas.GoogleCloudTalentV4JobResult.properties.status.$ref - schemas.GoogleCloudTalentV4JobResult.properties.status.description - schemas.GoogleCloudTalentV4JobResult.type - schemas.GoogleCloudTalentV4Location.description - schemas.GoogleCloudTalentV4Location.id - schemas.GoogleCloudTalentV4Location.properties.latLng.$ref - schemas.GoogleCloudTalentV4Location.properties.latLng.description - schemas.GoogleCloudTalentV4Location.properties.locationType.description - schemas.GoogleCloudTalentV4Location.properties.locationType.enum - schemas.GoogleCloudTalentV4Location.properties.locationType.enumDescriptions - schemas.GoogleCloudTalentV4Location.properties.locationType.type - schemas.GoogleCloudTalentV4Location.properties.postalAddress.$ref - schemas.GoogleCloudTalentV4Location.properties.postalAddress.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.description - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.format - schemas.GoogleCloudTalentV4Location.properties.radiusMiles.type - schemas.GoogleCloudTalentV4Location.type - schemas.HistogramFacets.properties.simpleHistogramFacets.items.enumDescriptions - schemas.Job.properties.degreeTypes.items.enumDescriptions - schemas.Job.properties.employmentTypes.items.enumDescriptions - schemas.Job.properties.jobBenefits.items.enumDescriptions - schemas.JobDerivedInfo.properties.jobCategories.items.enumDescriptions - schemas.JobQuery.properties.employmentTypes.items.enumDescriptions - schemas.JobQuery.properties.jobCategories.items.enumDescriptions - schemas.Status.description - schemas.Status.id - schemas.Status.properties.code.description - schemas.Status.properties.code.format - schemas.Status.properties.code.type - schemas.Status.properties.details.description - schemas.Status.properties.details.items.additionalProperties.description - schemas.Status.properties.details.items.additionalProperties.type - schemas.Status.properties.details.items.type - schemas.Status.properties.details.type - schemas.Status.properties.message.description - schemas.Status.properties.message.type - schemas.Status.type The following keys were changed: - description - resources.projects.methods.complete.description - resources.projects.methods.complete.parameters.companyName.description - resources.projects.methods.complete.parameters.languageCode.description - resources.projects.methods.complete.parameters.languageCodes.description - resources.projects.methods.complete.parameters.name.description - resources.projects.methods.complete.parameters.pageSize.description - resources.projects.methods.complete.parameters.query.description - resources.projects.resources.clientEvents.methods.create.description - resources.projects.resources.companies.methods.create.parameters.parent.description - resources.projects.resources.companies.methods.delete.description - resources.projects.resources.companies.methods.delete.parameters.name.description - resources.projects.resources.companies.methods.get.parameters.name.description - resources.projects.resources.companies.methods.list.parameters.pageSize.description - resources.projects.resources.companies.methods.list.parameters.parent.description - resources.projects.resources.companies.methods.list.parameters.requireOpenJobs.description - resources.projects.resources.companies.methods.patch.description - resources.projects.resources.companies.methods.patch.parameters.name.description - resources.projects.resources.jobs.methods.batchDelete.parameters.parent.description - resources.projects.resources.jobs.methods.create.description - resources.projects.resources.jobs.methods.create.parameters.parent.description - resources.projects.resources.jobs.methods.delete.description - resources.projects.resources.jobs.methods.delete.parameters.name.description - resources.projects.resources.jobs.methods.get.description - resources.projects.resources.jobs.methods.get.parameters.name.description - resources.projects.resources.jobs.methods.list.parameters.filter.description - resources.projects.resources.jobs.methods.list.parameters.jobView.description - resources.projects.resources.jobs.methods.list.parameters.pageSize.description - resources.projects.resources.jobs.methods.list.parameters.parent.description - resources.projects.resources.jobs.methods.patch.description - resources.projects.resources.jobs.methods.patch.parameters.name.description - resources.projects.resources.jobs.methods.search.description - resources.projects.resources.jobs.methods.search.parameters.parent.description - resources.projects.resources.jobs.methods.searchForAlert.description - resources.projects.resources.jobs.methods.searchForAlert.parameters.parent.description - schemas.ApplicationInfo.properties.emails.description - schemas.ApplicationInfo.properties.instruction.description - schemas.ApplicationInfo.properties.uris.description - schemas.BatchDeleteJobsRequest.description - schemas.BatchDeleteJobsRequest.properties.filter.description - schemas.BucketizedCount.properties.range.description - schemas.ClientEvent.description - schemas.ClientEvent.properties.eventId.description - schemas.ClientEvent.properties.extraInfo.description - schemas.ClientEvent.properties.jobEvent.description - schemas.ClientEvent.properties.parentEventId.description - schemas.ClientEvent.properties.requestId.description - schemas.CommuteFilter.description - schemas.CommuteFilter.properties.allowImpreciseAddresses.description - schemas.CommuteFilter.properties.commuteMethod.enumDescriptions - schemas.CommuteFilter.properties.departureTime.description - schemas.CommuteFilter.properties.startCoordinates.description - schemas.CommuteFilter.properties.travelDuration.description - schemas.CommuteInfo.description - schemas.CommuteInfo.properties.travelDuration.description - schemas.Company.description - schemas.Company.properties.careerSiteUri.description - schemas.Company.properties.eeoText.description - schemas.Company.properties.externalId.description - schemas.Company.properties.headquartersAddress.description - schemas.Company.properties.hiringAgency.description - schemas.Company.properties.keywordSearchableJobCustomAttributes.description - schemas.Company.properties.name.description - schemas.Company.properties.suspended.description - schemas.Company.properties.websiteUri.description - schemas.CompanyDerivedInfo.properties.headquartersLocation.description - schemas.CompensationEntry.description - schemas.CompensationEntry.properties.description.description - schemas.CompensationEntry.properties.expectedUnitsPerYear.description - schemas.CompensationEntry.properties.type.description - schemas.CompensationEntry.properties.type.enumDescriptions - schemas.CompensationEntry.properties.unit.description - schemas.CompensationFilter.description - schemas.CompensationFilter.properties.includeJobsWithUnspecifiedCompensationRange.description - schemas.CompensationFilter.properties.type.enumDescriptions - schemas.CompensationFilter.properties.units.description - schemas.CompensationHistogramRequest.description - schemas.CompensationHistogramRequest.properties.type.description - schemas.CompensationHistogramRequest.properties.type.enumDescriptions - schemas.CompensationHistogramResult.description - schemas.CompensationHistogramResult.properties.type.description - schemas.CompensationHistogramResult.properties.type.enumDescriptions - schemas.CompensationInfo.properties.annualizedBaseCompensationRange.description - schemas.CompensationInfo.properties.annualizedTotalCompensationRange.description - schemas.CompensationInfo.properties.entries.description - schemas.CompensationRange.properties.maxCompensation.description - schemas.CompensationRange.properties.minCompensation.description - schemas.CompleteQueryResponse.description - schemas.CompleteQueryResponse.properties.metadata.description - schemas.CompletionResult.description - schemas.CreateClientEventRequest.properties.clientEvent.description - schemas.CreateCompanyRequest.description - schemas.CreateJobRequest.description - schemas.CustomAttribute.properties.filterable.description - schemas.CustomAttribute.properties.longValues.description - schemas.CustomAttribute.properties.stringValues.description - schemas.CustomAttributeHistogramRequest.description - schemas.CustomAttributeHistogramRequest.properties.key.description - schemas.CustomAttributeHistogramRequest.properties.longValueHistogramBucketingOption.description - schemas.CustomAttributeHistogramRequest.properties.stringValueHistogram.description - schemas.CustomAttributeHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.longValueHistogramResult.description - schemas.CustomAttributeHistogramResult.properties.stringValueHistogramResult.description - schemas.DeviceInfo.description - schemas.DeviceInfo.properties.deviceType.enumDescriptions - schemas.DeviceInfo.properties.id.description - schemas.Empty.description - schemas.HistogramFacets.description - schemas.HistogramFacets.properties.compensationHistogramFacets.description - schemas.HistogramFacets.properties.customAttributeHistogramFacets.description - schemas.HistogramFacets.properties.simpleHistogramFacets.description - schemas.HistogramResult.description - schemas.HistogramResult.properties.searchType.enumDescriptions - schemas.HistogramResult.properties.values.description - schemas.HistogramResults.description - schemas.HistogramResults.properties.compensationHistogramResults.description - schemas.HistogramResults.properties.customAttributeHistogramResults.description - schemas.HistogramResults.properties.simpleHistogramResults.description - schemas.Job.description - schemas.Job.properties.addresses.description - schemas.Job.properties.applicationInfo.description - schemas.Job.properties.companyName.description - schemas.Job.properties.customAttributes.description - schemas.Job.properties.department.description - schemas.Job.properties.description.description - schemas.Job.properties.employmentTypes.description - schemas.Job.properties.incentives.description - schemas.Job.properties.jobEndTime.description - schemas.Job.properties.jobLevel.enumDescriptions - schemas.Job.properties.jobStartTime.description - schemas.Job.properties.languageCode.description - schemas.Job.properties.name.description - schemas.Job.properties.postingExpireTime.description - schemas.Job.properties.postingPublishTime.description - schemas.Job.properties.postingRegion.description - schemas.Job.properties.postingRegion.enumDescriptions - schemas.Job.properties.promotionValue.description - schemas.Job.properties.qualifications.description - schemas.Job.properties.requisitionId.description - schemas.Job.properties.responsibilities.description - schemas.Job.properties.title.description - schemas.Job.properties.visibility.description - schemas.Job.properties.visibility.enumDescriptions - schemas.JobDerivedInfo.description - schemas.JobDerivedInfo.properties.locations.description - schemas.JobEvent.description - schemas.JobEvent.properties.jobs.description - schemas.JobEvent.properties.type.enumDescriptions - schemas.JobQuery.description - schemas.JobQuery.properties.commuteFilter.description - schemas.JobQuery.properties.companyDisplayNames.description - schemas.JobQuery.properties.companyNames.description - schemas.JobQuery.properties.compensationFilter.description - schemas.JobQuery.properties.customAttributeFilter.description - schemas.JobQuery.properties.disableSpellCheck.description - schemas.JobQuery.properties.employmentTypes.description - schemas.JobQuery.properties.jobCategories.description - schemas.JobQuery.properties.languageCodes.description - schemas.JobQuery.properties.locationFilters.description - schemas.JobQuery.properties.publishTimeRange.description - schemas.JobQuery.properties.query.description - schemas.JobQuery.properties.queryLanguageCode.description - schemas.LatLng.description - schemas.ListCompaniesResponse.description - schemas.ListCompaniesResponse.properties.metadata.description - schemas.ListJobsResponse.description - schemas.ListJobsResponse.properties.jobs.description - schemas.ListJobsResponse.properties.metadata.description - schemas.Location.description - schemas.Location.properties.locationType.description - schemas.Location.properties.locationType.enumDescriptions - schemas.Location.properties.postalAddress.description - schemas.Location.properties.radiusInMiles.description - schemas.LocationFilter.description - schemas.LocationFilter.properties.distanceInMiles.description - schemas.LocationFilter.properties.latLng.description - schemas.LocationFilter.properties.regionCode.description - schemas.LocationFilter.properties.telecommutePreference.description - schemas.MatchingJob.description - schemas.MatchingJob.properties.commuteInfo.description - schemas.MatchingJob.properties.jobSummary.description - schemas.MatchingJob.properties.jobTitleSnippet.description - schemas.MatchingJob.properties.searchTextSnippet.description - schemas.MendelDebugInput.description - schemas.MendelDebugInput.properties.namespacedDebugInput.description - schemas.Money.properties.nanos.description - schemas.Money.properties.units.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpNames.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExpTags.description - schemas.NamespacedDebugInput.properties.absolutelyForcedExps.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpNames.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExpTags.description - schemas.NamespacedDebugInput.properties.conditionallyForcedExps.description - schemas.NamespacedDebugInput.properties.disableAutomaticEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableExpNames.description - schemas.NamespacedDebugInput.properties.disableExpTags.description - schemas.NamespacedDebugInput.properties.disableExps.description - schemas.NamespacedDebugInput.properties.disableManualEnrollmentSelection.description - schemas.NamespacedDebugInput.properties.disableOrganicSelection.description - schemas.NamespacedDebugInput.properties.forcedFlags.description - schemas.NamespacedDebugInput.properties.forcedRollouts.description - schemas.NumericBucketingOption.description - schemas.NumericBucketingOption.properties.bucketBounds.description - schemas.NumericBucketingOption.properties.requiresMinMax.description - schemas.NumericBucketingResult.description - schemas.NumericBucketingResult.properties.counts.description - schemas.NumericBucketingResult.properties.maxValue.description - schemas.NumericBucketingResult.properties.minValue.description - schemas.PostalAddress.description - schemas.PostalAddress.properties.addressLines.description - schemas.PostalAddress.properties.administrativeArea.description - schemas.PostalAddress.properties.languageCode.description - schemas.PostalAddress.properties.locality.description - schemas.PostalAddress.properties.postalCode.description - schemas.PostalAddress.properties.recipients.description - schemas.PostalAddress.properties.regionCode.description - schemas.PostalAddress.properties.revision.description - schemas.PostalAddress.properties.sortingCode.description - schemas.PostalAddress.properties.sublocality.description - schemas.ProcessingOptions.description - schemas.ProcessingOptions.properties.disableStreetAddressResolution.description - schemas.ProcessingOptions.properties.htmlSanitization.description - schemas.ProcessingOptions.properties.htmlSanitization.enumDescriptions - schemas.RequestMetadata.description - schemas.RequestMetadata.properties.deviceInfo.description - schemas.RequestMetadata.properties.domain.description - schemas.RequestMetadata.properties.sessionId.description - schemas.RequestMetadata.properties.userId.description - schemas.ResponseMetadata.description - schemas.ResponseMetadata.properties.requestId.description - schemas.SearchJobsRequest.description - schemas.SearchJobsRequest.properties.disableKeywordMatch.description - schemas.SearchJobsRequest.properties.diversificationLevel.description - schemas.SearchJobsRequest.properties.diversificationLevel.enumDescriptions - schemas.SearchJobsRequest.properties.enableBroadening.description - schemas.SearchJobsRequest.properties.jobView.description - schemas.SearchJobsRequest.properties.jobView.enumDescriptions - schemas.SearchJobsRequest.properties.offset.description - schemas.SearchJobsRequest.properties.orderBy.description - schemas.SearchJobsRequest.properties.pageSize.description - schemas.SearchJobsRequest.properties.pageToken.description - schemas.SearchJobsRequest.properties.requestMetadata.description - schemas.SearchJobsRequest.properties.requirePreciseResultSize.description - schemas.SearchJobsRequest.properties.searchMode.description - schemas.SearchJobsRequest.properties.searchMode.enumDescriptions - schemas.SearchJobsResponse.description - schemas.SearchJobsResponse.properties.broadenedQueryJobsCount.description - schemas.SearchJobsResponse.properties.estimatedTotalSize.description - schemas.SearchJobsResponse.properties.histogramResults.description - schemas.SearchJobsResponse.properties.locationFilters.description - schemas.SearchJobsResponse.properties.metadata.description - schemas.SearchJobsResponse.properties.nextPageToken.description - schemas.SearchJobsResponse.properties.totalSize.description - schemas.SpellingCorrection.description - schemas.TimeOfDay.description - schemas.TimeOfDay.properties.hours.description - schemas.TimeOfDay.properties.seconds.description - schemas.UpdateCompanyRequest.description - schemas.UpdateCompanyRequest.properties.updateMask.description - schemas.UpdateJobRequest.description - schemas.UpdateJobRequest.properties.updateMask.description --- discovery/jobs-v2.json | 2103 ++++++++++++++++++++++----------- discovery/jobs-v3.json | 1842 ++++++++++++++++++++--------- discovery/jobs-v3p1beta1.json | 1891 ++++++++++++++++++++--------- src/apis/jobs/v2.ts | 857 +++++++++----- src/apis/jobs/v3.ts | 845 ++++++++----- src/apis/jobs/v3p1beta1.ts | 854 ++++++++----- 6 files changed, 5694 insertions(+), 2698 deletions(-) diff --git a/discovery/jobs-v2.json b/discovery/jobs-v2.json index c4e7ee788a..84d3700a5a 100644 --- a/discovery/jobs-v2.json +++ b/discovery/jobs-v2.json @@ -15,7 +15,7 @@ "baseUrl": "https://jobs.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Talent Solution", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.\n", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "fullyEncodeReservedExpansion": true, @@ -139,7 +139,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the company to be deleted,\nsuch as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", + "description": "Required. The resource name of the company to be deleted, such as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", "location": "path", "pattern": "^companies/[^/]+$", "required": true, @@ -165,7 +165,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the company to retrieve,\nsuch as \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", + "description": "Required. Resource name of the company to retrieve, such as \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", "location": "path", "pattern": "^companies/[^/]+$", "required": true, @@ -189,12 +189,12 @@ "parameterOrder": [], "parameters": { "mustHaveOpenJobs": { - "description": "Optional. Set to true if the companies request must have open jobs.\n\nDefaults to false.\n\nIf true, at most page_size of companies are fetched, among which\nonly those with open jobs are returned.", + "description": "Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.", "location": "query", "type": "boolean" }, "pageSize": { - "description": "Optional. The maximum number of companies to be returned, at most 100.\nDefault is 100 if a non-positive number is provided.", + "description": "Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.", "format": "int32", "location": "query", "type": "integer" @@ -215,7 +215,7 @@ ] }, "patch": { - "description": "Updates the specified company. Company names can't be updated. To update a\ncompany name, delete the company and all jobs associated with it, and only\nthen re-create them.", + "description": "Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.", "flatPath": "v2/companies/{companiesId}", "httpMethod": "PATCH", "id": "jobs.companies.patch", @@ -224,14 +224,14 @@ ], "parameters": { "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created, for example,\n\"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", + "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", "location": "path", "pattern": "^companies/[^/]+$", "required": true, "type": "string" }, "updateCompanyFields": { - "description": "Optional but strongly recommended to be provided for the best service\nexperience.\n\nIf update_company_fields is provided, only the specified fields in\ncompany are updated. Otherwise all the fields are updated.\n\nA field mask to specify the company fields to update. Valid values are:\n\n* displayName\n* website\n* imageUrl\n* companySize\n* distributorBillingCompanyId\n* companyInfoSources\n* careerPageLink\n* hiringAgency\n* hqLocation\n* eeoText\n* keywordSearchableCustomAttributes\n* title (deprecated)\n* keywordSearchableCustomFields (deprecated)", + "description": "Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -254,7 +254,7 @@ "jobs": { "methods": { "list": { - "description": "Deprecated. Use ListJobs instead.\n\nLists all jobs associated with a company.", + "description": "Deprecated. Use ListJobs instead. Lists all jobs associated with a company.", "flatPath": "v2/companies/{companiesId}/jobs", "httpMethod": "GET", "id": "jobs.companies.jobs.list", @@ -263,29 +263,29 @@ ], "parameters": { "companyName": { - "description": "Required. The resource name of the company that owns the jobs to be listed,\nsuch as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", + "description": "Required. The resource name of the company that owns the jobs to be listed, such as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", "location": "path", "pattern": "^companies/[^/]+$", "required": true, "type": "string" }, "idsOnly": { - "description": "Optional. If set to `true`, only job ID, job requisition ID and language code will be\nreturned.\n\nA typical use is to synchronize job repositories.\n\nDefaults to false.", + "description": "Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false.", "location": "query", "type": "boolean" }, "includeJobsCount": { - "description": "Deprecated. Please DO NOT use this field except for small companies.\nSuggest counting jobs page by page instead.\n\nOptional.\n\nSet to true if the total number of open jobs is to be returned.\n\nDefaults to false.", + "description": "Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false.", "location": "query", "type": "boolean" }, "jobRequisitionId": { - "description": "Optional. The requisition ID, also known as posting ID, assigned by the company\nto the job.\n\nThe maximum number of allowable characters is 225.", + "description": "Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results.\n\nIf ids_only is set to true, the maximum allowed page size\nis 1000. Otherwise, the maximum allowed page size is 100.\n\nDefault is 100 if empty or a number < 1 is specified.", + "description": "Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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.", "format": "int32", "location": "query", "type": "integer" @@ -331,7 +331,7 @@ ] }, "create": { - "description": "Creates a new job.\n\nTypically, the job becomes searchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v2/jobs", "httpMethod": "POST", "id": "jobs.jobs.create", @@ -350,7 +350,7 @@ ] }, "delete": { - "description": "Deletes the specified job.\n\nTypically, the job becomes unsearchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v2/jobs/{jobsId}", "httpMethod": "DELETE", "id": "jobs.jobs.delete", @@ -359,7 +359,7 @@ ], "parameters": { "disableFastProcess": { - "description": "Deprecated. This field is not working anymore.\n\nOptional.\n\nIf set to true, this call waits for all processing steps to complete\nbefore the job is cleaned up. Otherwise, the call returns while some\nsteps are still taking place asynchronously, hence faster.", + "description": "Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.", "location": "query", "type": "boolean" }, @@ -381,7 +381,7 @@ ] }, "deleteByFilter": { - "description": "Deprecated. Use BatchDeleteJobs instead.\n\nDeletes the specified job by filter. You can specify whether to\nsynchronously wait for validation, indexing, and general processing to be\ncompleted before the response is returned.", + "description": "Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned.", "flatPath": "v2/jobs:deleteByFilter", "httpMethod": "POST", "id": "jobs.jobs.deleteByFilter", @@ -400,7 +400,7 @@ ] }, "get": { - "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED\nwithin the last 90 days.", + "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.", "flatPath": "v2/jobs/{jobsId}", "httpMethod": "GET", "id": "jobs.jobs.get", @@ -426,7 +426,7 @@ ] }, "histogram": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make\na single call with both search and histogram.\n\nRetrieves a histogram for the given\nGetHistogramRequest. This call provides a structured\ncount of jobs that match against the search query, grouped by specified\nfacets.\n\nThis call constrains the visibility of jobs\npresent in the database, and only counts jobs the caller has\npermission to search against.\n\nFor example, use this call to generate the\nnumber of jobs in the U.S. by state.", + "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state.", "flatPath": "v2/jobs:histogram", "httpMethod": "POST", "id": "jobs.jobs.histogram", @@ -452,17 +452,17 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Required. The filter string specifies the jobs to be enumerated.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Optional)\n\nSample Query:\n\n* companyName = \"companies/123\"\n* companyName = \"companies/123\" AND requisitionId = \"req-1\"", + "description": "Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = \"companies/123\" * companyName = \"companies/123\" AND requisitionId = \"req-1\"", "location": "query", "type": "string" }, "idsOnly": { - "description": "Optional. If set to `true`, only Job.name, Job.requisition_id and\nJob.language_code will be returned.\n\nA typical use case is to synchronize job repositories.\n\nDefaults to false.", + "description": "Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false.", "location": "query", "type": "boolean" }, "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results.\n\nIf ids_only is set to true, the maximum allowed page size\nis 1000. Otherwise, the maximum allowed page size is 100.\n\nDefault is 100 if empty or a number < 1 is specified.", + "description": "Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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.", "format": "int32", "location": "query", "type": "integer" @@ -483,7 +483,7 @@ ] }, "patch": { - "description": "Updates specified job.\n\nTypically, updated contents become visible in search results within 10\nseconds, but it may take up to 5 minutes.", + "description": "Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v2/jobs/{jobsId}", "httpMethod": "PATCH", "id": "jobs.jobs.patch", @@ -492,7 +492,7 @@ ], "parameters": { "name": { - "description": "Required during job update.\n\nResource name assigned to a job by the API, for example, \"/jobs/foo\". Use\nof this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "Required during job update. Resource name assigned to a job by the API, for example, \"/jobs/foo\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "location": "path", "pattern": "^jobs/[^/]+$", "required": true, @@ -512,7 +512,7 @@ ] }, "search": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs that the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.", "flatPath": "v2/jobs:search", "httpMethod": "POST", "id": "jobs.jobs.search", @@ -531,7 +531,7 @@ ] }, "searchForAlert": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis API call is intended for the use case of targeting passive job\nseekers (for example, job seekers who have signed up to receive email\nalerts about potential job opportunities), and has different algorithmic\nadjustments that are targeted to passive job seekers.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.", "flatPath": "v2/jobs:searchForAlert", "httpMethod": "POST", "id": "jobs.jobs.searchForAlert", @@ -554,7 +554,7 @@ "v2": { "methods": { "complete": { - "description": "Completes the specified prefix with job keyword suggestions.\nIntended for use by a job search auto-complete search box.", + "description": "Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.", "flatPath": "v2:complete", "httpMethod": "GET", "id": "jobs.complete", @@ -566,12 +566,12 @@ "type": "string" }, "languageCode": { - "description": "Required. The language of the query. This is\nthe BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nFor CompletionType.JOB_TITLE type, only open jobs with same\nlanguage_code are returned.\n\nFor CompletionType.COMPANY_NAME type,\nonly companies having open jobs with same language_code are\nreturned.\n\nFor CompletionType.COMBINED type, only open jobs with same\nlanguage_code or companies having open jobs with same\nlanguage_code are returned.", + "description": "Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.", "location": "query", "type": "string" }, "pageSize": { - "description": "Required. Completion result count.\nThe maximum allowed page size is 10.", + "description": "Required. Completion result count. The maximum allowed page size is 10.", "format": "int32", "location": "query", "type": "integer" @@ -588,6 +588,11 @@ "TENANT", "PUBLIC" ], + "enumDescriptions": [ + "Default value.", + "Suggestions are based only on the data provided by the client.", + "Suggestions are based on all jobs data in the system that's visible to the client" + ], "location": "query", "type": "string" }, @@ -599,6 +604,12 @@ "COMPANY_NAME", "COMBINED" ], + "enumDescriptions": [ + "Default value.", + "Only suggest job titles.", + "Only suggest company names.", + "Suggest both job titles and company names." + ], "location": "query", "type": "string" } @@ -615,15 +626,15 @@ } } }, - "revision": "20200506", + "revision": "20200929", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "BatchDeleteJobsRequest": { - "description": "Input only.\n\nBatch delete jobs request.", + "description": "Input only. Batch delete jobs request.", "id": "BatchDeleteJobsRequest", "properties": { "filter": { - "description": "Required. The filter string specifies the jobs to be deleted.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Required)\n\nSample Query: companyName = \"companies/123\" AND requisitionId = \"req-1\"", + "description": "Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = \"companies/123\" AND requisitionId = \"req-1\"", "type": "string" } }, @@ -657,13 +668,13 @@ }, "range": { "$ref": "BucketRange", - "description": "Bucket range on which histogram was performed for the numeric field,\nthat is, the count represents number of jobs in this range." + "description": "Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range." } }, "type": "object" }, "CommuteInfo": { - "description": "Output only.\n\nCommute details related to this job.", + "description": "Output only. Commute details related to this job.", "id": "CommuteInfo", "properties": { "jobLocation": { @@ -671,7 +682,7 @@ "description": "Location used as the destination in the commute calculation." }, "travelDuration": { - "description": "The number of seconds required to travel to the job location from the query\nlocation. A duration of 0 seconds indicates that the job is not\nreachable within the requested duration, but was returned as part of an\nexpanded query.", + "description": "The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.", "format": "google-duration", "type": "string" } @@ -679,15 +690,15 @@ "type": "object" }, "CommutePreference": { - "description": "Input only.\n\nParameters needed for commute search.", + "description": "Input only. Parameters needed for commute search.", "id": "CommutePreference", "properties": { "allowNonStreetLevelAddress": { - "description": "Optional. If `true`, jobs without street level addresses may also be returned.\nFor city level addresses, the city center is used. For state and coarser\nlevel addresses, text matching is used.\nIf this field is set to `false` or is not specified, only jobs that include\nstreet level addresses will be returned by commute search.", + "description": "Optional. 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 to `false` or is not specified, only jobs that include street level addresses will be returned by commute search.", "type": "boolean" }, "departureHourLocal": { - "description": "Optional. The departure hour to use to calculate traffic impact. Accepts an\ninteger between 0 and 23, representing the hour in the time zone of the\nstart_location. Must not be present if road_traffic is specified.", + "description": "Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified.", "format": "int32", "type": "integer" }, @@ -701,12 +712,12 @@ "enumDescriptions": [ "Commute method is not specified.", "Commute time is calculated based on driving time.", - "Commute time is calculated based on public transit including bus, metro,\nsubway, etc." + "Commute time is calculated based on public transit including bus, metro, subway, etc." ], "type": "string" }, "roadTraffic": { - "description": "Optional. Specifies the traffic density to use when calculating commute time.\nMust not be present if departure_hour_local is specified.", + "description": "Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified.", "enum": [ "ROAD_TRAFFIC_UNSPECIFIED", "TRAFFIC_FREE", @@ -721,10 +732,10 @@ }, "startLocation": { "$ref": "LatLng", - "description": "Required. The latitude and longitude of the location from which to calculate the\ncommute time." + "description": "Required. The latitude and longitude of the location from which to calculate the commute time." }, "travelTime": { - "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s`\n(one hour). Format is `123s`.", + "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.", "format": "google-duration", "type": "string" } @@ -732,15 +743,15 @@ "type": "object" }, "Company": { - "description": "A Company resource represents a company in the service. A company is the\nentity that owns job listings, that is, the hiring entity responsible for\nemploying applicants for the job position.", + "description": "A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position.", "id": "Company", "properties": { "careerPageLink": { - "description": "Optional. The URL to employer's career site or careers page on the employer's web\nsite.", + "description": "Optional. The URL to employer's career site or careers page on the employer's web site.", "type": "string" }, "companyInfoSources": { - "description": "Optional. Identifiers external to the application that help to further identify\nthe employer.", + "description": "Optional. Identifiers external to the application that help to further identify the employer.", "items": { "$ref": "CompanyInfoSource" }, @@ -771,46 +782,46 @@ "type": "string" }, "disableLocationOptimization": { - "description": "Deprecated. Do not use this field.\n\nOptional.\n\nThis field is no longer used. Any value set to it is ignored.", + "description": "Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored.", "type": "boolean" }, "displayName": { - "description": "Required. The name of the employer to be displayed with the job,\nfor example, \"Google, LLC.\".", + "description": "Required. The name of the employer to be displayed with the job, for example, \"Google, LLC.\".", "type": "string" }, "distributorBillingCompanyId": { - "description": "Optional. The unique company identifier provided by the client to identify an\nemployer for billing purposes. Recommended practice is to use\nthe distributor_company_id.\n\nDefaults to same value as distributor_company_id when a value\nis not provided.", + "description": "Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided.", "type": "string" }, "distributorCompanyId": { - "description": "Required. A client's company identifier, used to uniquely identify the\ncompany. If an employer has a subsidiary or sub-brand, such as \"Alphabet\"\nand \"Google\", which the client wishes to use as the company displayed on\nthe job. Best practice is to create a distinct company identifier for each\ndistinct brand displayed.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as \"Alphabet\" and \"Google\", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255.", "type": "string" }, "eeoText": { - "description": "Optional. Equal Employment Opportunity legal disclaimer text to be\nassociated with all jobs, and typically to be displayed in all\nroles.\n\nThe maximum number of allowed characters is 500.", + "description": "Optional. 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": "string" }, "hiringAgency": { - "description": "Optional. Set to true if it is the hiring agency that post jobs for other\nemployers.\n\nDefaults to false if not provided.", + "description": "Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.", "type": "boolean" }, "hqLocation": { - "description": "Optional. The street address of the company's main headquarters, which may be\ndifferent from the job location. The service attempts\nto geolocate the provided address, and populates a more specific\nlocation wherever possible in structured_company_hq_location.", + "description": "Optional. 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 structured_company_hq_location.", "type": "string" }, "imageUrl": { - "description": "Optional. A URL that hosts the employer's company logo. If provided,\nthe logo image should be squared at 80x80 pixels.\n\nThe url must be a Google Photos or Google Album url.\nOnly images in these Google sub-domains are accepted.", + "description": "Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted.", "type": "string" }, "keywordSearchableCustomAttributes": { - "description": "Optional. A list of keys of filterable Job.custom_attributes, whose\ncorresponding `string_values` are used in keyword search. Jobs with\n`string_values` under these specified field keys are returned if any\nof the values matches the search keyword. Custom field values with\nparenthesis, brackets and special symbols might not be properly searchable,\nand those keyword queries need to be surrounded by quotes.", + "description": "Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.", "items": { "type": "string" }, "type": "array" }, "keywordSearchableCustomFields": { - "description": "Deprecated. Use keyword_searchable_custom_attributes instead.\n\nOptional.\n\nA list of filterable custom fields that should be used in keyword\nsearch. The jobs of this company are returned if any of these custom\nfields matches the search keyword. Custom field values with parenthesis,\nbrackets and special symbols might not be properly searchable, and those\nkeyword queries need to be surrounded by quotes.", + "description": "Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.", "items": { "format": "int32", "type": "integer" @@ -818,30 +829,30 @@ "type": "array" }, "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created, for example,\n\"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", + "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", "type": "string" }, "structuredCompanyHqLocation": { "$ref": "JobLocation", - "description": "Output only. A structured headquarters location of the company,\nresolved from hq_location if possible." + "description": "Output only. A structured headquarters location of the company, resolved from hq_location if possible." }, "suspended": { - "description": "Output only. Indicates whether a company is flagged to be suspended from public\navailability by the service when job content appears suspicious,\nabusive, or spammy.", + "description": "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": "boolean" }, "title": { - "description": "Deprecated. Use display_name instead.\n\nRequired.\n\nThe name of the employer to be displayed with the job,\nfor example, \"Google, LLC.\".", + "description": "Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, \"Google, LLC.\".", "type": "string" }, "website": { - "description": "Optional. The URL representing the company's primary web site or home page,\nsuch as, \"www.google.com\".", + "description": "Optional. The URL representing the company's primary web site or home page, such as, \"www.google.com\".", "type": "string" } }, "type": "object" }, "CompanyInfoSource": { - "description": "A resource that represents an external Google identifier for a company,\nfor example, a Google+ business page or a Google Maps business page.\nFor unsupported types, use `unknown_type_id`.", + "description": "A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`.", "id": "CompanyInfoSource", "properties": { "freebaseMid": { @@ -853,7 +864,7 @@ "type": "string" }, "mapsCid": { - "description": "Optional. The numeric identifier for the employer's headquarters on Google Maps,\nnamely, the Google Maps CID (cell id).", + "description": "Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id).", "type": "string" }, "unknownTypeId": { @@ -864,7 +875,7 @@ "type": "object" }, "CompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such\nas base pay, bonus, or other compensation type.\n\nAnnualization: One compensation entry can be annualized if\n- it contains valid amount or range.\n- and its expected_units_per_year is set or can be derived.\nIts annualized range is determined as (amount or range) times\nexpected_units_per_year.", + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", "id": "CompensationEntry", "properties": { "amount": { @@ -872,11 +883,11 @@ "description": "Optional. Compensation amount." }, "description": { - "description": "Optional. Compensation description. For example, could\nindicate equity terms or provide additional context to an estimated\nbonus.", + "description": "Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", "type": "string" }, "expectedUnitsPerYear": { - "description": "Optional. Expected number of units paid each year. If not specified, when\nJob.employment_types is FULLTIME, a default value is inferred\nbased on unit. Default values:\n- HOURLY: 2080\n- DAILY: 260\n- WEEKLY: 52\n- MONTHLY: 12\n- ANNUAL: 1", + "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", "format": "double", "type": "number" }, @@ -899,7 +910,7 @@ ], "enumDescriptions": [ "Default value. Equivalent to OTHER_COMPENSATION_TYPE.", - "Base compensation: Refers to the fixed amount of money paid to an\nemployee by an employer in return for work performed. Base compensation\ndoes not include benefits, bonuses or any other potential compensation\nfrom an employer.", + "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.", "Signing bonus.", "Equity.", @@ -911,7 +922,7 @@ "type": "string" }, "unit": { - "description": "Optional. Frequency of the specified amount.\n\nDefault is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", "HOURLY", @@ -938,7 +949,7 @@ "type": "object" }, "CompensationFilter": { - "description": "Input only.\n\nFilter on job compensation type and amount.", + "description": "Input only. Filter on job compensation type and amount.", "id": "CompensationFilter", "properties": { "includeJobsWithUnspecifiedCompensationRange": { @@ -960,25 +971,15 @@ ], "enumDescriptions": [ "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and\nonly if the job contains a base CompensationEntry and the base\nCompensationEntry's unit matches provided units.\nPopulate one or more units.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job\nis a match if and only if the job contains a base CompensationEntry, and\nthe base entry's unit matches provided compensation_units and amount\nor range overlaps with provided compensation_range.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.\n\nSet exactly one units and populate range.", - "Filter by annualized base compensation amount and `base compensation\nentry's` unit. Populate range and zero or more units.", - "Filter by annualized total compensation amount and `base compensation\nentry's` unit . Populate range and zero or more units." + "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units. See CompensationInfo.CompensationEntry for definition of base compensation entry.", + "Filter by `base compensation entry's` unit 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 compensation_units and amount or range overlaps with provided compensation_range. See CompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one units and populate range.", + "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate range and zero or more units.", + "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate range and zero or more units." ], "type": "string" }, "units": { - "description": "Required. Specify desired `base compensation entry's`\nCompensationInfo.CompensationUnit.", - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], + "description": "Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.", "items": { "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", @@ -990,6 +991,16 @@ "ONE_TIME", "OTHER_COMPENSATION_UNIT" ], + "enumDescriptions": [ + "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], "type": "string" }, "type": "array" @@ -998,7 +1009,7 @@ "type": "object" }, "CompensationHistogramRequest": { - "description": "Input only.\n\nCompensation based histogram request.", + "description": "Input only. Compensation based histogram request.", "id": "CompensationHistogramRequest", "properties": { "bucketingOption": { @@ -1006,7 +1017,7 @@ "description": "Required. Numeric histogram options, like buckets, whether include min or max value." }, "type": { - "description": "Required. Type of the request, representing which field the histogramming should be\nperformed over. A single request can only specify one histogram of each\n`CompensationHistogramRequestType`.", + "description": "Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1015,9 +1026,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1025,7 +1036,7 @@ "type": "object" }, "CompensationHistogramResult": { - "description": "Output only.\n\nCompensation based histogram result.", + "description": "Output only. Compensation based histogram result.", "id": "CompensationHistogramResult", "properties": { "result": { @@ -1033,7 +1044,7 @@ "description": "Histogram result." }, "type": { - "description": "Type of the request, corresponding to\nCompensationHistogramRequest.type.", + "description": "Type of the request, corresponding to CompensationHistogramRequest.type.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1042,9 +1053,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1057,18 +1068,18 @@ "properties": { "amount": { "$ref": "Money", - "description": "Deprecated. Use entries instead.\n\nOptional.\n\nThe amount of compensation or pay for the job.\nAs an alternative, compensation_amount_min and\ncompensation_amount_max may be used to define a range of\ncompensation." + "description": "Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation." }, "annualizedBaseCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized base compensation range. Computed as\nbase compensation entry's CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "annualizedTotalCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized total compensation range. Computed as\nall compensation entries' CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "entries": { - "description": "Optional. Job compensation information.\n\nAt most one entry can be of type\nCompensationInfo.CompensationType.BASE, which is\nreferred as ** base compensation entry ** for the job.", + "description": "Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", "items": { "$ref": "CompensationEntry" }, @@ -1076,14 +1087,14 @@ }, "max": { "$ref": "Money", - "description": "Deprecated. Use entries instead.\n\nOptional.\n\nAn upper bound on a range for compensation or pay for the job.\nThe currency type is specified in compensation_amount." + "description": "Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount." }, "min": { "$ref": "Money", - "description": "Deprecated. Use entries instead.\n\nOptional.\n\nA lower bound on a range for compensation or pay for the job.\nThe currency type is specified in compensation_amount." + "description": "Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount." }, "type": { - "description": "Deprecated. Use entries instead.\n\nOptional.\n\nType of job compensation.", + "description": "Deprecated. Use entries instead. Optional. Type of job compensation.", "enum": [ "JOB_COMPENSATION_TYPE_UNSPECIFIED", "HOURLY", @@ -1098,7 +1109,7 @@ "The job compensation is quoted on an annual basis.", "The job compensation is quoted by project completion.", "The job compensation is quoted based solely on commission.", - "The job compensation is not quoted according to the listed compensation\noptions." + "The job compensation is not quoted according to the listed compensation options." ], "type": "string" } @@ -1111,17 +1122,17 @@ "properties": { "max": { "$ref": "Money", - "description": "Optional. The maximum amount of compensation. If left empty, the value is set\nto a maximal compensation value and the currency code is set to\nmatch the currency code of\nmin_compensation." + "description": "Optional. 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 of min_compensation." }, "min": { "$ref": "Money", - "description": "Optional. The minimum amount of compensation. If left empty, the value is set\nto zero and the currency code is set to match the\ncurrency code of max_compensation." + "description": "Optional. 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 of max_compensation." } }, "type": "object" }, "CompleteQueryResponse": { - "description": "Output only.\n\nResponse of auto-complete query.", + "description": "Output only. Response of auto-complete query.", "id": "CompleteQueryResponse", "properties": { "completionResults": { @@ -1133,13 +1144,13 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." } }, "type": "object" }, "CompletionResult": { - "description": "Output only.\n\nResource that represents completion results.", + "description": "Output only. Resource that represents completion results.", "id": "CompletionResult", "properties": { "imageUrl": { @@ -1170,11 +1181,11 @@ "type": "object" }, "CreateJobRequest": { - "description": "Input only.\n\nCreate job request.", + "description": "Input only. Create job request.", "id": "CreateJobRequest", "properties": { "disableStreetAddressResolution": { - "description": "Deprecated. Please use processing_options. This flag is ignored if\nprocessing_options is set.\n\nOptional.\n\nIf set to `true`, the service does not attempt to resolve a\nmore precise address for the job.", + "description": "Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", "type": "boolean" }, "job": { @@ -1193,42 +1204,42 @@ "id": "CustomAttribute", "properties": { "filterable": { - "description": "Optional. If the `filterable` flag is true, custom field values are searchable.\nIf false, values are not searchable.\n\nDefault is false.", + "description": "Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false.", "type": "boolean" }, "longValue": { - "description": "Optional but at least one of string_values or long_value must\nbe specified.\n\nThis field is used to perform number range search.\n(`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For\n`long_value`, a value between Long.MIN and Long.MAX is allowed.", + "description": "Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed.", "format": "int64", "type": "string" }, "stringValues": { "$ref": "StringValues", - "description": "Optional but at least one of string_values or long_value must\nbe specified.\n\nThis field is used to perform a string match (`CASE_SENSITIVE_MATCH` or\n`CASE_INSENSITIVE_MATCH`) search.\nFor filterable `string_values`, a maximum total number of 200 values\nis allowed, with each `string_value` has a byte size of no more than\n255B. For unfilterable `string_values`, the maximum total byte size of\nunfilterable `string_values` is 50KB.\n\nEmpty strings are not allowed." + "description": "Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed." } }, "type": "object" }, "CustomAttributeHistogramRequest": { - "description": "Custom attributes histogram request. An error will be thrown if neither\nstring_value_histogram or long_value_histogram_bucketing_option has\nbeen defined.", + "description": "Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.", "id": "CustomAttributeHistogramRequest", "properties": { "key": { - "description": "Required. Specifies the custom field key to perform a histogram on. If specified\nwithout `long_value_histogram_bucketing_option`, histogram on string values\nof the given `key` is triggered, otherwise histogram is performed on long\nvalues.", + "description": "Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.", "type": "string" }, "longValueHistogramBucketingOption": { "$ref": "NumericBucketingOption", - "description": "Optional. Specifies buckets used to perform a range histogram on Job's\nfilterable long custom field values, or min/max value requirements." + "description": "Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements." }, "stringValueHistogram": { - "description": "Optional. If set to true, the response will include the histogram value for\neach key as a string.", + "description": "Optional. If set to true, the response will include the histogram value for each key as a string.", "type": "boolean" } }, "type": "object" }, "CustomAttributeHistogramResult": { - "description": "Output only.\n\nCustom attribute histogram result.", + "description": "Output only. Custom attribute histogram result.", "id": "CustomAttributeHistogramResult", "properties": { "key": { @@ -1237,14 +1248,14 @@ }, "longValueHistogramResult": { "$ref": "NumericBucketingResult", - "description": "Stores bucketed histogram counting result or min/max values for\ncustom attribute long values associated with `key`." + "description": "Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`." }, "stringValueHistogramResult": { "additionalProperties": { "format": "int32", "type": "integer" }, - "description": "Stores a map from the values of string custom field associated\nwith `key` to the number of jobs with that value in this histogram result.", + "description": "Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.", "type": "object" } }, @@ -1265,7 +1276,7 @@ "type": "object" }, "CustomFieldFilter": { - "description": "Input only.\n\nCustom field filter of the search.", + "description": "Input only. Custom field filter of the search.", "id": "CustomFieldFilter", "properties": { "queries": { @@ -1276,7 +1287,7 @@ "type": "array" }, "type": { - "description": "Optional. The type of filter.\nDefaults to FilterType.OR.", + "description": "Optional. The type of filter. Defaults to FilterType.OR.", "enum": [ "FILTER_TYPE_UNSPECIFIED", "OR", @@ -1295,21 +1306,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.", + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.", + "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", "format": "int32", "type": "integer" } @@ -1317,11 +1328,11 @@ "type": "object" }, "DeleteJobsByFilterRequest": { - "description": "Deprecated. Use BatchDeleteJobsRequest instead.\n\nInput only.\n\nDelete job by filter request.\n\nThe job typically becomes unsearchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", "id": "DeleteJobsByFilterRequest", "properties": { "disableFastProcess": { - "description": "Optional. If set to true, this call waits for all processing steps to complete\nbefore the job is cleaned up. Otherwise, the call returns while some\nsteps are still taking place asynchronously, hence faster.", + "description": "Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.", "type": "boolean" }, "filter": { @@ -1332,7 +1343,7 @@ "type": "object" }, "DeviceInfo": { - "description": "Input only.\n\nDevice information collected from the job seeker, candidate, or\nother entity conducting the job search. Providing this information improves\nthe quality of the search results across devices.", + "description": "Input only. 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.", "id": "DeviceInfo", "properties": { "deviceType": { @@ -1348,30 +1359,30 @@ ], "enumDescriptions": [ "The device type isn't specified.", - "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet\nExplorer)", - "A mobile device web browser, such as a phone or tablet with a Chrome\nbrowser.", + "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)", + "A mobile device web browser, such as a phone or tablet with a Chrome browser.", "An Android device native application.", "An iOS device native application.", - "A bot, as opposed to a device operated by human beings, such as a web\ncrawler.", + "A bot, as opposed to a device operated by human beings, such as a web crawler.", "Other devices types." ], "type": "string" }, "id": { - "description": "Optional. A device-specific ID. The ID must be a unique identifier that distinguishes\nthe device from other devices.", + "description": "Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.", "type": "string" } }, "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "ExtendedCompensationFilter": { - "description": "Deprecated. Always use CompensationFilter.\n\nInput only.\n\nFilter on job compensation type and amount.", + "description": "Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount.", "id": "ExtendedCompensationFilter", "properties": { "compensationRange": { @@ -1379,17 +1390,7 @@ "description": "Optional. Compensation range." }, "compensationUnits": { - "description": "Required. Specify desired `base compensation entry's`\nExtendedCompensationInfo.CompensationUnit.", - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], + "description": "Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit.", "items": { "enum": [ "EXTENDED_COMPENSATION_UNIT_UNSPECIFIED", @@ -1401,12 +1402,22 @@ "ONE_TIME", "OTHER_COMPENSATION_UNIT" ], + "enumDescriptions": [ + "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], "type": "string" }, "type": "array" }, "currency": { - "description": "Optional. Specify currency in 3-letter\n[ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If\nunspecified, jobs are returned regardless of currency.", + "description": "Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency.", "type": "string" }, "includeJobWithUnspecifiedCompensationRange": { @@ -1424,10 +1435,10 @@ ], "enumDescriptions": [ "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and\nonly if the job contains a base CompensationEntry and the base\nCompensationEntry's unit matches provided compensation_units.\nPopulate one or more compensation_units.\n\nSee ExtendedCompensationInfo.CompensationEntry for definition of\nbase compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job\nis a match if and only if the job contains a base CompensationEntry, and\nthe base entry's unit matches provided compensation_units and amount\nor range overlaps with provided compensation_range.\n\nSee ExtendedCompensationInfo.CompensationEntry for definition of\nbase compensation entry.\n\nSet exactly one\ncompensation_units and populate\ncompensation_range.", - "Filter by annualized base compensation amount and `base compensation\nentry's` unit. Populate compensation_range and zero or more\ncompensation_units.", - "Filter by annualized total compensation amount and `base compensation\nentry's` unit . Populate compensation_range and zero or more\ncompensation_units." + "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided compensation_units. Populate one or more compensation_units. See ExtendedCompensationInfo.CompensationEntry for definition of base compensation entry.", + "Filter by `base compensation entry's` unit 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 compensation_units and amount or range overlaps with provided compensation_range. See ExtendedCompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one compensation_units and populate compensation_range.", + "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate compensation_range and zero or more compensation_units.", + "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate compensation_range and zero or more compensation_units." ], "type": "string" } @@ -1435,7 +1446,7 @@ "type": "object" }, "ExtendedCompensationInfo": { - "description": "Deprecated. Use CompensationInfo.\n\nDescribes job compensation.", + "description": "Deprecated. Use CompensationInfo. Describes job compensation.", "id": "ExtendedCompensationInfo", "properties": { "annualizedBaseCompensationRange": { @@ -1443,7 +1454,7 @@ "description": "Output only. Annualized base compensation range." }, "annualizedBaseCompensationUnspecified": { - "description": "Output only. Indicates annualized base compensation range cannot be derived, due to\nthe job's base compensation entry cannot be annualized.\nSee CompensationEntry for explanation on annualization and base\ncompensation entry.", + "description": "Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.", "type": "boolean" }, "annualizedTotalCompensationRange": { @@ -1451,15 +1462,15 @@ "description": "Output only. Annualized total compensation range." }, "annualizedTotalCompensationUnspecified": { - "description": "Output only. Indicates annualized total compensation range cannot be derived, due to\nthe job's all CompensationEntry cannot be annualized.\nSee CompensationEntry for explanation on annualization and base\ncompensation entry.", + "description": "Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.", "type": "boolean" }, "currency": { - "description": "Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)\ncurrency code.", + "description": "Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.", "type": "string" }, "entries": { - "description": "Optional. Job compensation information.\n\nAt most one entry can be of type\nExtendedCompensationInfo.CompensationType.BASE, which is\nreferred as ** base compensation entry ** for the job.", + "description": "Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", "items": { "$ref": "ExtendedCompensationInfoCompensationEntry" }, @@ -1469,7 +1480,7 @@ "type": "object" }, "ExtendedCompensationInfoCompensationEntry": { - "description": "Deprecated. See CompensationInfo.\n\nA compensation entry that represents one component of compensation, such\nas base pay, bonus, or other compensation type.\n\nAnnualization: One compensation entry can be annualized if\n- it contains valid amount or range.\n- and its expected_units_per_year is set or can be derived.\nIts annualized range is determined as (amount or range) times\nexpected_units_per_year.", + "description": "Deprecated. See CompensationInfo. A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", "id": "ExtendedCompensationInfoCompensationEntry", "properties": { "amount": { @@ -1482,7 +1493,7 @@ }, "expectedUnitsPerYear": { "$ref": "ExtendedCompensationInfoDecimal", - "description": "Optional. Expected number of units paid each year. If not specified, when\nJob.employment_types is FULLTIME, a default value is inferred\nbased on unit. Default values:\n- HOURLY: 2080\n- DAILY: 260\n- WEEKLY: 52\n- MONTHLY: 12\n- ANNUAL: 1" + "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1" }, "range": { "$ref": "ExtendedCompensationInfoCompensationRange", @@ -1503,7 +1514,7 @@ ], "enumDescriptions": [ "Default value. Equivalent to OTHER_COMPENSATION_TYPE.", - "Base compensation: Refers to the fixed amount of money paid to an\nemployee by an employer in return for work performed. Base compensation\ndoes not include benefits, bonuses or any other potential compensation\nfrom an employer.", + "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.", "Signing bonus.", "Equity.", @@ -1515,7 +1526,7 @@ "type": "string" }, "unit": { - "description": "Optional. Frequency of the specified amount.\n\nDefault is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", "enum": [ "EXTENDED_COMPENSATION_UNIT_UNSPECIFIED", "HOURLY", @@ -1546,236 +1557,915 @@ "type": "object" }, "ExtendedCompensationInfoCompensationRange": { - "description": "Deprecated. See CompensationInfo.\n\nCompensation range.", + "description": "Deprecated. See CompensationInfo. Compensation range.", "id": "ExtendedCompensationInfoCompensationRange", "properties": { "max": { "$ref": "ExtendedCompensationInfoDecimal", "description": "Required. Maximum value." }, - "min": { - "$ref": "ExtendedCompensationInfoDecimal", - "description": "Required. Minimum value." + "min": { + "$ref": "ExtendedCompensationInfoDecimal", + "description": "Required. Minimum value." + } + }, + "type": "object" + }, + "ExtendedCompensationInfoDecimal": { + "description": "Deprecated. See CompensationInfo. Decimal number.", + "id": "ExtendedCompensationInfoDecimal", + "properties": { + "micros": { + "description": "Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "Whole units.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Filter": { + "description": "Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted.", + "id": "Filter", + "properties": { + "requisitionId": { + "description": "Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225.", + "type": "string" + } + }, + "type": "object" + }, + "GetHistogramRequest": { + "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method.", + "id": "GetHistogramRequest", + "properties": { + "allowBroadening": { + "description": "Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false.", + "type": "boolean" + }, + "filters": { + "$ref": "JobFilters", + "description": "Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram." + }, + "query": { + "$ref": "JobQuery", + "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." + }, + "requestMetadata": { + "$ref": "RequestMetadata", + "description": "Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist." + }, + "searchTypes": { + "description": "Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution.", + "items": { + "enum": [ + "JOB_FIELD_UNSPECIFIED", + "COMPANY_ID", + "EMPLOYMENT_TYPE", + "COMPANY_SIZE", + "DATE_PUBLISHED", + "CUSTOM_FIELD_1", + "CUSTOM_FIELD_2", + "CUSTOM_FIELD_3", + "CUSTOM_FIELD_4", + "CUSTOM_FIELD_5", + "CUSTOM_FIELD_6", + "CUSTOM_FIELD_7", + "CUSTOM_FIELD_8", + "CUSTOM_FIELD_9", + "CUSTOM_FIELD_10", + "CUSTOM_FIELD_11", + "CUSTOM_FIELD_12", + "CUSTOM_FIELD_13", + "CUSTOM_FIELD_14", + "CUSTOM_FIELD_15", + "CUSTOM_FIELD_16", + "CUSTOM_FIELD_17", + "CUSTOM_FIELD_18", + "CUSTOM_FIELD_19", + "CUSTOM_FIELD_20", + "EDUCATION_LEVEL", + "EXPERIENCE_LEVEL", + "ADMIN1", + "COUNTRY", + "CITY", + "LOCALE", + "LANGUAGE", + "CATEGORY", + "CITY_COORDINATE", + "ADMIN1_COUNTRY", + "COMPANY_TITLE", + "COMPANY_DISPLAY_NAME", + "BASE_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", + "Filter by custom field 1.", + "Filter by custom field 2.", + "Filter by custom field 3.", + "Filter by custom field 4.", + "Filter by custom field 5.", + "Filter by custom field 6.", + "Filter by custom field 7.", + "Filter by custom field 8.", + "Filter by custom field 9.", + "Filter by custom field 10.", + "Filter by custom field 11.", + "Filter by custom field 12.", + "Filter by custom field 13.", + "Filter by custom field 14.", + "Filter by custom field 15.", + "Filter by custom field 16.", + "Filter by custom field 17.", + "Filter by custom field 18.", + "Filter by custom field 19.", + "Filter by custom field 20.", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", + "Company display name.", + "Base compensation unit." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GetHistogramResponse": { + "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method.", + "id": "GetHistogramResponse", + "properties": { + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + }, + "results": { + "description": "The Histogram results.", + "items": { + "$ref": "HistogramResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchCreateJobsResponse": { + "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchCreateJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "GoogleCloudTalentV4JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchDeleteJobsResponse": { + "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchDeleteJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "GoogleCloudTalentV4JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchOperationMetadata": { + "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", + "id": "GoogleCloudTalentV4BatchOperationMetadata", + "properties": { + "createTime": { + "description": "The time when the batch operation is created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of failed item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of a long running operation.", + "enum": [ + "STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "SUCCEEDED", + "FAILED", + "CANCELLING", + "CANCELLED" + ], + "enumDescriptions": [ + "Default value.", + "The batch operation is being prepared for processing.", + "The batch operation is actively being processed.", + "The batch operation is processed, and at least one item has been successfully processed.", + "The batch operation is done and no item has been successfully processed.", + "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", + "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." + ], + "type": "string" + }, + "stateDescription": { + "description": "More detailed information about operation state.", + "type": "string" + }, + "successCount": { + "description": "Count of successful item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Count of total item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchUpdateJobsResponse": { + "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchUpdateJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "GoogleCloudTalentV4JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CompensationInfo": { + "description": "Job compensation details.", + "id": "GoogleCloudTalentV4CompensationInfo", + "properties": { + "annualizedBaseCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "annualizedTotalCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "entries": { + "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", + "items": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CompensationInfoCompensationEntry": { + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationEntry", + "properties": { + "amount": { + "$ref": "Money", + "description": "Compensation amount." + }, + "description": { + "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", + "type": "string" + }, + "expectedUnitsPerYear": { + "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Compensation range." + }, + "type": { + "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", + "enum": [ + "COMPENSATION_TYPE_UNSPECIFIED", + "BASE", + "BONUS", + "SIGNING_BONUS", + "EQUITY", + "PROFIT_SHARING", + "COMMISSIONS", + "TIPS", + "OTHER_COMPENSATION_TYPE" + ], + "enumDescriptions": [ + "Default value.", + "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.", + "Signing bonus.", + "Equity.", + "Profit sharing.", + "Commission.", + "Tips.", + "Other compensation type." + ], + "type": "string" + }, + "unit": { + "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "enum": [ + "COMPENSATION_UNIT_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY", + "ONE_TIME", + "OTHER_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CompensationInfoCompensationRange": { + "description": "Compensation range.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "properties": { + "maxCompensation": { + "$ref": "Money", + "description": "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 of min_compensation." + }, + "minCompensation": { + "$ref": "Money", + "description": "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 of max_compensation." + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CustomAttribute": { + "description": "Custom attribute values that are either filterable or non-filterable.", + "id": "GoogleCloudTalentV4CustomAttribute", + "properties": { + "filterable": { + "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", + "type": "boolean" + }, + "keywordSearchable": { + "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", + "type": "boolean" + }, + "longValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "stringValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4Job": { + "description": "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.", + "id": "GoogleCloudTalentV4Job", + "properties": { + "addresses": { + "description": "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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "applicationInfo": { + "$ref": "GoogleCloudTalentV4JobApplicationInfo", + "description": "Job application information." + }, + "company": { + "description": "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\".", + "type": "string" + }, + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "readOnly": true, + "type": "string" + }, + "compensationInfo": { + "$ref": "GoogleCloudTalentV4CompensationInfo", + "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." + }, + "customAttributes": { + "additionalProperties": { + "$ref": "GoogleCloudTalentV4CustomAttribute" + }, + "description": "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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", + "type": "object" + }, + "degreeTypes": { + "description": "The desired education degrees for the job, such as Bachelors, Masters.", + "items": { + "enum": [ + "DEGREE_TYPE_UNSPECIFIED", + "PRIMARY_EDUCATION", + "LOWER_SECONDARY_EDUCATION", + "UPPER_SECONDARY_EDUCATION", + "ADULT_REMEDIAL_EDUCATION", + "ASSOCIATES_OR_EQUIVALENT", + "BACHELORS_OR_EQUIVALENT", + "MASTERS_OR_EQUIVALENT", + "DOCTORAL_OR_EQUIVALENT" + ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "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", + "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; 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.", + "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.", + "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.", + "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; 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." + ], + "type": "string" + }, + "type": "array" + }, + "department": { + "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", + "type": "string" + }, + "derivedInfo": { + "$ref": "GoogleCloudTalentV4JobDerivedInfo", + "description": "Output only. Derived details about the job posting.", + "readOnly": true + }, + "description": { + "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, 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": "string" + }, + "employmentTypes": { + "description": "The employment type(s) of a job, for example, full time or part time.", + "items": { + "enum": [ + "EMPLOYMENT_TYPE_UNSPECIFIED", + "FULL_TIME", + "PART_TIME", + "CONTRACTOR", + "CONTRACT_TO_HIRE", + "TEMPORARY", + "INTERN", + "VOLUNTEER", + "PER_DIEM", + "FLY_IN_FLY_OUT", + "OTHER_EMPLOYMENT_TYPE" + ], + "enumDescriptions": [ + "The default value if the employment type isn't specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], + "type": "string" + }, + "type": "array" + }, + "incentives": { + "description": "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": "string" + }, + "jobBenefits": { + "description": "The benefits included with the job.", + "items": { + "enum": [ + "JOB_BENEFIT_UNSPECIFIED", + "CHILD_CARE", + "DENTAL", + "DOMESTIC_PARTNER", + "FLEXIBLE_HOURS", + "MEDICAL", + "LIFE_INSURANCE", + "PARENTAL_LEAVE", + "RETIREMENT_PLAN", + "SICK_DAYS", + "VACATION", + "VISION" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], + "type": "string" + }, + "type": "array" + }, + "jobEndTime": { + "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "jobLevel": { + "description": "The experience level associated with the job, such as \"Entry Level\".", + "enum": [ + "JOB_LEVEL_UNSPECIFIED", + "ENTRY_LEVEL", + "EXPERIENCED", + "MANAGER", + "DIRECTOR", + "EXECUTIVE" + ], + "enumDescriptions": [ + "The default value if the level isn't specified.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", + "Entry- to mid-level managers responsible for managing a team of people.", + "Senior-level managers responsible for managing teams of managers.", + "Executive-level managers and above, including C-level positions." + ], + "type": "string" + }, + "jobStartTime": { + "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "languageCode": { + "description": "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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", + "type": "string" + }, + "name": { + "description": "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\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", + "type": "string" + }, + "postingCreateTime": { + "description": "Output only. The timestamp when this job posting was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "postingExpireTime": { + "description": "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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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.", + "format": "google-datetime", + "type": "string" + }, + "postingPublishTime": { + "description": "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.", + "format": "google-datetime", + "type": "string" + }, + "postingRegion": { + "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", + "enum": [ + "POSTING_REGION_UNSPECIFIED", + "ADMINISTRATIVE_AREA", + "NATION", + "TELECOMMUTE" + ], + "enumDescriptions": [ + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if 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.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "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." + ], + "type": "string" + }, + "postingUpdateTime": { + "description": "Output only. The timestamp when this job posting was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "processingOptions": { + "$ref": "GoogleCloudTalentV4JobProcessingOptions", + "description": "Options for job processing." + }, + "promotionValue": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "qualifications": { + "description": "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 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": "string" + }, + "requisitionId": { + "description": "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, language_code and requisition_id. The maximum number of allowed characters is 255.", + "type": "string" + }, + "responsibilities": { + "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" + }, + "title": { + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", + "type": "string" + }, + "visibility": { + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "ACCOUNT_ONLY", + "SHARED_WITH_GOOGLE", + "SHARED_WITH_PUBLIC" + ], + "enumDescriptions": [ + "Default value.", + "The resource is only visible to the GCP account who owns it.", + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobApplicationInfo": { + "description": "Application related details of a job posting.", + "id": "GoogleCloudTalentV4JobApplicationInfo", + "properties": { + "emails": { + "description": "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "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": "string" + }, + "uris": { + "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobDerivedInfo": { + "description": "Derived details about the job posting.", + "id": "GoogleCloudTalentV4JobDerivedInfo", + "properties": { + "jobCategories": { + "description": "Job categories derived from Job.title and Job.description.", + "items": { + "enum": [ + "JOB_CATEGORY_UNSPECIFIED", + "ACCOUNTING_AND_FINANCE", + "ADMINISTRATIVE_AND_OFFICE", + "ADVERTISING_AND_MARKETING", + "ANIMAL_CARE", + "ART_FASHION_AND_DESIGN", + "BUSINESS_OPERATIONS", + "CLEANING_AND_FACILITIES", + "COMPUTER_AND_IT", + "CONSTRUCTION", + "CUSTOMER_SERVICE", + "EDUCATION", + "ENTERTAINMENT_AND_TRAVEL", + "FARMING_AND_OUTDOORS", + "HEALTHCARE", + "HUMAN_RESOURCES", + "INSTALLATION_MAINTENANCE_AND_REPAIR", + "LEGAL", + "MANAGEMENT", + "MANUFACTURING_AND_WAREHOUSE", + "MEDIA_COMMUNICATIONS_AND_WRITING", + "OIL_GAS_AND_MINING", + "PERSONAL_CARE_AND_SERVICES", + "PROTECTIVE_SERVICES", + "REAL_ESTATE", + "RESTAURANT_AND_HOSPITALITY", + "SALES_AND_RETAIL", + "SCIENCE_AND_ENGINEERING", + "SOCIAL_SERVICES_AND_NON_PROFIT", + "SPORTS_FITNESS_AND_RECREATION", + "TRANSPORTATION_AND_LOGISTICS" + ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], + "type": "string" + }, + "type": "array" + }, + "locations": { + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", + "items": { + "$ref": "GoogleCloudTalentV4Location" + }, + "type": "array" } }, "type": "object" }, - "ExtendedCompensationInfoDecimal": { - "description": "Deprecated. See CompensationInfo.\n\nDecimal number.", - "id": "ExtendedCompensationInfoDecimal", + "GoogleCloudTalentV4JobProcessingOptions": { + "description": "Options for job processing.", + "id": "GoogleCloudTalentV4JobProcessingOptions", "properties": { - "micros": { - "description": "Micro (10^-6) units.\nThe value must be between -999,999 and +999,999 inclusive.\nIf `units` is positive, `micros` must be positive or zero.\nIf `units` is zero, `micros` can be positive, zero, or negative.\nIf `units` is negative, `micros` must be negative or zero.\nFor example -1.75 is represented as `units`=-1 and `micros`=-750,000.", - "format": "int32", - "type": "integer" + "disableStreetAddressResolution": { + "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", + "type": "boolean" }, - "units": { - "description": "Whole units.", - "format": "int64", + "htmlSanitization": { + "description": "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.", + "enum": [ + "HTML_SANITIZATION_UNSPECIFIED", + "HTML_SANITIZATION_DISABLED", + "SIMPLE_FORMATTING_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables sanitization on HTML input.", + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." + ], "type": "string" } }, "type": "object" }, - "Filter": { - "description": "Deprecated. Use BatchDeleteJobsRequest instead.\n\nInput only.\n\nFilter for jobs to be deleted.", - "id": "Filter", + "GoogleCloudTalentV4JobResult": { + "description": "Mutation result of a job from a batch operation.", + "id": "GoogleCloudTalentV4JobResult", "properties": { - "requisitionId": { - "description": "Required. The requisition ID (or posting ID) assigned by the client to identify a\njob. This is intended for client identification and tracking of\nlistings.\nname takes precedence over this field\nThe maximum number of allowed characters is 225.", - "type": "string" + "job": { + "$ref": "GoogleCloudTalentV4Job", + "description": "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." + }, + "status": { + "$ref": "Status", + "description": "The status of the job processed. This field is populated if the processing of the job fails." } }, "type": "object" }, - "GetHistogramRequest": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make\na single call with both search and histogram.\n\nInput only.\n\nA request for the `GetHistogram` method.", - "id": "GetHistogramRequest", + "GoogleCloudTalentV4Location": { + "description": "A resource that represents a location with full geographic information.", + "id": "GoogleCloudTalentV4Location", "properties": { - "allowBroadening": { - "description": "Optional. Controls whether to broaden the search to avoid too few results for a\ngiven query in instances where a search has sparse results. Results from a\nbroadened query is a superset of the results from the original query.\n\nDefaults to false.", - "type": "boolean" - }, - "filters": { - "$ref": "JobFilters", - "description": "Deprecated. Use query instead.\n\nOptional.\n\nRestrictions on the scope of the histogram." - }, - "query": { - "$ref": "JobQuery", - "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." - }, - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Meta information, such as `user_id`, collected from the job searcher or\nother entity conducting a job search, is used to improve the service's\nsearch quality. Users determine identifier values, which must be\nunique and consist." + "latLng": { + "$ref": "LatLng", + "description": "An object representing a latitude/longitude pair." }, - "searchTypes": { - "description": "Required. A list of facets that specify the histogram data to be calculated\nagainst and returned.\n\nHistogram response times can be slow, and counts\ncan be approximations. This call may be temporarily or permanently removed\nprior to the production release of Cloud Talent Solution.", + "locationType": { + "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "COUNTRY", + "ADMINISTRATIVE_AREA", + "SUB_ADMINISTRATIVE_AREA", + "LOCALITY", + "POSTAL_CODE", + "SUB_LOCALITY", + "SUB_LOCALITY_1", + "SUB_LOCALITY_2", + "NEIGHBORHOOD", + "STREET_ADDRESS" + ], "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified\nwith TimeRange, for example, TimeRange.PAST_MONTH.", - "Filter by custom field 1.", - "Filter by custom field 2.", - "Filter by custom field 3.", - "Filter by custom field 4.", - "Filter by custom field 5.", - "Filter by custom field 6.", - "Filter by custom field 7.", - "Filter by custom field 8.", - "Filter by custom field 9.", - "Filter by custom field 10.", - "Filter by custom field 11.", - "Filter by custom field 12.", - "Filter by custom field 13.", - "Filter by custom field 14.", - "Filter by custom field 15.", - "Filter by custom field 16.", - "Filter by custom field 17.", - "Filter by custom field 18.", - "Filter by custom field 19.", - "Filter by custom field 20.", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead.\n\nCompany display name.", - "Company display name.", - "Base compensation unit." + "Default value if the type isn't specified.", + "A country level location.", + "A state or equivalent level location.", + "A county or equivalent level location.", + "A city or equivalent level location.", + "A postal code level location.", + "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.", + "A district or equivalent level location.", + "A smaller district or equivalent level display.", + "A neighborhood level location.", + "A street address level location." ], - "items": { - "enum": [ - "JOB_FIELD_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "CUSTOM_FIELD_1", - "CUSTOM_FIELD_2", - "CUSTOM_FIELD_3", - "CUSTOM_FIELD_4", - "CUSTOM_FIELD_5", - "CUSTOM_FIELD_6", - "CUSTOM_FIELD_7", - "CUSTOM_FIELD_8", - "CUSTOM_FIELD_9", - "CUSTOM_FIELD_10", - "CUSTOM_FIELD_11", - "CUSTOM_FIELD_12", - "CUSTOM_FIELD_13", - "CUSTOM_FIELD_14", - "CUSTOM_FIELD_15", - "CUSTOM_FIELD_16", - "CUSTOM_FIELD_17", - "CUSTOM_FIELD_18", - "CUSTOM_FIELD_19", - "CUSTOM_FIELD_20", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN1_COUNTRY", - "COMPANY_TITLE", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GetHistogramResponse": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make\na single call with both search and histogram.\n\nOutput only.\n\nThe response of the GetHistogram method.", - "id": "GetHistogramResponse", - "properties": { - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "type": "string" }, - "results": { - "description": "The Histogram results.", - "items": { - "$ref": "HistogramResult" - }, - "type": "array" + "postalAddress": { + "$ref": "PostalAddress", + "description": "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." + }, + "radiusMiles": { + "description": "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 covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", + "format": "double", + "type": "number" } }, "type": "object" }, "HistogramFacets": { - "description": "Input only.\n\nHistogram facets to be specified in SearchJobsRequest.", + "description": "Input only. Histogram facets to be specified in SearchJobsRequest.", "id": "HistogramFacets", "properties": { "compensationHistogramFacets": { - "description": "Optional. Specifies compensation field-based histogram requests.\nDuplicate values of CompensationHistogramRequest.type are not allowed.", + "description": "Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.", "items": { "$ref": "CompensationHistogramRequest" }, "type": "array" }, "customAttributeHistogramFacets": { - "description": "Optional. Specifies the custom attributes histogram requests.\nDuplicate values of CustomAttributeHistogramRequest.key are not\nallowed.", + "description": "Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.", "items": { "$ref": "CustomAttributeHistogramRequest" }, "type": "array" }, "simpleHistogramFacets": { - "description": "Optional. Specifies the simple type of histogram facets, for example,\n`COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to\nGetHistogramRequest.", - "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified\nwith TimeRange, for example, TimeRange.PAST_MONTH.", - "Filter by custom field 1.", - "Filter by custom field 2.", - "Filter by custom field 3.", - "Filter by custom field 4.", - "Filter by custom field 5.", - "Filter by custom field 6.", - "Filter by custom field 7.", - "Filter by custom field 8.", - "Filter by custom field 9.", - "Filter by custom field 10.", - "Filter by custom field 11.", - "Filter by custom field 12.", - "Filter by custom field 13.", - "Filter by custom field 14.", - "Filter by custom field 15.", - "Filter by custom field 16.", - "Filter by custom field 17.", - "Filter by custom field 18.", - "Filter by custom field 19.", - "Filter by custom field 20.", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead.\n\nCompany display name.", - "Company display name.", - "Base compensation unit." - ], + "description": "Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest.", "items": { "enum": [ "JOB_FIELD_UNSPECIFIED", @@ -1817,6 +2507,46 @@ "COMPANY_DISPLAY_NAME", "BASE_COMPENSATION_UNIT" ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", + "Filter by custom field 1.", + "Filter by custom field 2.", + "Filter by custom field 3.", + "Filter by custom field 4.", + "Filter by custom field 5.", + "Filter by custom field 6.", + "Filter by custom field 7.", + "Filter by custom field 8.", + "Filter by custom field 9.", + "Filter by custom field 10.", + "Filter by custom field 11.", + "Filter by custom field 12.", + "Filter by custom field 13.", + "Filter by custom field 14.", + "Filter by custom field 15.", + "Filter by custom field 16.", + "Filter by custom field 17.", + "Filter by custom field 18.", + "Filter by custom field 19.", + "Filter by custom field 20.", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", + "Company display name.", + "Base compensation unit." + ], "type": "string" }, "type": "array" @@ -1825,7 +2555,7 @@ "type": "object" }, "HistogramResult": { - "description": "Output only.\n\nResult of a histogram call. The response contains the histogram map for the\nsearch type specified by HistogramResult.field.\nThe response is a map of each filter value to the corresponding count of\njobs for that filter.", + "description": "Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.", "id": "HistogramResult", "properties": { "searchType": { @@ -1875,7 +2605,7 @@ "Filter by the company id field.", "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified\nwith TimeRange, for example, TimeRange.PAST_MONTH.", + "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", "Filter by custom field 1.", "Filter by custom field 2.", "Filter by custom field 3.", @@ -1898,15 +2628,15 @@ "Filter by custom field 20.", "Filter by the required education level of the job.", "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead.\n\nCompany display name.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", "Company display name.", "Base compensation unit." ], @@ -1917,32 +2647,32 @@ "format": "int32", "type": "integer" }, - "description": "A map from the values of field to the number of jobs with that value\nin this search result.\n\nKey: search type (filter names, such as the companyName).\n\nValues: the count of jobs that match the filter for this search.", + "description": "A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.", "type": "object" } }, "type": "object" }, "HistogramResults": { - "description": "Output only.\n\nHistogram results that matches HistogramFacets specified in\nSearchJobsRequest.", + "description": "Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest.", "id": "HistogramResults", "properties": { "compensationHistogramResults": { - "description": "Specifies compensation field-based histogram results that matches\nHistogramFacets.compensation_histogram_requests.", + "description": "Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests.", "items": { "$ref": "CompensationHistogramResult" }, "type": "array" }, "customAttributeHistogramResults": { - "description": "Specifies histogram results for custom attributes that\nmatches HistogramFacets.custom_attribute_histogram_facets.", + "description": "Specifies histogram results for custom attributes that matches HistogramFacets.custom_attribute_histogram_facets.", "items": { "$ref": "CustomAttributeHistogramResult" }, "type": "array" }, "simpleHistogramResults": { - "description": "Specifies histogram results that matches\nHistogramFacets.simple_histogram_facets.", + "description": "Specifies histogram results that matches HistogramFacets.simple_histogram_facets.", "items": { "$ref": "HistogramResult" }, @@ -1952,22 +2682,22 @@ "type": "object" }, "Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\"\nor \"job requisition\"). A job belongs to a Company, which is the hiring\nentity responsible for the job.", + "description": "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.", "id": "Job", "properties": { "applicationEmailList": { - "description": "Optional but at least one of application_urls,\napplication_email_list or application_instruction must be\nspecified.\n\nUse this field to specify email address(es) to which resumes or\napplications can be sent.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255.", "items": { "type": "string" }, "type": "array" }, "applicationInstruction": { - "description": "Optional but at least one of application_urls,\napplication_email_list or application_instruction must be\nspecified.\n\nUse this field to provide instructions, such as \"Mail your application\nto ...\", that a candidate can follow to apply for the job.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 3,000.", + "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. 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": "string" }, "applicationUrls": { - "description": "Optional but at least one of application_urls,\napplication_email_list or application_instruction must be\nspecified.\n\nUse this URL field to direct an applicant to a website, for example to\nlink to an online application form.\n\nThe maximum number of allowed characters is 2,000.", + "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000.", "items": { "type": "string" }, @@ -1975,21 +2705,6 @@ }, "benefits": { "description": "Optional. The benefits included with the job.", - "enumDescriptions": [ - "Default value if the type is not specified.", - "The job includes access to programs that support child care, such\nas daycare.", - "The job includes dental services that are covered by a dental\ninsurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services that are covered by a medical\ninsurance plan.", - "The job includes a life insurance plan provided by the employer or\navailable for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn\nchild.", - "The job includes a workplace retirement plan provided by the\nemployer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "Deprecated. Set Region.TELECOMMUTE instead.\n\nThe job allows telecommuting (working remotely).", - "The job includes paid time off for vacation.", - "The job includes vision services that are covered by a vision\ninsurance plan." - ], "items": { "enum": [ "JOB_BENEFIT_TYPE_UNSPECIFIED", @@ -2006,6 +2721,21 @@ "VACATION", "VISION" ], + "enumDescriptions": [ + "Default value if the type is not specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services that are covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services that are covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "Deprecated. Set Region.TELECOMMUTE instead. The job allows telecommuting (working remotely).", + "The job includes paid time off for vacation.", + "The job includes vision services that are covered by a vision insurance plan." + ], "type": "string" }, "type": "array" @@ -2015,11 +2745,11 @@ "type": "string" }, "companyName": { - "description": "Optional but one of company_name or distributor_company_id must be\nprovided.\n\nThe resource name of the company listing the job, such as\n/companies/foo. This field takes precedence over the\ndistributor-assigned company identifier, distributor_company_id.", + "description": "Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id.", "type": "string" }, "companyTitle": { - "description": "Deprecated. Use company_display_name instead.\n\nOutput only.\n\nThe name of the company listing the job.", + "description": "Deprecated. Use company_display_name instead. Output only. The name of the company listing the job.", "type": "string" }, "compensationInfo": { @@ -2035,32 +2765,23 @@ "additionalProperties": { "$ref": "CustomAttribute" }, - "description": "Optional. A map of fields to hold both filterable and non-filterable custom job\nattributes that are not covered by the provided structured fields.\n\nThis field is a more general combination of the deprecated id-based\nfilterable_custom_fields and string-based\nnon_filterable_custom_fields.\n\nThe keys of the map are strings up to 64 bytes and must match the\npattern: a-zA-Z*.\n\nAt most 100 filterable and at most 100 unfilterable keys are supported.\nFor filterable `string_values`, across all keys at most 200 values are\nallowed, with each string no more than 255 characters. For unfilterable\n`string_values`, the maximum total size of `string_values` across all keys\nis 50KB.", + "description": "Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", "type": "object" }, "department": { - "description": "Optional. The department or functional area within the company with the open\nposition.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", "type": "string" }, "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph\ndescription of the company and related information. Separate fields are\nprovided on the job object for responsibilities,\nqualifications, and other job characteristics. Use of\nthese separate job fields is recommended.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 100,000.", + "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, 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": "string" }, "distributorCompanyId": { - "description": "Optional but one of company_name or distributor_company_id must be\nprovided.\n\nA unique company identifier used by job distributors to identify an\nemployer's company entity. company_name takes precedence over\nthis field, and is the recommended field to use to identify companies.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255.", "type": "string" }, "educationLevels": { - "description": "Optional. The desired education level for the job, such as\n\"Bachelors\", \"Masters\", \"Doctorate\".", - "enumDescriptions": [ - "The default value if the level is not specified.", - "A High School diploma is required for the position.", - "An Associate degree is required for the position.", - "A Bachelors degree is required for the position.", - "A Masters degree is required for the position.", - "A Doctorate degree is required for the position.", - "No formal education is required for the position." - ], + "description": "Optional. The desired education level for the job, such as \"Bachelors\", \"Masters\", \"Doctorate\".", "items": { "enum": [ "EDUCATION_LEVEL_UNSPECIFIED", @@ -2071,25 +2792,21 @@ "DOCTORATE", "NO_DEGREE_REQUIRED" ], + "enumDescriptions": [ + "The default value if the level is not specified.", + "A High School diploma is required for the position.", + "An Associate degree is required for the position.", + "A Bachelors degree is required for the position.", + "A Masters degree is required for the position.", + "A Doctorate degree is required for the position.", + "No formal education is required for the position." + ], "type": "string" }, "type": "array" }, "employmentTypes": { - "description": "Optional. The employment type(s) of a job, for example,\nfull time or\npart time.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers\nto obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job is offered as a contracted position with the understanding\nthat it is converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "Optional. The employment type(s) of a job, for example, full time or part time.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -2104,36 +2821,49 @@ "FLY_IN_FLY_OUT", "OTHER" ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job is offered as a contracted position with the understanding that it is 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 jobs.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "endDate": { "$ref": "Date", - "description": "Optional. The end date of the job in UTC time zone. Typically this field\nis used for contracting engagements.\nDates prior to 1970/1/1 and invalid date formats are ignored." + "description": "Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored." }, "expireTime": { - "description": "Optional but strongly recommended for the best service\nexperience.\n\nThe expiration timestamp of the job. After this timestamp, the\njob is marked as expired, and it no longer appears in search results. The\nexpired job can't be deleted or listed by the DeleteJob and\nListJobs APIs, but it can be retrieved with the GetJob API or\nupdated with the UpdateJob API. An expired job can be updated and\nopened again by using a future expiration timestamp. Updating an expired\njob fails if there is another existing open job with same\nrequisition_id, company_name and language_code.\n\nThe expired jobs are retained in our system for 90 days. However, the\noverall expired job count cannot exceed 3 times the maximum of open jobs\ncount over the past week, otherwise jobs with earlier expire time are\ncleaned first. Expired jobs are no longer accessible after they are cleaned\nout.\nThe format of this field is RFC 3339 date strings. Example:\n2000-01-01T00:00:00.999999999Z\nSee\n[https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).\n\nA valid date range is between 1970-01-01T00:00:00.0Z and\n2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire\ntime not provided.\n\nIf this value is not provided at the time of job creation or is invalid,\nthe job posting expires after 30 days from the job's creation time. For\nexample, if the job was created on 2017/01/01 13:00AM UTC with an\nunspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.\n\nIf this value is not provided but expiry_date is, expiry_date is\nused.\n\nIf this value is not provided on job update, it depends on the field masks\nset by UpdateJobRequest.update_job_fields. If the field masks include\nexpiry_time, or the masks are empty meaning that every field is\nupdated, the job posting expires after 30 days from the job's last\nupdate time. Otherwise the expiration date isn't updated.", + "description": "Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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 requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not 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 is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_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.", "format": "google-datetime", "type": "string" }, "expiryDate": { "$ref": "Date", - "description": "Deprecated. Use expire_time instead.\n\nOptional but strongly recommended to be provided for the best service\nexperience.\n\nThe expiration date of the job in UTC time. After 12 am on this date, the\njob is marked as expired, and it no longer appears in search results.\nThe expired job can't be deleted or listed by the DeleteJob and\nListJobs APIs, but it can be retrieved with the GetJob API or\nupdated with the UpdateJob API. An expired job can be updated and\nopened again by using a future expiration date. It can also remain expired.\nUpdating an expired job to be open fails if there is another existing open\njob with same requisition_id, company_name and language_code.\n\nThe expired jobs are retained in our system for 90 days. However, the\noverall expired job count cannot exceed 3 times the maximum of open jobs\ncount over the past week, otherwise jobs with earlier expire time are\nremoved first. Expired jobs are no longer accessible after they are cleaned\nout.\n\nA valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are\nignored and treated as expiry date not provided.\n\nIf this value is not provided on job creation or is invalid, the job\nposting expires after 30 days from the job's creation time. For example, if\nthe job was created on 2017/01/01 13:00AM UTC with an unspecified\nexpiration date, the job expires after 2017/01/31 13:00AM UTC.\n\nIf this value is not provided on job update, it depends on the field masks\nset by UpdateJobRequest.update_job_fields. If the field masks include\nexpiry_date, or the masks are empty meaning that every field is\nupdated, the job expires after 30 days from the job's last update time.\nOtherwise the expiration date isn't updated." + "description": "Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated." }, "extendedCompensationInfo": { "$ref": "ExtendedCompensationInfo", - "description": "Deprecated. Always use compensation_info.\n\nOptional.\n\nJob compensation information.\n\nThis field replaces compensation_info. Only\nCompensationInfo.entries or extended_compensation_info can be set,\notherwise an exception is thrown." + "description": "Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown." }, "filterableCustomFields": { "additionalProperties": { "$ref": "CustomField" }, - "description": "Deprecated. Use custom_attributes instead.\n\nOptional.\n\nA map of fields to hold filterable custom job attributes not captured by\nthe standard fields such as job_title, company_name, or\nlevel. These custom fields store arbitrary\nstring values, and can be used for purposes not covered by\nthe structured fields. For the best search experience, use of the\nstructured rather than custom fields is recommended.\n\nData stored in these custom fields fields are indexed and\nsearched against by keyword searches (see\nSearchJobsRequest.custom_field_filters][]).\n\nThe map key must be a number between 1-20. If an invalid key is\nprovided on job create or update, an error is returned.", + "description": "Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned.", "type": "object" }, "incentives": { - "description": "Optional. A description of bonus, commission, and other compensation\nincentives associated with the job not including salary or pay.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. 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": "string" }, "jobLocations": { @@ -2144,11 +2874,11 @@ "type": "array" }, "jobTitle": { - "description": "Required. The title of the job, such as \"Software Engineer\"\n\nThe maximum number of allowed characters is 500.", + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", "type": "string" }, "languageCode": { - "description": "Optional. The language of the posting. This field is distinct from\nany requirements for fluency that are associated with the job.\n\nLanguage codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:\nclass=\"external\" target=\"_blank\" }.\n\nIf this field is unspecified and Job.description is present, detected\nlanguage code based on Job.description is assigned, otherwise\ndefaults to 'en_US'.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", "type": "string" }, "level": { @@ -2163,8 +2893,8 @@ ], "enumDescriptions": [ "The default value if the level is not specified.", - "Entry-level individual contributors, typically with less than 2 years of\nexperience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of\nexperience in a similar role.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", "Entry- to mid-level managers responsible for managing a team of people.", "Senior-level managers responsible for managing teams of managers.", "Executive-level managers and above, including C-level positions." @@ -2172,27 +2902,27 @@ "type": "string" }, "locations": { - "description": "Optional but strongly recommended for the best service experience.\n\nLocation(s) where the emploeyer is looking to hire for this job posting.\n\nSpecifying the full street address(es) of the hiring location enables\nbetter API results, especially job searches by commute time.\n\nAt most 50 locations are allowed for best search performance. If a job has\nmore locations, it is suggested to split it into multiple jobs with unique\nrequisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as\nmultiple jobs with the same requisition_id, company_name and\nlanguage_code are not allowed. If the original requisition_id must\nbe preserved, a custom field should be used for storage. It is also\nsuggested to group the locations that close to each other in the same job\nfor better search experience.\n\nThe maximum number of allowed characters is 500.", + "description": "Optional but strongly recommended for the best service experience. Location(s) where the emploeyer 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original 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.", "items": { "type": "string" }, "type": "array" }, "name": { - "description": "Required during job update.\n\nResource name assigned to a job by the API, for example, \"/jobs/foo\". Use\nof this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "Required during job update. Resource name assigned to a job by the API, for example, \"/jobs/foo\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "type": "string" }, "promotionValue": { - "description": "Optional. A promotion value of the job, as determined by the client.\nThe value determines the sort order of the jobs returned when searching for\njobs using the featured jobs search call, with higher promotional values\nbeing returned first and ties being resolved by relevance sort. Only the\njobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.\n\nDefault value is 0, and negative values are treated as 0.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "publishDate": { "$ref": "Date", - "description": "Optional. The date this job was most recently published in UTC format. The default\nvalue is the time the request arrives at the server." + "description": "Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server." }, "qualifications": { - "description": "Optional. A description of the qualifications required to perform the\njob. The use of this field is recommended\nas an alternative to using the more general description field.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. 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 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": "string" }, "referenceUrl": { @@ -2200,7 +2930,7 @@ "type": "string" }, "region": { - "description": "Optional. The job Region (for example, state, country) throughout which the job\nis available. If this field is set, a\nLocationFilter in a search query within the job region\nfinds this job if an exact location match is not specified.\nIf this field is set, setting job locations\nto the same location level as this field is strongly recommended.", + "description": "Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended.", "enum": [ "REGION_UNSPECIFIED", "STATE_WIDE", @@ -2208,30 +2938,30 @@ "TELECOMMUTE" ], "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it\nmatches the LocationFilter.", - "In additiona to exact location matching, job is returned when the\nLocationFilter in search query is in the same state as this job.\nFor example, if a `STATE_WIDE` job is posted in \"CA, USA\", it is\nreturned if LocationFilter has \"Mountain View\".", - "In addition to exact location matching, job is returned when\nLocationFilter in search query is in the same country as this job.\nFor example, if a `NATION_WIDE` job is posted in \"USA\", it is\nreturned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute).\nIf locations are provided with this value, the job is\nconsidered as having a location, but telecommuting is allowed." + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In additiona to exact location matching, job is returned when the LocationFilter in search query is in the same state as this job. For example, if a `STATE_WIDE` job is posted in \"CA, USA\", it is returned if LocationFilter has \"Mountain View\".", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it is returned if LocationFilter has 'Mountain View'.", + "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." ], "type": "string" }, "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, assigned by the\nclient to identify a job. This field is intended to be used by clients\nfor client identification and tracking of listings. A job is not allowed\nto be created if there is another job with the same requisition_id,\ncompany_name and language_code.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255.", "type": "string" }, "responsibilities": { - "description": "Optional. A description of job responsibilities. The use of this field is\nrecommended as an alternative to using the more general description\nfield.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" }, "startDate": { "$ref": "Date", - "description": "Optional. The start date of the job in UTC time zone. Typically this field\nis used for contracting engagements.\nDates prior to 1970/1/1 and invalid date formats are ignored." + "description": "Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored." }, "unindexedCustomFields": { "additionalProperties": { "$ref": "CustomField" }, - "description": "Deprecated. Use custom_attributes instead.\n\nOptional.\n\nA map of fields to hold non-filterable custom job attributes, similar to\nfilterable_custom_fields. These fields are distinct in that the data\nin these fields are not indexed. Therefore, the client cannot search\nagainst them, nor can the client use them to list jobs.\n\nThe key of the map can be any valid string.", + "description": "Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string.", "type": "object" }, "updateTime": { @@ -2240,7 +2970,7 @@ "type": "string" }, "visibility": { - "description": "Optional. The visibility of the job.\nDefaults to JobVisibility.PRIVATE if not specified.\nCurrently only JobVisibility.PRIVATE is supported.", + "description": "Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported.", "enum": [ "JOB_VISIBILITY_UNSPECIFIED", "PRIVATE", @@ -2250,8 +2980,8 @@ "enumDescriptions": [ "Default value.", "The Job is only visible to the owner.", - "The Job is visible to the owner and may be visible to other applications\nand processes at Google.\n\nNot yet supported. Use PRIVATE.", - "The Job is visible to the owner and may be visible to all other API\nclients.\n\nNot yet supported. Use PRIVATE." + "The Job is visible to the owner and may be visible to other applications and processes at Google. Not yet supported. Use PRIVATE.", + "The Job is visible to the owner and may be visible to all other API clients. Not yet supported. Use PRIVATE." ], "type": "string" } @@ -2259,44 +2989,11 @@ "type": "object" }, "JobFilters": { - "description": "Input only.\n\nDeprecated. Use JobQuery instead.\n\nThe filters required to perform a search query or histogram.", + "description": "Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram.", "id": "JobFilters", "properties": { "categories": { - "description": "Optional. The category filter specifies the categories of jobs to search against.\nSee Category for more information.\n\nIf a value is not specified, jobs from any category are searched against.\n\nIf multiple values are specified, jobs from any of the specified\ncategories are searched against.", - "enumDescriptions": [ - "The default value if the category is not specified.", - "An accounting and finance job, such as an Accountant.", - "And administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], + "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -2331,23 +3028,56 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category is not specified.", + "An accounting and finance job, such as an Accountant.", + "And administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "commuteFilter": { "$ref": "CommutePreference", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (e.g.\n driving or public transit). Note: this only works with COMMUTE\n MODE. When specified, [JobFilters.location_filters] will be\n ignored.\n\n Currently we do not support sorting by commute time." + "description": "Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time." }, "companyNames": { - "description": "Optional. The company names filter specifies the company entities to search\nagainst.\n\nIf a value is not specified, jobs are searched for against all companies.\n\nIf multiple values are specified, jobs are searched against the\nspecified companies.\n\nAt most 20 company filters are allowed.", + "description": "Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed.", "items": { "type": "string" }, "type": "array" }, "companyTitles": { - "description": "Optional. This filter specifies the exact company titles\nof jobs to search against.\n\nIf a value is not specified, jobs within the search results can be\nassociated with any company.\n\nIf multiple values are specified, jobs within the search results may be\nassociated with any of the specified companies.\n\nAt most 20 company title filters are allowed.", + "description": "Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be 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 title filters are allowed.", "items": { "type": "string" }, @@ -2355,38 +3085,25 @@ }, "compensationFilter": { "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to\nJob.compensation_info. For example, if the filter is specified\nas \"Hourly job with per-hour compensation > $15\", only jobs that meet\nthis criteria are searched. If a filter is not defined, all open jobs\nare searched." + "description": "Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched." }, "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the\nJob.custom_attributes that are marked as `filterable`.\n\nThe syntax for this expression is a subset of Google SQL syntax.\n\nSupported operators are: =, !=, <, <=, >, >= where the left of the operator\nis a custom field key and the right of the operator is a number or string\n(surrounded by quotes) value.\n\nSupported functions are LOWER() to\nperform case insensitive match and EMPTY() to filter on the\nexistence of a key.\n\nBoolean expressions (AND/OR/NOT) are supported up to 3 levels of\nnesting (For example, \"((A AND B AND C) OR NOT D) AND E\"), and there can\nbe a maximum of 100 comparisons/functions in the expression. The expression\nmust be < 3000 bytes in length.\n\nSample Query:\n(key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", + "description": "Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() 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\"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", "type": "string" }, "customFieldFilters": { "additionalProperties": { "$ref": "CustomFieldFilter" }, - "description": "Deprecated. Use custom_attribute_filter instead.\n\nOptional.\n\nThis filter specifies searching against\ncustom field values. See Job.filterable_custom_fields for information.\nThe key value specifies a number between 1-20 (the service\nsupports 20 custom fields) corresponding to the desired custom field map\nvalue. If an invalid key is provided or specified together with\ncustom_attribute_filter, an error is thrown.", + "description": "Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown.", "type": "object" }, "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the\nservice attempts to correct a misspelled query,\nfor example, \"enginee\" is corrected to \"engineer\".\n\nDefaults to false: a spell check is performed.", + "description": "Optional. 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": "boolean" }, "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to\nsearch against, such as EmploymentType.FULL_TIME.\n\nIf a value is not specified, jobs in the search results include any\nemployment type.\n\nIf multiple values are specified, jobs in the search results include any\nof the specified employment types.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers\nto obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job is offered as a contracted position with the understanding\nthat it is converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -2401,30 +3118,43 @@ "FLY_IN_FLY_OUT", "OTHER" ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job is offered as a contracted position with the understanding that it is 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 jobs.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "extendedCompensationFilter": { "$ref": "ExtendedCompensationFilter", - "description": "Deprecated. Always use compensation_filter.\n\nOptional.\n\nThis search filter is applied only to\nJob.extended_compensation_info. For example, if the filter is specified\nas \"Hourly job with per-hour compensation > $15\", only jobs that meet\nthese criteria are searched. If a filter is not defined, all open jobs\nare searched." + "description": "Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched." }, "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against,\nfor example, \"en-US\".\n\nIf a value is not specified, the search results may contain jobs in any\nlocale.\n\n\nLanguage codes should be in BCP-47 format, for example, \"en-US\" or\n\"sr-Latn\". For more information, see [Tags for Identifying\nLanguages](https://tools.ietf.org/html/bcp47).\n\nAt most 10 language code filters are allowed.", + "description": "Optional. This filter specifies the locale of jobs to search against, for example, \"en-US\". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", "items": { "type": "string" }, "type": "array" }, "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to\nsearch against. See LocationFilter for more information.\n\nIf a location value is not specified, jobs are retrieved\nfrom all locations.\n\nIf multiple values are specified, jobs are retrieved from any of the\nspecified locations. If different values are specified for the\nLocationFilter.distance_in_miles parameter, the maximum provided\ndistance is used for all locations.\n\nAt most 5 location filters are allowed.", + "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", "items": { "$ref": "LocationFilter" }, "type": "array" }, "publishDateRange": { - "description": "Optional. Jobs published within a range specified by this filter are searched\nagainst, for example, DateRange.PAST_MONTH. If a value is not\nspecified, all open jobs are searched against regardless of the\ndate they were published.", + "description": "Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published.", "enum": [ "DATE_RANGE_UNSPECIFIED", "PAST_24_HOURS", @@ -2444,18 +3174,18 @@ "type": "string" }, "query": { - "description": "Optional. The query filter contains the keywords that match against the job\ntitle, description, and location fields.\n\nThe maximum query size is 255 bytes/characters.", + "description": "Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters.", "type": "string" }, "tenantJobOnly": { - "description": "Deprecated. Do not use this field.\n\nThis flag controls whether the job search should be restricted to jobs\nowned by the current user.\n\nDefaults to false where all jobs accessible to the\nuser are searched against.", + "description": "Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against.", "type": "boolean" } }, "type": "object" }, "JobLocation": { - "description": "Output only.\n\nA resource that represents a location with full geographic\ninformation.", + "description": "Output only. A resource that represents a location with full geographic information.", "id": "JobLocation", "properties": { "latLng": { @@ -2463,7 +3193,7 @@ "description": "An object representing a latitude/longitude pair." }, "locationType": { - "description": "The type of a location, which corresponds to the address lines field of\nPostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of\nLocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of\nLocationType#LOCALITY.", + "description": "The type of a location, which corresponds to the address lines field of PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType#LOCALITY.", "enum": [ "LOCATION_TYPE_UNSPECIFIED", "COUNTRY", @@ -2484,7 +3214,7 @@ "A county or equivalent level location.", "A city or equivalent level location.", "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough,\nward, or arrondissement. Sublocalities are usually recognized by a local\npolitical authority. For example, Manhattan and Brooklyn are recognized\nas boroughs by the City of New York, and are therefore modeled as\nsublocalities.", + "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.", "A district or equivalent level location.", "A smaller district or equivalent level display.", "A neighborhood level location.", @@ -2494,10 +3224,10 @@ }, "postalAddress": { "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information,\nsuch as postal delivery and payments addresses. Given a postal address,\na postal service can deliver items to a premises, P.O. Box, or other\ndelivery location." + "description": "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." }, "radiusMeters": { - "description": "Radius in meters of the job location. This value is derived from the\nlocation bounding box in which a circle with the specified radius\ncentered from LatLng coves the area associated with the job location.\nFor example, currently, \"Mountain View, CA, USA\" has a radius of\n7885.79 meters.", + "description": "Radius in meters of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng coves the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 7885.79 meters.", "format": "double", "type": "number" } @@ -2505,15 +3235,15 @@ "type": "object" }, "JobProcessingOptions": { - "description": "Input only.\n\nOptions for job processing.", + "description": "Input only. Options for job processing.", "id": "JobProcessingOptions", "properties": { "disableStreetAddressResolution": { - "description": "Optional. If set to `true`, the service does not attempt to resolve a\nmore precise address for the job.", + "description": "Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", "type": "boolean" }, "htmlSanitization": { - "description": "Optional. Option for job HTML content sanitization. Applied fields are:\n\n* description\n* applicationInstruction\n* incentives\n* qualifications\n* responsibilities\n\nHTML tags in these fields may be stripped if sanitiazation is not disabled.\n\nDefaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", + "description": "Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", "enum": [ "HTML_SANITIZATION_UNSPECIFIED", "HTML_SANITIZATION_DISABLED", @@ -2522,7 +3252,7 @@ "enumDescriptions": [ "Default value.", "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and\nunordered list markup tags." + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." ], "type": "string" } @@ -2530,44 +3260,11 @@ "type": "object" }, "JobQuery": { - "description": "Input only.\n\nThe query required to perform a search query or histogram.", + "description": "Input only. The query required to perform a search query or histogram.", "id": "JobQuery", "properties": { "categories": { - "description": "Optional. The category filter specifies the categories of jobs to search against.\nSee Category for more information.\n\nIf a value is not specified, jobs from any category are searched against.\n\nIf multiple values are specified, jobs from any of the specified\ncategories are searched against.", - "enumDescriptions": [ - "The default value if the category is not specified.", - "An accounting and finance job, such as an Accountant.", - "And administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], + "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -2602,23 +3299,56 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category is not specified.", + "An accounting and finance job, such as an Accountant.", + "And administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "commuteFilter": { "$ref": "CommutePreference", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (for\n example, driving or public transit). Note: This only works with COMMUTE\n MODE. When specified, [JobQuery.location_filters] is\n ignored.\n\n Currently we don't support sorting by commute time." + "description": "Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time." }, "companyDisplayNames": { - "description": "Optional. This filter specifies the exact company display\nname of the jobs to search against.\n\nIf a value isn't specified, jobs within the search results are\nassociated with any company.\n\nIf multiple values are specified, jobs within the search results may be\nassociated with any of the specified companies.\n\nAt most 20 company display name filters are allowed.", + "description": "Optional. This filter specifies the exact company display name of the jobs to search against. 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.", "items": { "type": "string" }, "type": "array" }, "companyNames": { - "description": "Optional. This filter specifies the company entities to search against.\n\nIf a value isn't specified, jobs are searched for against all\ncompanies.\n\nIf multiple values are specified, jobs are searched against the\ncompanies specified.\n\nAt most 20 company filters are allowed.", + "description": "Optional. 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. At most 20 company filters are allowed.", "items": { "type": "string" }, @@ -2626,31 +3356,18 @@ }, "compensationFilter": { "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to\nJob.compensation_info. For example, if the filter is specified\nas \"Hourly job with per-hour compensation > $15\", only jobs meeting\nthese criteria are searched. If a filter isn't defined, all open jobs\nare searched." + "description": "Optional. This search filter is applied only to 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." }, "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the\nJob.custom_attributes marked as `filterable`.\n\nThe syntax for this expression is a subset of Google SQL syntax.\n\nSupported operators are: =, !=, <, <=, >, >= where the left of the operator\nis a custom field key and the right of the operator is a number or string\n(surrounded by quotes) value.\n\nSupported functions are LOWER() to\nperform case insensitive match and EMPTY() to filter on the\nexistence of a key.\n\nBoolean expressions (AND/OR/NOT) are supported up to 3 levels of\nnesting (for example, \"((A AND B AND C) OR NOT D) AND E\"), a maximum of 50\ncomparisons/functions are allowed in the expression. The expression\nmust be < 2000 characters in length.\n\nSample Query:\n(key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", + "description": "Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() 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 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", "type": "string" }, "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the\nservice attempts to correct a misspelled query,\nfor example, \"enginee\" is corrected to \"engineer\".\n\nDefaults to false: a spell check is performed.", + "description": "Optional. 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": "boolean" }, "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to\nsearch against, such as EmploymentType.FULL_TIME.\n\nIf a value is not specified, jobs in the search results include any\nemployment type.\n\nIf multiple values are specified, jobs in the search results include\nany of the specified employment types.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers\nto obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job is offered as a contracted position with the understanding\nthat it is converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -2665,26 +3382,39 @@ "FLY_IN_FLY_OUT", "OTHER" ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job is offered as a contracted position with the understanding that it is 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 jobs.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against,\nfor example, \"en-US\".\n\nIf a value isn't specified, the search results can contain jobs in any\nlocale.\n\n\nLanguage codes should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nAt most 10 language code filters are allowed.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", "items": { "type": "string" }, "type": "array" }, "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to\nsearch against. See LocationFilter for more information.\n\nIf a location value isn't specified, jobs fitting the other search\ncriteria are retrieved regardless of where they're located.\n\nIf multiple values are specified, jobs are retrieved from any of the\nspecified locations. If different values are specified for the\nLocationFilter.distance_in_miles parameter, the maximum provided\ndistance is used for all locations.\n\nAt most 5 location filters are allowed.", + "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", "items": { "$ref": "LocationFilter" }, "type": "array" }, "publishDateRange": { - "description": "Optional. Jobs published within a range specified by this filter are searched\nagainst, for example, DateRange.PAST_MONTH. If a value isn't\nspecified, all open jobs are searched against regardless of their\npublished date.", + "description": "Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date.", "enum": [ "DATE_RANGE_UNSPECIFIED", "PAST_24_HOURS", @@ -2704,14 +3434,14 @@ "type": "string" }, "query": { - "description": "Optional. The query string that matches against the job title, description, and\nlocation fields.\n\nThe maximum query size is 255 bytes.", + "description": "Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes.", "type": "string" } }, "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -2728,7 +3458,7 @@ "type": "object" }, "ListCompaniesResponse": { - "description": "Output only.\n\nThe List companies response object.", + "description": "Output only. The List companies response object.", "id": "ListCompaniesResponse", "properties": { "companies": { @@ -2740,7 +3470,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2750,11 +3480,11 @@ "type": "object" }, "ListCompanyJobsResponse": { - "description": "Deprecated. Use ListJobsResponse instead.\n\nOutput only.\n\nThe List jobs response object.", + "description": "Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object.", "id": "ListCompanyJobsResponse", "properties": { "jobs": { - "description": "The Jobs for a given company.\n\nThe maximum number of items returned is based on the limit field\nprovided in the request.", + "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", "items": { "$ref": "Job" }, @@ -2762,14 +3492,14 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "totalSize": { - "description": "The total number of open jobs. The result will be\nempty if ListCompanyJobsRequest.include_jobs_count is not enabled\nor if no open jobs are available.", + "description": "The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available.", "format": "int64", "type": "string" } @@ -2777,11 +3507,11 @@ "type": "object" }, "ListJobsResponse": { - "description": "Output only.\n\nList jobs response.", + "description": "Output only. List jobs response.", "id": "ListJobsResponse", "properties": { "jobs": { - "description": "The Jobs for a given company.\n\nThe maximum number of items returned is based on the limit field\nprovided in the request.", + "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", "items": { "$ref": "Job" }, @@ -2789,7 +3519,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2799,69 +3529,69 @@ "type": "object" }, "LocationFilter": { - "description": "Input only.\n\nGeographic region of the search.", + "description": "Input only. Geographic region of the search.", "id": "LocationFilter", "properties": { "distanceInMiles": { - "description": "Optional. The distance_in_miles is applied when the location being searched for is\nidentified as a city or smaller. When the location being searched for is a\nstate or larger, this field is ignored.", + "description": "Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.", "format": "double", "type": "number" }, "isTelecommute": { - "description": "Optional. Allows the client to return jobs without a\nset location, specifically, telecommuting jobs (telecomuting is considered\nby the service as a special location.\nJob.allow_telecommute indicates if a job permits telecommuting.\nIf this field is true, telecommuting jobs are searched, and\nname and lat_lng are\nignored.\nThis filter can be used by itself to search exclusively for telecommuting\njobs, or it can be combined with another location\nfilter to search for a combination of job locations,\nsuch as \"Mountain View\" or \"telecommuting\" jobs. However, when used in\ncombination with other location filters, telecommuting jobs can be\ntreated as less relevant than other jobs in the search response.", + "description": "Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. 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.", "type": "boolean" }, "latLng": { "$ref": "LatLng", - "description": "Optional. The latitude and longitude of the geographic center from which to\nsearch. This field is ignored if `location_name` is provided." + "description": "Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided." }, "name": { "description": "Optional. The address name, such as \"Mountain View\" or \"Bay Area\".", "type": "string" }, "regionCode": { - "description": "Optional. CLDR region code of the country/region of the address. This will be used\nto address ambiguity of the user-input location, e.g. \"Liverpool\"\nagainst \"Liverpool, NY, US\" or \"Liverpool, UK\".\n\nSet this field if all the jobs to search against are from a same region,\nor jobs are world-wide but the job seeker is from a specific region.\n\nSee http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. \"Liverpool\" against \"Liverpool, NY, US\" or \"Liverpool, UK\". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" } }, "type": "object" }, "MatchingJob": { - "description": "Output only.\n\nJob entry with metadata inside SearchJobsResponse.", + "description": "Output only. Job entry with metadata inside SearchJobsResponse.", "id": "MatchingJob", "properties": { "commuteInfo": { "$ref": "CommuteInfo", - "description": "Commute information which is generated based on specified\n CommutePreference." + "description": "Commute information which is generated based on specified CommutePreference." }, "job": { "$ref": "Job", "description": "Job resource that matches the specified SearchJobsRequest." }, "jobSummary": { - "description": "A summary of the job with core information that's displayed on the search\nresults listing page.", + "description": "A summary of the job with core information that's displayed on the search results listing page.", "type": "string" }, "jobTitleSnippet": { - "description": "Contains snippets of text from the Job.job_title field most\nclosely matching a search query's keywords, if available. The matching\nquery keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.", "type": "string" }, "searchTextSnippet": { - "description": "Contains snippets of text from the Job.description and similar\nfields that most closely match a search query's keywords, if available.\nAll HTML tags in the original fields are stripped when returned in this\nfield, and matching query keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the 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": "string" } }, "type": "object" }, "MendelDebugInput": { - "description": "Message representing input to a Mendel server for debug forcing.\nSee go/mendel-debug-forcing for more details.\nNext ID: 2", + "description": "Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2", "id": "MendelDebugInput", "properties": { "namespacedDebugInput": { "additionalProperties": { "$ref": "NamespacedDebugInput" }, - "description": "When a request spans multiple servers, a MendelDebugInput may travel with\nthe request and take effect in all the servers. This field is a map of\nnamespaces to NamespacedMendelDebugInput protos. In a single server, up to\ntwo NamespacedMendelDebugInput protos are applied:\n1. NamespacedMendelDebugInput with the global namespace (key == \"\").\n2. NamespacedMendelDebugInput with the server's namespace.\nWhen both NamespacedMendelDebugInput protos are present, they are merged.\nSee go/mendel-debug-forcing for more details.", + "description": "When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == \"\"). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.", "type": "object" } }, @@ -2876,12 +3606,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } @@ -2893,21 +3623,21 @@ "id": "NamespacedDebugInput", "properties": { "absolutelyForcedExpNames": { - "description": "Set of experiment names to be absolutely forced.\nThese experiments will be forced without evaluating the conditions.", + "description": "Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExpTags": { - "description": "Set of experiment tags to be absolutely forced.\nThe experiments with these tags will be forced without evaluating the\nconditions.", + "description": "Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExps": { - "description": "Set of experiment ids to be absolutely forced.\nThese ids will be forced without evaluating the conditions.", + "description": "Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.", "items": { "format": "int32", "type": "integer" @@ -2915,21 +3645,21 @@ "type": "array" }, "conditionallyForcedExpNames": { - "description": "Set of experiment names to be conditionally forced.\nThese experiments will be forced only if their conditions and their\nparent domain's conditions are true.", + "description": "Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExpTags": { - "description": "Set of experiment tags to be conditionally forced.\nThe experiments with these tags will be forced only if their conditions\nand their parent domain's conditions are true.", + "description": "Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExps": { - "description": "Set of experiment ids to be conditionally forced.\nThese ids will be forced only if their conditions and their parent\ndomain's conditions are true.", + "description": "Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.", "items": { "format": "int32", "type": "integer" @@ -2937,25 +3667,25 @@ "type": "array" }, "disableAutomaticEnrollmentSelection": { - "description": "If true, disable automatic enrollment selection (at all diversion\npoints). Automatic enrollment selection means experiment selection\nprocess based on the experiment's automatic enrollment condition. This\ndoes not disable selection of forced experiments.", + "description": "If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.", "type": "boolean" }, "disableExpNames": { - "description": "Set of experiment names to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If a name corresponds to a domain, the domain\nitself and all descendant experiments and domains are disabled together.", + "description": "Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExpTags": { - "description": "Set of experiment tags to be disabled. All experiments that are tagged\nwith one or more of these tags are disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together.", + "description": "Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExps": { - "description": "Set of experiment ids to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If an ID corresponds to a domain, the domain itself\nand all descendant experiments and domains are disabled together.", + "description": "Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "format": "int32", "type": "integer" @@ -2963,36 +3693,36 @@ "type": "array" }, "disableManualEnrollmentSelection": { - "description": "If true, disable manual enrollment selection (at all diversion points).\nManual enrollment selection means experiment selection process based on\nthe request's manual enrollment states (a.k.a. opt-in experiments).\nThis does not disable selection of forced experiments.", + "description": "If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.", "type": "boolean" }, "disableOrganicSelection": { - "description": "If true, disable organic experiment selection (at all diversion points).\nOrganic selection means experiment selection process based on traffic\nallocation and diversion condition evaluation.\nThis does not disable selection of forced experiments.\n\nThis is useful in cases when it is not known whether experiment selection\nbehavior is responsible for a error or breakage. Disabling organic\nselection may help to isolate the cause of a given problem.", + "description": "If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.", "type": "boolean" }, "forcedFlags": { "additionalProperties": { "type": "string" }, - "description": "Flags to force in a particular experiment state.\nMap from flag name to flag value.", + "description": "Flags to force in a particular experiment state. Map from flag name to flag value.", "type": "object" }, "forcedRollouts": { "additionalProperties": { "type": "boolean" }, - "description": "Rollouts to force in a particular experiment state.\nMap from rollout name to rollout value.", + "description": "Rollouts to force in a particular experiment state. Map from rollout name to rollout value.", "type": "object" } }, "type": "object" }, "NumericBucketingOption": { - "description": "Input only.\n\nUse this field to specify bucketing option for the histogram search response.", + "description": "Input only. Use this field to specify bucketing option for the histogram search response.", "id": "NumericBucketingOption", "properties": { "bucketBounds": { - "description": "Required. Two adjacent values form a histogram bucket. Values should be in\nascending order. For example, if [5, 10, 15] are provided, four buckets are\ncreated: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20\n[buckets_bound is supported.", + "description": "Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported.", "items": { "format": "double", "type": "number" @@ -3000,30 +3730,30 @@ "type": "array" }, "requiresMinMax": { - "description": "Optional. If set to true, the histogram result includes minimum/maximum\nvalue of the numeric field.", + "description": "Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.", "type": "boolean" } }, "type": "object" }, "NumericBucketingResult": { - "description": "Output only.\n\nCustom numeric bucketing result.", + "description": "Output only. Custom numeric bucketing result.", "id": "NumericBucketingResult", "properties": { "counts": { - "description": "Count within each bucket. Its size is the length of\nNumericBucketingOption.bucket_bounds plus 1.", + "description": "Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.", "items": { "$ref": "BucketizedCount" }, "type": "array" }, "maxValue": { - "description": "Stores the maximum value of the numeric field. Will be populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" }, "minValue": { - "description": "Stores the minimum value of the numeric field. Will be populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" } @@ -3031,26 +3761,26 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses.\nGiven a postal address, a postal service can deliver items to a premise, P.O.\nBox or similar.\nIt is not intended to model geographical locations (roads, towns,\nmountains).\n\nIn typical usage an address would be created via user input or from importing\nexisting data, depending on the type of process.\n\nAdvice on address input / editing:\n - Use an i18n-ready address widget such as\n https://github.com/google/libaddressinput)\n- Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\nFor more guidance on how to use this schema, please see:\nhttps://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address.\n\nBecause values in address_lines do not have type information and may\nsometimes contain multiple values in a single field (e.g.\n\"Austin, TX\"), it is important that the line order is clear. The order of\naddress lines should be \"envelope order\" for the country/region of the\naddress. In places where this can vary (e.g. Japan), address_language is\nused to make it explicit (e.g. \"ja\" for large-to-small ordering and\n\"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\nan address can be selected based on the language.\n\nThe minimum permitted structural representation of an address consists\nof a region_code with all remaining information placed in the\naddress_lines. It would be possible to format such an address very\napproximately without geocoding, but no semantic reasoning could be\nmade about any of the address components until it was at least\npartially resolved.\n\nCreating an address only containing a region_code and address_lines, and\nthen geocoding is the recommended way to handle completely unstructured\naddresses (as opposed to guessing which parts of the address should be\nlocalities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal\naddresses of a country or region.\nFor example, this can be a state, a province, an oblast, or a prefecture.\nSpecifically, for Spain this is the province and not the autonomous\ncommunity (e.g. \"Barcelona\" and not \"Catalonia\").\nMany countries don't use an administrative area in postal addresses. E.g.\nin Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", "type": "string" }, "languageCode": { - "description": "Optional. BCP-47 language code of the contents of this address (if\nknown). This is often the UI language of the input form or is expected\nto match one of the languages used in the address' country/region, or their\ntransliterated equivalents.\nThis can affect formatting in certain countries, but is not critical\nto the correctness of the data and will never affect any validation or\nother non-formatting related operations.\n\nIf this value is not known, it should be omitted (rather than specifying a\npossibly incorrect default).\n\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address.\nExamples: US city, IT comune, UK post town.\nIn regions of the world where localities are not well defined or do not fit\ninto this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", "type": "string" }, "organization": { @@ -3058,65 +3788,65 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require\npostal codes to be present, but where they are used, they may trigger\nadditional validation with other parts of the address (e.g. state/zip\nvalidation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", "type": "string" }, "recipients": { - "description": "Optional. The recipient at the address.\nThis field may, under certain circumstances, contain multiline information.\nFor example, it might contain \"care of\" information.", + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", "items": { "type": "string" }, "type": "array" }, "regionCode": { - "description": "Required. CLDR region code of the country/region of the address. This\nis never inferred and it is up to the user to ensure the value is\ncorrect. See http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "revision": { - "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is\nthe latest revision.\n\nAll new revisions **must** be backward compatible with old revisions.", + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", "format": "int32", "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used\nin most regions. Where it is used, the value is either a string like\n\"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\nalone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n(Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address.\nFor example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", "type": "string" } }, "type": "object" }, "RequestMetadata": { - "description": "Input only.\n\nMeta information related to the job searcher or entity\nconducting the job search. This information is used to improve the\nperformance of the service.", + "description": "Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.", "id": "RequestMetadata", "properties": { "deviceInfo": { "$ref": "DeviceInfo", - "description": "Optional. The type of device used by the job seeker at the time of the call to the\nservice." + "description": "Optional. The type of device used by the job seeker at the time of the call to the service." }, "domain": { - "description": "Required. The client-defined scope or source of the service call, which typically\nis the domain on\nwhich the service has been implemented and is currently being run.\n\nFor example, if the service is being run by client Foo, Inc., on\njob board www.foo.com and career site www.bar.com, then this field is\nset to \"foo.com\" for use on the job board, and \"bar.com\" for use on the\ncareer site.\n\nIf this field is not available for some reason, send \"UNKNOWN\". Note that\nany improvements to the service model for a particular tenant site rely on\nthis field being set correctly to some domain.", + "description": "Required. 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. If this field is not available for some reason, send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain.", "type": "string" }, "sessionId": { - "description": "Required. A unique session identification string. A session is defined as the\nduration of an end user's interaction with the service over a period.\nObfuscate this field for privacy concerns before\nproviding it to the API.\n\nIf this field is not available for some reason, please send \"UNKNOWN\". Note\nthat any improvements to the service model for a particular tenant site,\nrely on this field being set correctly to some unique session_id.", + "description": "Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id.", "type": "string" }, "userId": { - "description": "Required. A unique user identification string, as determined by the client. The\nclient is responsible for ensuring client-level uniqueness of this value\nin order to have the strongest positive impact on search quality.\nObfuscate this field for privacy concerns before\nproviding it to the service.\n\nIf this field is not available for some reason, please send \"UNKNOWN\". Note\nthat any improvements to the service model for a particular tenant site,\nrely on this field being set correctly to some unique user_id.", + "description": "Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id.", "type": "string" } }, "type": "object" }, "ResponseMetadata": { - "description": "Output only.\n\nAdditional information returned to client, such as debugging\ninformation.", + "description": "Output only. Additional information returned to client, such as debugging information.", "id": "ResponseMetadata", "properties": { "experimentIdList": { - "description": "Identifiers for the versions of the search algorithm used during\nthis API invocation if multiple algorithms are used.\nThe default value is empty.\nFor search response only.", + "description": "Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only.", "items": { "format": "int32", "type": "integer" @@ -3134,44 +3864,44 @@ "enumDescriptions": [ "The mode of the search method isn't specified.", "The job search doesn't include support for featured jobs.", - "The job search matches only against featured jobs (jobs with a\npromotionValue > 0). This method doesn't return any jobs having a\npromotionValue <= 0. The search results order is determined by the\npromotionValue (jobs with a higher promotionValue are returned higher up in\nthe search results), with relevance being used as a tiebreaker.", - "Deprecated. Please use the SearchJobsForAlert API.\n\nThe job search matches against jobs suited to email notifications." + "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.", + "Deprecated. Please use the SearchJobsForAlert API. The job search matches against jobs suited to email notifications." ], "type": "string" }, "requestId": { - "description": "A unique id associated with this call.\nThis id is logged for tracking purposes.", + "description": "A unique id associated with this call. This id is logged for tracking purposes.", "type": "string" } }, "type": "object" }, "SearchJobsRequest": { - "description": "Input only.\n\nThe Request body of the `SearchJobs` call.", + "description": "Input only. The Request body of the `SearchJobs` call.", "id": "SearchJobsRequest", "properties": { "disableRelevanceThresholding": { - "description": "Optional. Controls whether to disable relevance thresholding. Relevance\nthresholding removes jobs that have low relevance in search results,\nfor example, removing \"Assistant to the CEO\" positions from the search\nresults of a search for \"CEO\".\n\nDisabling relevance thresholding improves the accuracy of subsequent\nsearch requests.\n\nDefaults to false.", + "description": "Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing \"Assistant to the CEO\" positions from the search results of a search for \"CEO\". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false.", "type": "boolean" }, "enableBroadening": { - "description": "Optional. Controls whether to broaden the search when it produces sparse results.\nBroadened queries append results to the end of the matching results\nlist.\n\nDefaults to false.", + "description": "Optional. 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": "boolean" }, "enablePreciseResultSize": { - "description": "Optional. Controls if the search job request requires the return of a precise\ncount of the first 300 results. Setting this to `true` ensures\nconsistency in the number of results per page. Best practice is to set this\nvalue to true if a client allows users to jump directly to a\nnon-sequential search results page.\n\nEnabling this flag may adversely impact performance.\n\nDefaults to false.", + "description": "Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false.", "type": "boolean" }, "filters": { "$ref": "JobFilters", - "description": "Deprecated. Use query instead.\n\nOptional.\n\nRestrictions on the scope of the search request, such as filtering\nby location." + "description": "Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location." }, "histogramFacets": { "$ref": "HistogramFacets", - "description": "Optional. Restrictions on what fields to perform histogram on, such as\n`COMPANY_SIZE` etc." + "description": "Optional. Restrictions on what fields to perform histogram on, such as `COMPANY_SIZE` etc." }, "jobView": { - "description": "Optional. The number of job attributes returned for jobs in the\nsearch response. Defaults to JobView.SMALL if no value is specified.", + "description": "Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified.", "enum": [ "JOB_VIEW_UNSPECIFIED", "SMALL", @@ -3180,9 +3910,9 @@ ], "enumDescriptions": [ "Default value.", - "A small view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.job_title,\nJob.company_name, Job.job_locations, Job.description,\nJob.visibility.\nNote: Job.description is deprecated. It is scheduled to be removed\nfrom MatchingJob.Job objects in the SearchJobsResponse results\non 12/31/2018.", - "A minimal view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.job_title,\nJob.company_name, Job.job_locations.", - "All available attributes are included in the search results.\nNote: [Job.description, Job.responsibilities,\nJob.qualifications and Job.incentives are deprecated.\nThese fields are scheduled to be removed from MatchingJob.Job objects\nin the SearchJobsResponse results on 12/31/2018.\nSee the alternative MatchingJob.search_text_snippet and\nMatchingJob.job_summary fields." + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations, Job.description, Job.visibility. Note: Job.description is deprecated. It is scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018.", + "A minimal view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations.", + "All available attributes are included in the search results. Note: [Job.description, Job.responsibilities, Job.qualifications and Job.incentives are deprecated. These fields are scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018. See the alternative MatchingJob.search_text_snippet and MatchingJob.job_summary fields." ], "type": "string" }, @@ -3197,18 +3927,18 @@ "enumDescriptions": [ "The mode of the search method isn't specified.", "The job search doesn't include support for featured jobs.", - "The job search matches only against featured jobs (jobs with a\npromotionValue > 0). This method doesn't return any jobs having a\npromotionValue <= 0. The search results order is determined by the\npromotionValue (jobs with a higher promotionValue are returned higher up in\nthe search results), with relevance being used as a tiebreaker.", - "Deprecated. Please use the SearchJobsForAlert API.\n\nThe job search matches against jobs suited to email notifications." + "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.", + "Deprecated. Please use the SearchJobsForAlert API. The job search matches against jobs suited to email notifications." ], "type": "string" }, "offset": { - "description": "Optional. An integer that specifies the current offset (that is, starting result\nlocation, amongst the jobs deemed by the API as relevant) in search\nresults. This field is only considered if page_token is unset.\n\nFor example, 0 means to return results starting from the first matching\njob, and 10 means to return from the 11th job. This can be used for\npagination, (for example, pageSize = 10 and offset = 10 means to return\nfrom the second page).", + "description": "Optional. 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 is unset. 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).", "format": "int32", "type": "integer" }, "orderBy": { - "description": "Deprecated. Use sort_by instead.\n\nOptional.\n\nThe criteria determining how search results are sorted.\nDefaults to SortBy.RELEVANCE_DESC if no value is specified.", + "description": "Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.", "enum": [ "SORT_BY_UNSPECIFIED", "RELEVANCE_DESC", @@ -3223,25 +3953,25 @@ ], "enumDescriptions": [ "Default value.", - "By descending relevance, as determined by the API algorithms.\n\nRelevance thresholding of query results is only available for queries if\nRELEVANCE_DESC sort ordering is specified.", + "By descending relevance, as determined by the API algorithms. Relevance thresholding of query results is only available for queries if RELEVANCE_DESC sort ordering is specified.", "Sort by published date descending.", "Sort by updated date descending.", "Sort by job title ascending.", "Sort by job title descending.", - "Sort by job annualized base compensation in ascending order.\nIf job's annualized base compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized total compensation in ascending order.\nIf job's annualized total compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized base compensation in descending order.\nIf job's annualized base compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized total compensation in descending order.\nIf job's annualized total compensation is unspecified, they are put at\nthe end of search result." + "Sort by job annualized base compensation in ascending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized total compensation in ascending order. If job's annualized total compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized base compensation in descending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized total compensation in descending order. If job's annualized total compensation is unspecified, they are put at the end of search result." ], "type": "string" }, "pageSize": { - "description": "Optional. A limit on the number of jobs returned in the search results.\nIncreasing this value above the default value of 10 can increase search\nresponse time. The value can be between 1 and 100.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "pageToken": { - "description": "Optional. The token specifying the current offset within\nsearch results. See SearchJobsResponse.next_page_token for\nan explanation of how to obtain the next set of query results.", + "description": "Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.", "type": "string" }, "query": { @@ -3250,10 +3980,10 @@ }, "requestMetadata": { "$ref": "RequestMetadata", - "description": "Required. The meta information collected about the job searcher, used to improve the\nsearch quality of the service. The identifiers, (such as `user_id`) are\nprovided by users, and must be unique and consistent." + "description": "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." }, "sortBy": { - "description": "Optional. The criteria determining how search results are sorted.\nDefaults to SortBy.RELEVANCE_DESC if no value is specified.", + "description": "Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.", "enum": [ "SORT_BY_UNSPECIFIED", "RELEVANCE_DESC", @@ -3268,15 +3998,15 @@ ], "enumDescriptions": [ "Default value.", - "By descending relevance, as determined by the API algorithms.\n\nRelevance thresholding of query results is only available for queries if\nRELEVANCE_DESC sort ordering is specified.", + "By descending relevance, as determined by the API algorithms. Relevance thresholding of query results is only available for queries if RELEVANCE_DESC sort ordering is specified.", "Sort by published date descending.", "Sort by updated date descending.", "Sort by job title ascending.", "Sort by job title descending.", - "Sort by job annualized base compensation in ascending order.\nIf job's annualized base compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized total compensation in ascending order.\nIf job's annualized total compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized base compensation in descending order.\nIf job's annualized base compensation is unspecified, they are put at\nthe end of search result.", - "Sort by job annualized total compensation in descending order.\nIf job's annualized total compensation is unspecified, they are put at\nthe end of search result." + "Sort by job annualized base compensation in ascending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized total compensation in ascending order. If job's annualized total compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized base compensation in descending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", + "Sort by job annualized total compensation in descending order. If job's annualized total compensation is unspecified, they are put at the end of search result." ], "type": "string" } @@ -3284,28 +4014,28 @@ "type": "object" }, "SearchJobsResponse": { - "description": "Output only.\n\nResponse for SearchJob method.", + "description": "Output only. Response for SearchJob method.", "id": "SearchJobsResponse", "properties": { "appliedCommuteFilter": { "$ref": "CommutePreference", - "description": "The commute filter the service applied to the specified query. This\ninformation is only available when query has a valid CommutePreference." + "description": "The commute filter the service applied to the specified query. This information is only available when query has a valid CommutePreference." }, "appliedJobLocationFilters": { - "description": "The location filters that the service applied to the specified query. If\nany filters are lat-lng based, the JobLocation.location_type is\nJobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", + "description": "The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", "items": { "$ref": "JobLocation" }, "type": "array" }, "estimatedTotalSize": { - "description": "An estimation of the number of jobs that match the specified query.\n\nThis number is not guaranteed to be accurate. For accurate results,\nseenenable_precise_result_size.", + "description": "An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size.", "format": "int64", "type": "string" }, "histogramResults": { "$ref": "HistogramResults", - "description": "The histogram results that match specified\nSearchJobsRequest.HistogramFacets." + "description": "The histogram results that match specified SearchJobsRequest.HistogramFacets." }, "jobView": { "description": "Corresponds to SearchJobsRequest.job_view.", @@ -3317,9 +4047,9 @@ ], "enumDescriptions": [ "Default value.", - "A small view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.job_title,\nJob.company_name, Job.job_locations, Job.description,\nJob.visibility.\nNote: Job.description is deprecated. It is scheduled to be removed\nfrom MatchingJob.Job objects in the SearchJobsResponse results\non 12/31/2018.", - "A minimal view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.job_title,\nJob.company_name, Job.job_locations.", - "All available attributes are included in the search results.\nNote: [Job.description, Job.responsibilities,\nJob.qualifications and Job.incentives are deprecated.\nThese fields are scheduled to be removed from MatchingJob.Job objects\nin the SearchJobsResponse results on 12/31/2018.\nSee the alternative MatchingJob.search_text_snippet and\nMatchingJob.job_summary fields." + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations, Job.description, Job.visibility. Note: Job.description is deprecated. It is scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018.", + "A minimal view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations.", + "All available attributes are included in the search results. Note: [Job.description, Job.responsibilities, Job.qualifications and Job.incentives are deprecated. These fields are scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018. See the alternative MatchingJob.search_text_snippet and MatchingJob.job_summary fields." ], "type": "string" }, @@ -3332,14 +4062,14 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { - "description": "The token that specifies the starting position of the next page of results.\nThis field is empty if there are no more results.", + "description": "The token that specifies the starting position of the next page of results. This field is empty if there are no more results.", "type": "string" }, "numJobsFromBroadenedQuery": { - "description": "If query broadening is enabled, we may append additional results from the\nbroadened query. This number indicates how many of the jobs returned in the\njobs field are from the broadened query. These results are always at the\nend of the jobs list. In particular, a value of 0 means all the jobs in the\njobs list are from the original (without broadening) query. If this\nfield is non-zero, subsequent requests with offset after this result set\nshould contain all broadened results.", + "description": "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 means 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.", "format": "int32", "type": "integer" }, @@ -3348,7 +4078,7 @@ "description": "The spell checking result, and correction." }, "totalSize": { - "description": "The precise result count, which is available only if the client set\nenable_precise_result_size to `true` or if the response\nis the last page of results. Otherwise, the value will be `-1`.", + "description": "The precise result count, which is available only if the client set enable_precise_result_size to `true` or if the response is the last page of results. Otherwise, the value will be `-1`.", "format": "int64", "type": "string" } @@ -3356,7 +4086,7 @@ "type": "object" }, "SpellingCorrection": { - "description": "Output only.\n\nSpell check result.", + "description": "Output only. Spell check result.", "id": "SpellingCorrection", "properties": { "corrected": { @@ -3370,6 +4100,33 @@ }, "type": "object" }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, "StringValues": { "description": "Represents array of string values.", "id": "StringValues", @@ -3385,11 +4142,11 @@ "type": "object" }, "UpdateJobRequest": { - "description": "Input only.\n\nUpdate job request.", + "description": "Input only. Update job request.", "id": "UpdateJobRequest", "properties": { "disableStreetAddressResolution": { - "description": "Deprecated. Please use processing_options. This flag is ignored if\nprocessing_options is set.\n\nOptional.\n\nIf set to `true`, the service does not attempt resolve a more precise\naddress for the job.", + "description": "Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job.", "type": "boolean" }, "job": { @@ -3398,10 +4155,10 @@ }, "processingOptions": { "$ref": "JobProcessingOptions", - "description": "Optional. Options for job processing.\n\nUpdateJobRequest.disable_street_address_resolution is ignored if this\nflag is set." + "description": "Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set." }, "updateJobFields": { - "description": "Optional but strongly recommended to be provided for the best service\nexperience.\n\nIf update_job_fields is provided, only the specified fields in\njob are updated. Otherwise all the fields are updated.\n\nA field mask to restrict the fields that are updated. Valid values are:\n\n* jobTitle\n* employmentTypes\n* description\n* applicationUrls\n* applicationEmailList\n* applicationInstruction\n* responsibilities\n* qualifications\n* educationLevels\n* level\n* department\n* startDate\n* endDate\n* compensationInfo\n* incentives\n* languageCode\n* benefits\n* expireTime\n* customAttributes\n* visibility\n* publishDate\n* promotionValue\n* locations\n* region\n* expiryDate (deprecated)\n* filterableCustomFields (deprecated)\n* unindexedCustomFields (deprecated)", + "description": "Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated)", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/jobs-v3.json b/discovery/jobs-v3.json index 7582e4cb0e..b02defc1f6 100644 --- a/discovery/jobs-v3.json +++ b/discovery/jobs-v3.json @@ -15,7 +15,7 @@ "baseUrl": "https://jobs.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Talent Solution", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.\n", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "fullyEncodeReservedExpansion": true, @@ -111,7 +111,7 @@ "projects": { "methods": { "complete": { - "description": "Completes the specified prefix with keyword suggestions.\nIntended for use by a job search auto-complete search box.", + "description": "Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.", "flatPath": "v3/projects/{projectsId}:complete", "httpMethod": "GET", "id": "jobs.projects.complete", @@ -120,36 +120,36 @@ ], "parameters": { "companyName": { - "description": "Optional. If provided, restricts completion to specified company.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Optional. If provided, restricts completion to specified company. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "query", "type": "string" }, "languageCode": { - "description": "Deprecated. Use language_codes instead.\n\nOptional.\n\nThe language of the query. This is\nthe BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nFor CompletionType.JOB_TITLE type, only open jobs with the same\nlanguage_code are returned.\n\nFor CompletionType.COMPANY_NAME type,\nonly companies having open jobs with the same language_code are\nreturned.\n\nFor CompletionType.COMBINED type, only open jobs with the same\nlanguage_code or companies having open jobs with the same\nlanguage_code are returned.\n\nThe maximum number of allowed characters is 255.", + "description": "Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.", "location": "query", "type": "string" }, "languageCodes": { - "description": "Optional. The list of languages of the query. This is\nthe BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nFor CompletionType.JOB_TITLE type, only open jobs with the same\nlanguage_codes are returned.\n\nFor CompletionType.COMPANY_NAME type,\nonly companies having open jobs with the same language_codes are\nreturned.\n\nFor CompletionType.COMBINED type, only open jobs with the same\nlanguage_codes or companies having open jobs with the same\nlanguage_codes are returned.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255.", "location": "query", "repeated": true, "type": "string" }, "name": { - "description": "Required. Resource name of project the completion is performed within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of project the completion is performed within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Required. Completion result count.\n\nThe maximum allowed page size is 10.", + "description": "Required. Completion result count. The maximum allowed page size is 10.", "format": "int32", "location": "query", "type": "integer" }, "query": { - "description": "Required. The query used to generate suggestions.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. The query used to generate suggestions. The maximum number of allowed characters is 255.", "location": "query", "type": "string" }, @@ -160,6 +160,11 @@ "TENANT", "PUBLIC" ], + "enumDescriptions": [ + "Default value.", + "Suggestions are based only on the data provided by the client.", + "Suggestions are based on all jobs data in the system that's visible to the client" + ], "location": "query", "type": "string" }, @@ -171,6 +176,12 @@ "COMPANY_NAME", "COMBINED" ], + "enumDescriptions": [ + "Default value.", + "Only suggest job titles.", + "Only suggest company names.", + "Suggest both job titles and company names." + ], "location": "query", "type": "string" } @@ -189,7 +200,7 @@ "clientEvents": { "methods": { "create": { - "description": "Report events issued when end user interacts with customer's application\nthat uses Cloud Talent Solution. You may inspect the created events in\n[self service\ntools](https://console.cloud.google.com/talent-solution/overview).\n[Learn\nmore](https://cloud.google.com/talent-solution/docs/management-tools)\nabout self service tools.", + "description": "Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.", "flatPath": "v3/projects/{projectsId}/clientEvents", "httpMethod": "POST", "id": "jobs.projects.clientEvents.create", @@ -231,7 +242,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the project under which the company is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of the project under which the company is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -251,7 +262,7 @@ ] }, "delete": { - "description": "Deletes specified company.\nPrerequisite: The company has no jobs associated with it.", + "description": "Deletes specified company. Prerequisite: The company has no jobs associated with it.", "flatPath": "v3/projects/{projectsId}/companies/{companiesId}", "httpMethod": "DELETE", "id": "jobs.projects.companies.delete", @@ -260,7 +271,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the company to be deleted.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Required. The resource name of the company to be deleted. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -286,7 +297,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the company to be retrieved.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Required. The resource name of the company to be retrieved. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -312,7 +323,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of companies to be returned, at most 100.\nDefault is 100 if a non-positive number is provided.", + "description": "Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.", "format": "int32", "location": "query", "type": "integer" @@ -323,14 +334,14 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the project under which the company is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of the project under which the company is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "requireOpenJobs": { - "description": "Optional. Set to true if the companies requested must have open jobs.\n\nDefaults to false.\n\nIf true, at most page_size of companies are fetched, among which\nonly those with open jobs are returned.", + "description": "Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.", "location": "query", "type": "boolean" } @@ -345,7 +356,7 @@ ] }, "patch": { - "description": "Updates specified company. Company names can't be updated. To update a\ncompany name, delete the company and all jobs associated with it, and only\nthen re-create them.", + "description": "Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.", "flatPath": "v3/projects/{projectsId}/companies/{companiesId}", "httpMethod": "PATCH", "id": "jobs.projects.companies.patch", @@ -354,7 +365,7 @@ ], "parameters": { "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -387,7 +398,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -407,7 +418,7 @@ ] }, "create": { - "description": "Creates a new job.\n\nTypically, the job becomes searchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3/projects/{projectsId}/jobs", "httpMethod": "POST", "id": "jobs.projects.jobs.create", @@ -416,7 +427,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -436,7 +447,7 @@ ] }, "delete": { - "description": "Deletes the specified job.\n\nTypically, the job becomes unsearchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "DELETE", "id": "jobs.projects.jobs.delete", @@ -445,7 +456,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the job to be deleted.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".", + "description": "Required. The resource name of the job to be deleted. The format is \"projects/{project_id}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\".", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -462,7 +473,7 @@ ] }, "get": { - "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED\nwithin the last 90 days.", + "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.", "flatPath": "v3/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "GET", "id": "jobs.projects.jobs.get", @@ -471,7 +482,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the job to retrieve.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".", + "description": "Required. The resource name of the job to retrieve. The format is \"projects/{project_id}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\".", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -497,12 +508,12 @@ ], "parameters": { "filter": { - "description": "Required. The filter string specifies the jobs to be enumerated.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Optional)\n\nSample Query:\n\n* companyName = \"projects/api-test-project/companies/123\"\n* companyName = \"projects/api-test-project/companies/123\" AND requisitionId\n= \"req-1\"", + "description": "Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = \"projects/api-test-project/companies/123\" * companyName = \"projects/api-test-project/companies/123\" AND requisitionId = \"req-1\"", "location": "query", "type": "string" }, "jobView": { - "description": "Optional. The desired job attributes returned for jobs in the\nsearch response. Defaults to JobView.JOB_VIEW_FULL if no value is\nspecified.", + "description": "Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.", "enum": [ "JOB_VIEW_UNSPECIFIED", "JOB_VIEW_ID_ONLY", @@ -510,11 +521,18 @@ "JOB_VIEW_SMALL", "JOB_VIEW_FULL" ], + "enumDescriptions": [ + "Default value.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", + "All available attributes are included in the search results." + ], "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results.\n\nIf job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed\npage size is 1000. Otherwise, the maximum allowed page size is 100.\n\nDefault is 100 if empty or a number < 1 is specified.", + "description": "Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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.", "format": "int32", "location": "query", "type": "integer" @@ -525,7 +543,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -542,7 +560,7 @@ ] }, "patch": { - "description": "Updates specified job.\n\nTypically, updated contents become visible in search results within 10\nseconds, but it may take up to 5 minutes.", + "description": "Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "PATCH", "id": "jobs.projects.jobs.patch", @@ -551,7 +569,7 @@ ], "parameters": { "name": { - "description": "Required during job update.\n\nThe resource name for the job. This is generated by the service when a\njob is created.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".\n\nUse of this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "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}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -571,7 +589,7 @@ ] }, "search": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs that the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.", "flatPath": "v3/projects/{projectsId}/jobs:search", "httpMethod": "POST", "id": "jobs.projects.jobs.search", @@ -580,7 +598,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project to search within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project to search within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -600,7 +618,7 @@ ] }, "searchForAlert": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis API call is intended for the use case of targeting passive job\nseekers (for example, job seekers who have signed up to receive email\nalerts about potential job opportunities), and has different algorithmic\nadjustments that are targeted to passive job seekers.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.", "flatPath": "v3/projects/{projectsId}/jobs:searchForAlert", "httpMethod": "POST", "id": "jobs.projects.jobs.searchForAlert", @@ -609,7 +627,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project to search within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project to search within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -633,7 +651,7 @@ } } }, - "revision": "20200505", + "revision": "20200929", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -641,18 +659,18 @@ "id": "ApplicationInfo", "properties": { "emails": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this field to specify email address(es) to which resumes or\napplications can be sent.\n\nThe maximum number of allowed characters for each entry is 255.", + "description": "Optional but at least one of uris, emails or instruction must be specified. 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.", "items": { "type": "string" }, "type": "array" }, "instruction": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this field to provide instructions, such as \"Mail your application\nto ...\", that a candidate can follow to apply for the job.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 3,000.", + "description": "Optional but at least one of uris, emails or instruction must be specified. 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": "string" }, "uris": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this URI field to direct an applicant to a website, for example to\nlink to an online application form.\n\nThe maximum number of allowed characters for each entry is 2,000.", + "description": "Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", "items": { "type": "string" }, @@ -662,11 +680,11 @@ "type": "object" }, "BatchDeleteJobsRequest": { - "description": "Input only.\n\nBatch delete jobs request.", + "description": "Input only. Batch delete jobs request.", "id": "BatchDeleteJobsRequest", "properties": { "filter": { - "description": "Required. The filter string specifies the jobs to be deleted.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Required)\n\nSample Query: companyName = \"projects/api-test-project/companies/123\" AND\nrequisitionId = \"req-1\"", + "description": "Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = \"projects/api-test-project/companies/123\" AND requisitionId = \"req-1\"", "type": "string" } }, @@ -700,13 +718,13 @@ }, "range": { "$ref": "BucketRange", - "description": "Bucket range on which histogram was performed for the numeric field,\nthat is, the count represents number of jobs in this range." + "description": "Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range." } }, "type": "object" }, "ClientEvent": { - "description": "An event issued when an end user interacts with the application that\nimplements Cloud Talent Solution. Providing this information improves the\nquality of search and recommendation for the API clients, enabling the\nservice to perform optimally. The number of events sent must be consistent\nwith other calls, such as job searches, issued to the service by the client.", + "description": "An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation 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.", "id": "ClientEvent", "properties": { "createTime": { @@ -715,37 +733,37 @@ "type": "string" }, "eventId": { - "description": "Required. A unique identifier, generated by the client application. This `event_id`\nis used to establish the relationship between different events\n(see parent_event_id).", + "description": "Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id).", "type": "string" }, "extraInfo": { "additionalProperties": { "type": "string" }, - "description": "Optional. Extra information about this event. Used for storing information with no\nmatching field in event payload, for example, user application specific\ncontext or details.\n\nAt most 20 keys are supported. The maximum total size of all keys and\nvalues is 2 KB.", + "description": "Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB.", "type": "object" }, "jobEvent": { "$ref": "JobEvent", - "description": "A event issued when a job seeker interacts with the application that\nimplements Cloud Talent Solution." + "description": "A event issued when a job seeker interacts with the application that implements Cloud Talent Solution." }, "parentEventId": { - "description": "Optional. The event_id of an event that resulted in the current event. For example, a\nJob view event usually follows a parent\nimpression event: A job seeker first does a\nsearch where a list of jobs appears\n(impression). The job seeker then selects a\nresult and views the description of a particular job (Job\nview).", + "description": "Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view).", "type": "string" }, "requestId": { - "description": "Required. A unique ID generated in the API responses. It can be found in\nResponseMetadata.request_id.", + "description": "Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.", "type": "string" } }, "type": "object" }, "CommuteFilter": { - "description": "Input only.\n\nParameters needed for commute search.", + "description": "Input only. Parameters needed for commute search.", "id": "CommuteFilter", "properties": { "allowImpreciseAddresses": { - "description": "Optional. If true, jobs without \"precise\" addresses (street level addresses or GPS\ncoordinates) might also be returned. For city and coarser level addresses,\ntext matching is used. If this field is set to false or is not specified,\nonly jobs that include precise addresses are returned by Commute\nSearch.\n\nNote: If `allow_imprecise_addresses` is set to true, Commute Search is not\nable to calculate accurate commute times to jobs with city level and\ncoarser address information. Jobs with imprecise addresses will return a\n`travel_duration` time of 0 regardless of distance from the job seeker.", + "description": "Optional. If true, jobs without \"precise\" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker.", "type": "boolean" }, "commuteMethod": { @@ -758,13 +776,13 @@ "enumDescriptions": [ "Commute method is not specified.", "Commute time is calculated based on driving time.", - "Commute time is calculated based on public transit including bus, metro,\nsubway, etc." + "Commute time is calculated based on public transit including bus, metro, subway, etc." ], "type": "string" }, "departureTime": { "$ref": "TimeOfDay", - "description": "Optional. The departure time used to calculate traffic impact, represented as\ngoogle.type.TimeOfDay in local time zone.\n\nCurrently traffic model is restricted to hour level resolution." + "description": "Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution." }, "roadTraffic": { "description": "Optional. Specifies the traffic density to use when calculating commute time.", @@ -782,10 +800,10 @@ }, "startCoordinates": { "$ref": "LatLng", - "description": "Required. The latitude and longitude of the location from which to calculate the\ncommute time." + "description": "Required. The latitude and longitude of the location from which to calculate the commute time." }, "travelDuration": { - "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s`\n(one hour). Format is `123s`.", + "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.", "format": "google-duration", "type": "string" } @@ -793,7 +811,7 @@ "type": "object" }, "CommuteInfo": { - "description": "Output only.\n\nCommute details related to this job.", + "description": "Output only. Commute details related to this job.", "id": "CommuteInfo", "properties": { "jobLocation": { @@ -801,7 +819,7 @@ "description": "Location used as the destination in the commute calculation." }, "travelDuration": { - "description": "The number of seconds required to travel to the job location from the\nquery location. A duration of 0 seconds indicates that the job is not\nreachable within the requested duration, but was returned as part of an\nexpanded query.", + "description": "The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.", "format": "google-duration", "type": "string" } @@ -809,11 +827,11 @@ "type": "object" }, "Company": { - "description": "A Company resource represents a company in the service. A company is the\nentity that owns job postings, that is, the hiring entity responsible for\nemploying applicants for the job position.", + "description": "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.", "id": "Company", "properties": { "careerSiteUri": { - "description": "Optional. The URI to employer's career site or careers page on the employer's web\nsite, for example, \"https://careers.google.com\".", + "description": "Optional. The URI to employer's career site or careers page on the employer's web site, for example, \"https://careers.google.com\".", "type": "string" }, "derivedInfo": { @@ -825,19 +843,19 @@ "type": "string" }, "eeoText": { - "description": "Optional. Equal Employment Opportunity legal disclaimer text to be\nassociated with all jobs, and typically to be displayed in all\nroles.\n\nThe maximum number of allowed characters is 500.", + "description": "Optional. 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": "string" }, "externalId": { - "description": "Required. Client side company identifier, used to uniquely identify the\ncompany.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.", "type": "string" }, "headquartersAddress": { - "description": "Optional. The street address of the company's main headquarters, which may be\ndifferent from the job location. The service attempts\nto geolocate the provided address, and populates a more specific\nlocation wherever possible in DerivedInfo.headquarters_location.", + "description": "Optional. 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.", "type": "string" }, "hiringAgency": { - "description": "Optional. Set to true if it is the hiring agency that post jobs for other\nemployers.\n\nDefaults to false if not provided.", + "description": "Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.", "type": "boolean" }, "imageUri": { @@ -845,14 +863,14 @@ "type": "string" }, "keywordSearchableJobCustomAttributes": { - "description": "Optional. A list of keys of filterable Job.custom_attributes, whose\ncorresponding `string_values` are used in keyword search. Jobs with\n`string_values` under these specified field keys are returned if any\nof the values matches the search keyword. Custom field values with\nparenthesis, brackets and special symbols won't be properly searchable,\nand those keyword queries need to be surrounded by quotes.", + "description": "Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.", "items": { "type": "string" }, "type": "array" }, "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "type": "string" }, "size": { @@ -880,11 +898,11 @@ "type": "string" }, "suspended": { - "description": "Output only. Indicates whether a company is flagged to be suspended from\npublic availability by the service when job content appears suspicious,\nabusive, or spammy.", + "description": "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": "boolean" }, "websiteUri": { - "description": "Optional. The URI representing the company's primary web site or home page,\nfor example, \"https://www.google.com\".\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. 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": "string" } }, @@ -896,13 +914,13 @@ "properties": { "headquartersLocation": { "$ref": "Location", - "description": "A structured headquarters location of the company, resolved from\nCompany.hq_location if provided." + "description": "A structured headquarters location of the company, resolved from Company.hq_location if provided." } }, "type": "object" }, "CompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such\nas base pay, bonus, or other compensation type.\n\nAnnualization: One compensation entry can be annualized if\n- it contains valid amount or range.\n- and its expected_units_per_year is set or can be derived.\nIts annualized range is determined as (amount or range) times\nexpected_units_per_year.", + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", "id": "CompensationEntry", "properties": { "amount": { @@ -910,11 +928,11 @@ "description": "Optional. Compensation amount." }, "description": { - "description": "Optional. Compensation description. For example, could\nindicate equity terms or provide additional context to an estimated\nbonus.", + "description": "Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", "type": "string" }, "expectedUnitsPerYear": { - "description": "Optional. Expected number of units paid each year. If not specified, when\nJob.employment_types is FULLTIME, a default value is inferred\nbased on unit. Default values:\n- HOURLY: 2080\n- DAILY: 260\n- WEEKLY: 52\n- MONTHLY: 12\n- ANNUAL: 1", + "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", "format": "double", "type": "number" }, @@ -923,7 +941,7 @@ "description": "Optional. Compensation range." }, "type": { - "description": "Optional. Compensation type.\n\nDefault is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.", + "description": "Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.", "enum": [ "COMPENSATION_TYPE_UNSPECIFIED", "BASE", @@ -937,7 +955,7 @@ ], "enumDescriptions": [ "Default value.", - "Base compensation: Refers to the fixed amount of money paid to an\nemployee by an employer in return for work performed. Base compensation\ndoes not include benefits, bonuses or any other potential compensation\nfrom an employer.", + "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.", "Signing bonus.", "Equity.", @@ -949,7 +967,7 @@ "type": "string" }, "unit": { - "description": "Optional. Frequency of the specified amount.\n\nDefault is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", "HOURLY", @@ -976,11 +994,11 @@ "type": "object" }, "CompensationFilter": { - "description": "Input only.\n\nFilter on job compensation type and amount.", + "description": "Input only. Filter on job compensation type and amount.", "id": "CompensationFilter", "properties": { "includeJobsWithUnspecifiedCompensationRange": { - "description": "Optional. If set to true, jobs with unspecified compensation range fields are\nincluded.", + "description": "Optional. If set to true, jobs with unspecified compensation range fields are included.", "type": "boolean" }, "range": { @@ -998,25 +1016,15 @@ ], "enumDescriptions": [ "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and\nonly if the job contains a base CompensationEntry and the base\nCompensationEntry's unit matches provided units.\nPopulate one or more units.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job\nis a match if and only if the job contains a base CompensationEntry, and\nthe base entry's unit matches provided compensation_units and amount\nor range overlaps with provided compensation_range.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.\n\nSet exactly one units and populate range.", - "Filter by annualized base compensation amount and `base compensation\nentry's` unit. Populate range and zero or more units.", - "Filter by annualized total compensation amount and `base compensation\nentry's` unit . Populate range and zero or more units." + "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units. See CompensationInfo.CompensationEntry for definition of base compensation entry.", + "Filter by `base compensation entry's` unit 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 compensation_units and amount or range overlaps with provided compensation_range. See CompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one units and populate range.", + "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate range and zero or more units.", + "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate range and zero or more units." ], "type": "string" }, "units": { - "description": "Required. Specify desired `base compensation entry's`\nCompensationInfo.CompensationUnit.", - "enumDescriptions": [ - "Default value.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], + "description": "Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.", "items": { "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", @@ -1028,6 +1036,16 @@ "ONE_TIME", "OTHER_COMPENSATION_UNIT" ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], "type": "string" }, "type": "array" @@ -1036,7 +1054,7 @@ "type": "object" }, "CompensationHistogramRequest": { - "description": "Input only.\n\nCompensation based histogram request.", + "description": "Input only. Compensation based histogram request.", "id": "CompensationHistogramRequest", "properties": { "bucketingOption": { @@ -1044,7 +1062,7 @@ "description": "Required. Numeric histogram options, like buckets, whether include min or max value." }, "type": { - "description": "Required. Type of the request, representing which field the histogramming should be\nperformed over. A single request can only specify one histogram of each\n`CompensationHistogramRequestType`.", + "description": "Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1053,9 +1071,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1063,7 +1081,7 @@ "type": "object" }, "CompensationHistogramResult": { - "description": "Output only.\n\nCompensation based histogram result.", + "description": "Output only. Compensation based histogram result.", "id": "CompensationHistogramResult", "properties": { "result": { @@ -1071,7 +1089,7 @@ "description": "Histogram result." }, "type": { - "description": "Type of the request, corresponding to\nCompensationHistogramRequest.type.", + "description": "Type of the request, corresponding to CompensationHistogramRequest.type.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1080,9 +1098,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1095,14 +1113,14 @@ "properties": { "annualizedBaseCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized base compensation range. Computed as\nbase compensation entry's CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "annualizedTotalCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized total compensation range. Computed as\nall compensation entries' CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "entries": { - "description": "Optional. Job compensation information.\n\nAt most one entry can be of type\nCompensationInfo.CompensationType.BASE, which is\nreferred as ** base compensation entry ** for the job.", + "description": "Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", "items": { "$ref": "CompensationEntry" }, @@ -1117,17 +1135,17 @@ "properties": { "maxCompensation": { "$ref": "Money", - "description": "Optional. The maximum amount of compensation. If left empty, the value is set\nto a maximal compensation value and the currency code is set to\nmatch the currency code of\nmin_compensation." + "description": "Optional. 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 of min_compensation." }, "minCompensation": { "$ref": "Money", - "description": "Optional. The minimum amount of compensation. If left empty, the value is set\nto zero and the currency code is set to match the\ncurrency code of max_compensation." + "description": "Optional. 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 of max_compensation." } }, "type": "object" }, "CompleteQueryResponse": { - "description": "Output only.\n\nResponse of auto-complete query.", + "description": "Output only. Response of auto-complete query.", "id": "CompleteQueryResponse", "properties": { "completionResults": { @@ -1139,13 +1157,13 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." } }, "type": "object" }, "CompletionResult": { - "description": "Output only.\n\nResource that represents completion results.", + "description": "Output only. Resource that represents completion results.", "id": "CompletionResult", "properties": { "imageUri": { @@ -1181,13 +1199,13 @@ "properties": { "clientEvent": { "$ref": "ClientEvent", - "description": "Required. Events issued when end user interacts with customer's application that\nuses Cloud Talent Solution." + "description": "Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution." } }, "type": "object" }, "CreateCompanyRequest": { - "description": "Input only.\n\nThe Request of the CreateCompany method.", + "description": "Input only. The Request of the CreateCompany method.", "id": "CreateCompanyRequest", "properties": { "company": { @@ -1198,7 +1216,7 @@ "type": "object" }, "CreateJobRequest": { - "description": "Input only.\n\nCreate job request.", + "description": "Input only. Create job request.", "id": "CreateJobRequest", "properties": { "job": { @@ -1213,11 +1231,11 @@ "id": "CustomAttribute", "properties": { "filterable": { - "description": "Optional. If the `filterable` flag is true, the custom field values may be used for\ncustom attribute filters JobQuery.custom_attribute_filter.\nIf false, these values may not be used for custom attribute filters.\n\nDefault is false.", + "description": "Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", "type": "boolean" }, "longValues": { - "description": "Optional but exactly one of string_values or long_values must\nbe specified.\n\nThis field is used to perform number range search.\n(`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.\n\nCurrently at most 1 long_values is supported.", + "description": "Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", "items": { "format": "int64", "type": "string" @@ -1225,7 +1243,7 @@ "type": "array" }, "stringValues": { - "description": "Optional but exactly one of string_values or long_values must\nbe specified.\n\nThis field is used to perform a string match (`CASE_SENSITIVE_MATCH` or\n`CASE_INSENSITIVE_MATCH`) search.\nFor filterable `string_value`s, a maximum total number of 200 values\nis allowed, with each `string_value` has a byte size of no more than\n500B. For unfilterable `string_values`, the maximum total byte size of\nunfilterable `string_values` is 50KB.\n\nEmpty string is not allowed.", + "description": "Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed.", "items": { "type": "string" }, @@ -1235,26 +1253,26 @@ "type": "object" }, "CustomAttributeHistogramRequest": { - "description": "Custom attributes histogram request. An error is thrown if neither\nstring_value_histogram or long_value_histogram_bucketing_option has\nbeen defined.", + "description": "Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.", "id": "CustomAttributeHistogramRequest", "properties": { "key": { - "description": "Required. Specifies the custom field key to perform a histogram on. If specified\nwithout `long_value_histogram_bucketing_option`, histogram on string values\nof the given `key` is triggered, otherwise histogram is performed on long\nvalues.", + "description": "Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.", "type": "string" }, "longValueHistogramBucketingOption": { "$ref": "NumericBucketingOption", - "description": "Optional. Specifies buckets used to perform a range histogram on Job's\nfilterable long custom field values, or min/max value requirements." + "description": "Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements." }, "stringValueHistogram": { - "description": "Optional. If set to true, the response includes the histogram value for\neach key as a string.", + "description": "Optional. If set to true, the response includes the histogram value for each key as a string.", "type": "boolean" } }, "type": "object" }, "CustomAttributeHistogramResult": { - "description": "Output only.\n\nCustom attribute histogram result.", + "description": "Output only. Custom attribute histogram result.", "id": "CustomAttributeHistogramResult", "properties": { "key": { @@ -1263,21 +1281,21 @@ }, "longValueHistogramResult": { "$ref": "NumericBucketingResult", - "description": "Stores bucketed histogram counting result or min/max values for\ncustom attribute long values associated with `key`." + "description": "Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`." }, "stringValueHistogramResult": { "additionalProperties": { "format": "int32", "type": "integer" }, - "description": "Stores a map from the values of string custom field associated\nwith `key` to the number of jobs with that value in this histogram result.", + "description": "Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.", "type": "object" } }, "type": "object" }, "DeviceInfo": { - "description": "Device information collected from the job seeker, candidate, or\nother entity conducting the job search. Providing this information improves\nthe quality of the search results across devices.", + "description": "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.", "id": "DeviceInfo", "properties": { "deviceType": { @@ -1293,226 +1311,313 @@ ], "enumDescriptions": [ "The device type isn't specified.", - "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet\nExplorer)", - "A mobile device web browser, such as a phone or tablet with a Chrome\nbrowser.", + "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)", + "A mobile device web browser, such as a phone or tablet with a Chrome browser.", "An Android device native application.", "An iOS device native application.", - "A bot, as opposed to a device operated by human beings, such as a web\ncrawler.", + "A bot, as opposed to a device operated by human beings, such as a web crawler.", "Other devices types." ], "type": "string" }, "id": { - "description": "Optional. A device-specific ID. The ID must be a unique identifier that\ndistinguishes the device from other devices.", + "description": "Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.", "type": "string" } }, "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, - "HistogramFacets": { - "description": "Input only.\n\nHistogram facets to be specified in SearchJobsRequest.", - "id": "HistogramFacets", + "GoogleCloudTalentV4BatchCreateJobsResponse": { + "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchCreateJobsResponse", "properties": { - "compensationHistogramFacets": { - "description": "Optional. Specifies compensation field-based histogram requests.\nDuplicate values of CompensationHistogramRequest.type are not allowed.", + "jobResults": { + "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", "items": { - "$ref": "CompensationHistogramRequest" + "$ref": "GoogleCloudTalentV4JobResult" }, "type": "array" - }, - "customAttributeHistogramFacets": { - "description": "Optional. Specifies the custom attributes histogram requests.\nDuplicate values of CustomAttributeHistogramRequest.key are not\nallowed.", + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchDeleteJobsResponse": { + "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchDeleteJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", "items": { - "$ref": "CustomAttributeHistogramRequest" + "$ref": "GoogleCloudTalentV4JobResult" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchOperationMetadata": { + "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", + "id": "GoogleCloudTalentV4BatchOperationMetadata", + "properties": { + "createTime": { + "description": "The time when the batch operation is created.", + "format": "google-datetime", + "type": "string" }, - "simpleHistogramFacets": { - "description": "Optional. Specifies the simple type of histogram facets, for example,\n`COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.", + "endTime": { + "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of failed item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of a long running operation.", + "enum": [ + "STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "SUCCEEDED", + "FAILED", + "CANCELLING", + "CANCELLED" + ], "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Possible return values are:\n* PAST_24_HOURS (The past 24 hours)\n* PAST_3_DAYS (The past 3 days)\n* PAST_WEEK (The past 7 days)\n* PAST_MONTH (The past 30 days)\n* PAST_YEAR (The past 365 days)", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Company display name.", - "Base compensation unit." + "Default value.", + "The batch operation is being prepared for processing.", + "The batch operation is actively being processed.", + "The batch operation is processed, and at least one item has been successfully processed.", + "The batch operation is done and no item has been successfully processed.", + "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", + "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." ], + "type": "string" + }, + "stateDescription": { + "description": "More detailed information about operation state.", + "type": "string" + }, + "successCount": { + "description": "Count of successful item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Count of total item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchUpdateJobsResponse": { + "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchUpdateJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", "items": { - "enum": [ - "SEARCH_TYPE_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN_1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN_1_COUNTRY", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "type": "string" + "$ref": "GoogleCloudTalentV4JobResult" }, "type": "array" } }, "type": "object" }, - "HistogramResult": { - "description": "Output only.\n\nResult of a histogram call. The response contains the histogram map for the\nsearch type specified by HistogramResult.field.\nThe response is a map of each filter value to the corresponding count of\njobs for that filter.", - "id": "HistogramResult", + "GoogleCloudTalentV4CompensationInfo": { + "description": "Job compensation details.", + "id": "GoogleCloudTalentV4CompensationInfo", "properties": { - "searchType": { - "description": "The Histogram search filters.", + "annualizedBaseCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "annualizedTotalCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "entries": { + "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", + "items": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CompensationInfoCompensationEntry": { + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationEntry", + "properties": { + "amount": { + "$ref": "Money", + "description": "Compensation amount." + }, + "description": { + "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", + "type": "string" + }, + "expectedUnitsPerYear": { + "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Compensation range." + }, + "type": { + "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", "enum": [ - "SEARCH_TYPE_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN_1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN_1_COUNTRY", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" + "COMPENSATION_TYPE_UNSPECIFIED", + "BASE", + "BONUS", + "SIGNING_BONUS", + "EQUITY", + "PROFIT_SHARING", + "COMMISSIONS", + "TIPS", + "OTHER_COMPENSATION_TYPE" ], "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Possible return values are:\n* PAST_24_HOURS (The past 24 hours)\n* PAST_3_DAYS (The past 3 days)\n* PAST_WEEK (The past 7 days)\n* PAST_MONTH (The past 30 days)\n* PAST_YEAR (The past 365 days)", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Company display name.", - "Base compensation unit." + "Default value.", + "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.", + "Signing bonus.", + "Equity.", + "Profit sharing.", + "Commission.", + "Tips.", + "Other compensation type." ], "type": "string" }, - "values": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "description": "A map from the values of field to the number of jobs with that value\nin this search result.\n\nKey: search type (filter names, such as the companyName).\n\nValues: the count of jobs that match the filter for this search.", - "type": "object" + "unit": { + "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "enum": [ + "COMPENSATION_UNIT_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY", + "ONE_TIME", + "OTHER_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], + "type": "string" } }, "type": "object" }, - "HistogramResults": { - "description": "Output only.\n\nHistogram results that match HistogramFacets specified in\nSearchJobsRequest.", - "id": "HistogramResults", + "GoogleCloudTalentV4CompensationInfoCompensationRange": { + "description": "Compensation range.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationRange", "properties": { - "compensationHistogramResults": { - "description": "Specifies compensation field-based histogram results that match\nHistogramFacets.compensation_histogram_requests.", - "items": { - "$ref": "CompensationHistogramResult" - }, - "type": "array" + "maxCompensation": { + "$ref": "Money", + "description": "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 of min_compensation." }, - "customAttributeHistogramResults": { - "description": "Specifies histogram results for custom attributes that match\nHistogramFacets.custom_attribute_histogram_facets.", + "minCompensation": { + "$ref": "Money", + "description": "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 of max_compensation." + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CustomAttribute": { + "description": "Custom attribute values that are either filterable or non-filterable.", + "id": "GoogleCloudTalentV4CustomAttribute", + "properties": { + "filterable": { + "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", + "type": "boolean" + }, + "keywordSearchable": { + "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", + "type": "boolean" + }, + "longValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", "items": { - "$ref": "CustomAttributeHistogramResult" + "format": "int64", + "type": "string" }, "type": "array" }, - "simpleHistogramResults": { - "description": "Specifies histogram results that matches\nHistogramFacets.simple_histogram_facets.", + "stringValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", "items": { - "$ref": "HistogramResult" + "type": "string" }, "type": "array" } }, "type": "object" }, - "Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\"\nor \"job requisition\"). A job belongs to a Company, which is the hiring\nentity responsible for the job.", - "id": "Job", + "GoogleCloudTalentV4Job": { + "description": "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.", + "id": "GoogleCloudTalentV4Job", "properties": { "addresses": { - "description": "Optional but strongly recommended for the best service experience.\n\nLocation(s) where the employer is looking to hire for this job posting.\n\nSpecifying the full street address(es) of the hiring location enables\nbetter API results, especially job searches by commute time.\n\nAt most 50 locations are allowed for best search performance. If a job has\nmore locations, it is suggested to split it into multiple jobs with unique\nrequisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as\nmultiple jobs with the same company_name, language_code and\nrequisition_id are not allowed. If the original requisition_id must\nbe preserved, a custom field should be used for storage. It is also\nsuggested to group the locations that close to each other in the same job\nfor better search experience.\n\nThe maximum number of allowed characters is 500.", + "description": "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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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.", "items": { "type": "string" }, "type": "array" }, "applicationInfo": { - "$ref": "ApplicationInfo", - "description": "Required. At least one field within ApplicationInfo must be specified.\n\nJob application information." + "$ref": "GoogleCloudTalentV4JobApplicationInfo", + "description": "Job application information." }, - "companyDisplayName": { - "description": "Output only. Display name of the company listing the job.", + "company": { + "description": "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\".", "type": "string" }, - "companyName": { - "description": "Required. The resource name of the company listing the job, such as\n\"projects/api-test-project/companies/foo\".", + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "readOnly": true, "type": "string" }, "compensationInfo": { - "$ref": "CompensationInfo", - "description": "Optional. Job compensation information." + "$ref": "GoogleCloudTalentV4CompensationInfo", + "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." }, "customAttributes": { "additionalProperties": { - "$ref": "CustomAttribute" + "$ref": "GoogleCloudTalentV4CustomAttribute" }, - "description": "Optional. A map of fields to hold both filterable and non-filterable custom job\nattributes that are not covered by the provided structured fields.\n\nThe keys of the map are strings up to 64 bytes and must match the\npattern: a-zA-Z*. For example, key0LikeThis or\nKEY_1_LIKE_THIS.\n\nAt most 100 filterable and at most 100 unfilterable keys are supported.\nFor filterable `string_values`, across all keys at most 200 values are\nallowed, with each string no more than 255 characters. For unfilterable\n`string_values`, the maximum total size of `string_values` across all keys\nis 50KB.", + "description": "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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", "type": "object" }, "degreeTypes": { - "description": "Optional. The desired education degrees for the job, such as Bachelors, Masters.", - "enumDescriptions": [ - "Default value. Represents no degree, or early childhood education.\nMaps to ISCED code 0.\nEx) Kindergarten", - "Primary education which is typically the first stage of compulsory\neducation. ISCED code 1.\nEx) Elementary school", - "Lower secondary education; First stage of secondary education building on\nprimary education, typically with a more subject-oriented curriculum.\nISCED code 2.\nEx) Middle school", - "Middle education; Second/final stage of secondary education preparing for\ntertiary education and/or providing skills relevant to employment.\nUsually with an increased range of subject options and streams. ISCED\ncode 3.\nEx) High school", - "Adult Remedial Education; Programmes providing learning experiences that\nbuild on secondary education and prepare for labour market entry and/or\ntertiary education. The content is broader than secondary but not as\ncomplex as tertiary education. ISCED code 4.", - "Associate's or equivalent; Short first tertiary programmes that are\ntypically practically-based, occupationally-specific and prepare for\nlabour market entry. These programmes may also provide a pathway to other\ntertiary programmes. ISCED code 5.", - "Bachelor's or equivalent; Programmes designed to provide intermediate\nacademic and/or professional knowledge, skills and competencies leading\nto a first tertiary degree or equivalent qualification. ISCED code 6.", - "Master's or equivalent; Programmes designed to provide advanced academic\nand/or professional knowledge, skills and competencies leading to a\nsecond tertiary degree or equivalent qualification. ISCED code 7.", - "Doctoral or equivalent; Programmes designed primarily to lead to an\nadvanced research qualification, usually concluding with the submission\nand defense of a substantive dissertation of publishable quality based on\noriginal research. ISCED code 8." - ], + "description": "The desired education degrees for the job, such as Bachelors, Masters.", "items": { "enum": [ "DEGREE_TYPE_UNSPECIFIED", @@ -1525,37 +1630,36 @@ "MASTERS_OR_EQUIVALENT", "DOCTORAL_OR_EQUIVALENT" ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "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", + "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; 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.", + "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.", + "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.", + "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; 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." + ], "type": "string" }, "type": "array" }, "department": { - "description": "Optional. The department or functional area within the company with the open\nposition.\n\nThe maximum number of allowed characters is 255.", + "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", "type": "string" }, "derivedInfo": { - "$ref": "JobDerivedInfo", - "description": "Output only. Derived details about the job posting." + "$ref": "GoogleCloudTalentV4JobDerivedInfo", + "description": "Output only. Derived details about the job posting.", + "readOnly": true }, "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph\ndescription of the company and related information. Separate fields are\nprovided on the job object for responsibilities,\nqualifications, and other job characteristics. Use of\nthese separate job fields is recommended.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 100,000.", + "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, 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": "string" }, "employmentTypes": { - "description": "Optional. The employment type(s) of a job, for example,\nfull time or\npart time.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a contracted position with the understanding\nthat it's converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job\nseekers to obtain on-the-job training, typically offered as a summer\nposition.", - "The is an opportunity for an individual to volunteer, where there's no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "The employment type(s) of a job, for example, full time or part time.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -1570,30 +1674,29 @@ "FLY_IN_FLY_OUT", "OTHER_EMPLOYMENT_TYPE" ], + "enumDescriptions": [ + "The default value if the employment type isn't specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "incentives": { - "description": "Optional. A description of bonus, commission, and other compensation\nincentives associated with the job not including salary or pay.\n\nThe maximum number of allowed characters is 10,000.", + "description": "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": "string" }, "jobBenefits": { - "description": "Optional. The benefits included with the job.", - "enumDescriptions": [ - "Default value if the type is not specified.", - "The job includes access to programs that support child care, such\nas daycare.", - "The job includes dental services covered by a dental\ninsurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services covered by a medical insurance plan.", - "The job includes a life insurance plan provided by the employer or\navailable for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn\nchild.", - "The job includes a workplace retirement plan provided by the\nemployer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "The job includes paid time off for vacation.", - "The job includes vision services covered by a vision\ninsurance plan." - ], + "description": "The benefits included with the job.", "items": { "enum": [ "JOB_BENEFIT_UNSPECIFIED", @@ -1609,17 +1712,31 @@ "VACATION", "VISION" ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], "type": "string" }, "type": "array" }, "jobEndTime": { - "description": "Optional. The end timestamp of the job. Typically this field is used for contracting\nengagements. Invalid timestamps are ignored.", + "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", "format": "google-datetime", "type": "string" }, "jobLevel": { - "description": "Optional. The experience level associated with the job, such as \"Entry Level\".", + "description": "The experience level associated with the job, such as \"Entry Level\".", "enum": [ "JOB_LEVEL_UNSPECIFIED", "ENTRY_LEVEL", @@ -1629,9 +1746,9 @@ "EXECUTIVE" ], "enumDescriptions": [ - "The default value if the level is not specified.", - "Entry-level individual contributors, typically with less than 2 years of\nexperience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of\nexperience in a similar role.", + "The default value if the level isn't specified.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", "Entry- to mid-level managers responsible for managing a team of people.", "Senior-level managers responsible for managing teams of managers.", "Executive-level managers and above, including C-level positions." @@ -1639,35 +1756,36 @@ "type": "string" }, "jobStartTime": { - "description": "Optional. The start timestamp of the job in UTC time zone. Typically this field\nis used for contracting engagements. Invalid timestamps are ignored.", + "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", "format": "google-datetime", "type": "string" }, "languageCode": { - "description": "Optional. The language of the posting. This field is distinct from\nany requirements for fluency that are associated with the job.\n\nLanguage codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:\nclass=\"external\" target=\"_blank\" }.\n\nIf this field is unspecified and Job.description is present, detected\nlanguage code based on Job.description is assigned, otherwise\ndefaults to 'en_US'.", + "description": "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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", "type": "string" }, "name": { - "description": "Required during job update.\n\nThe resource name for the job. This is generated by the service when a\njob is created.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".\n\nUse of this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "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\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "type": "string" }, "postingCreateTime": { "description": "Output only. The timestamp when this job posting was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "postingExpireTime": { - "description": "Optional but strongly recommended for the best service\nexperience.\n\nThe expiration timestamp of the job. After this timestamp, the\njob is marked as expired, and it no longer appears in search results. The\nexpired job can't be deleted or listed by the DeleteJob and\nListJobs APIs, but it can be retrieved with the GetJob API or\nupdated with the UpdateJob API. An expired job can be updated and\nopened again by using a future expiration timestamp. Updating an expired\njob fails if there is another existing open job with same company_name,\nlanguage_code and requisition_id.\n\nThe expired jobs are retained in our system for 90 days. However, the\noverall expired job count cannot exceed 3 times the maximum of open jobs\ncount over the past week, otherwise jobs with earlier expire time are\ncleaned first. Expired jobs are no longer accessible after they are cleaned\nout.\n\nInvalid timestamps are ignored, and treated as expire time not provided.\n\nTimestamp before the instant request is made is considered valid, the job\nwill be treated as expired immediately.\n\nIf this value is not provided at the time of job creation or is invalid,\nthe job posting expires after 30 days from the job's creation time. For\nexample, if the job was created on 2017/01/01 13:00AM UTC with an\nunspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.\n\nIf this value is not provided on job update, it depends on the field masks\nset by UpdateJobRequest.update_mask. If the field masks include\nexpiry_time, or the masks are empty meaning that every field is\nupdated, the job posting expires after 30 days from the job's last\nupdate time. Otherwise the expiration date isn't updated.", + "description": "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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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.", "format": "google-datetime", "type": "string" }, "postingPublishTime": { - "description": "Optional. The timestamp this job posting was most recently published. The default\nvalue is the time the request arrives at the server. Invalid timestamps are\nignored.", + "description": "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.", "format": "google-datetime", "type": "string" }, "postingRegion": { - "description": "Optional. The job PostingRegion (for example, state, country) throughout which\nthe job is available. If this field is set, a\nLocationFilter in a search query within the job region\nfinds this job posting if an exact location match isn't specified.\nIf this field is set to PostingRegion.NATION or\nPostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses\nto the same location level as this field is strongly recommended.", + "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", "enum": [ "POSTING_REGION_UNSPECIFIED", "ADMINISTRATIVE_AREA", @@ -1675,45 +1793,664 @@ "TELECOMMUTE" ], "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it\nmatches the LocationFilter.", - "In addition to exact location matching, job posting is returned when the\nLocationFilter in the search query is in the same administrative area\nas the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job\nis posted in \"CA, USA\", it's returned if LocationFilter has\n\"Mountain View\".\n\nAdministrative area refers to top-level administrative subdivision of this\ncountry. For example, US state, IT region, UK constituent nation and\nJP prefecture.", - "In addition to exact location matching, job is returned when\nLocationFilter in search query is in the same country as this job.\nFor example, if a `NATION_WIDE` job is posted in \"USA\", it's\nreturned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute).\nIf locations are provided with this value, the job is\nconsidered as having a location, but telecommuting is allowed." + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if 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.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "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." ], "type": "string" }, "postingUpdateTime": { "description": "Output only. The timestamp when this job posting was last updated.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "processingOptions": { - "$ref": "ProcessingOptions", + "$ref": "GoogleCloudTalentV4JobProcessingOptions", + "description": "Options for job processing." + }, + "promotionValue": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "qualifications": { + "description": "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 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": "string" + }, + "requisitionId": { + "description": "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, language_code and requisition_id. The maximum number of allowed characters is 255.", + "type": "string" + }, + "responsibilities": { + "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" + }, + "title": { + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", + "type": "string" + }, + "visibility": { + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "ACCOUNT_ONLY", + "SHARED_WITH_GOOGLE", + "SHARED_WITH_PUBLIC" + ], + "enumDescriptions": [ + "Default value.", + "The resource is only visible to the GCP account who owns it.", + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobApplicationInfo": { + "description": "Application related details of a job posting.", + "id": "GoogleCloudTalentV4JobApplicationInfo", + "properties": { + "emails": { + "description": "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "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": "string" + }, + "uris": { + "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobDerivedInfo": { + "description": "Derived details about the job posting.", + "id": "GoogleCloudTalentV4JobDerivedInfo", + "properties": { + "jobCategories": { + "description": "Job categories derived from Job.title and Job.description.", + "items": { + "enum": [ + "JOB_CATEGORY_UNSPECIFIED", + "ACCOUNTING_AND_FINANCE", + "ADMINISTRATIVE_AND_OFFICE", + "ADVERTISING_AND_MARKETING", + "ANIMAL_CARE", + "ART_FASHION_AND_DESIGN", + "BUSINESS_OPERATIONS", + "CLEANING_AND_FACILITIES", + "COMPUTER_AND_IT", + "CONSTRUCTION", + "CUSTOMER_SERVICE", + "EDUCATION", + "ENTERTAINMENT_AND_TRAVEL", + "FARMING_AND_OUTDOORS", + "HEALTHCARE", + "HUMAN_RESOURCES", + "INSTALLATION_MAINTENANCE_AND_REPAIR", + "LEGAL", + "MANAGEMENT", + "MANUFACTURING_AND_WAREHOUSE", + "MEDIA_COMMUNICATIONS_AND_WRITING", + "OIL_GAS_AND_MINING", + "PERSONAL_CARE_AND_SERVICES", + "PROTECTIVE_SERVICES", + "REAL_ESTATE", + "RESTAURANT_AND_HOSPITALITY", + "SALES_AND_RETAIL", + "SCIENCE_AND_ENGINEERING", + "SOCIAL_SERVICES_AND_NON_PROFIT", + "SPORTS_FITNESS_AND_RECREATION", + "TRANSPORTATION_AND_LOGISTICS" + ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], + "type": "string" + }, + "type": "array" + }, + "locations": { + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", + "items": { + "$ref": "GoogleCloudTalentV4Location" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobProcessingOptions": { + "description": "Options for job processing.", + "id": "GoogleCloudTalentV4JobProcessingOptions", + "properties": { + "disableStreetAddressResolution": { + "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", + "type": "boolean" + }, + "htmlSanitization": { + "description": "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.", + "enum": [ + "HTML_SANITIZATION_UNSPECIFIED", + "HTML_SANITIZATION_DISABLED", + "SIMPLE_FORMATTING_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables sanitization on HTML input.", + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobResult": { + "description": "Mutation result of a job from a batch operation.", + "id": "GoogleCloudTalentV4JobResult", + "properties": { + "job": { + "$ref": "GoogleCloudTalentV4Job", + "description": "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." + }, + "status": { + "$ref": "Status", + "description": "The status of the job processed. This field is populated if the processing of the job fails." + } + }, + "type": "object" + }, + "GoogleCloudTalentV4Location": { + "description": "A resource that represents a location with full geographic information.", + "id": "GoogleCloudTalentV4Location", + "properties": { + "latLng": { + "$ref": "LatLng", + "description": "An object representing a latitude/longitude pair." + }, + "locationType": { + "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "COUNTRY", + "ADMINISTRATIVE_AREA", + "SUB_ADMINISTRATIVE_AREA", + "LOCALITY", + "POSTAL_CODE", + "SUB_LOCALITY", + "SUB_LOCALITY_1", + "SUB_LOCALITY_2", + "NEIGHBORHOOD", + "STREET_ADDRESS" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "A country level location.", + "A state or equivalent level location.", + "A county or equivalent level location.", + "A city or equivalent level location.", + "A postal code level location.", + "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.", + "A district or equivalent level location.", + "A smaller district or equivalent level display.", + "A neighborhood level location.", + "A street address level location." + ], + "type": "string" + }, + "postalAddress": { + "$ref": "PostalAddress", + "description": "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." + }, + "radiusMiles": { + "description": "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 covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "HistogramFacets": { + "description": "Input only. Histogram facets to be specified in SearchJobsRequest.", + "id": "HistogramFacets", + "properties": { + "compensationHistogramFacets": { + "description": "Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.", + "items": { + "$ref": "CompensationHistogramRequest" + }, + "type": "array" + }, + "customAttributeHistogramFacets": { + "description": "Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.", + "items": { + "$ref": "CustomAttributeHistogramRequest" + }, + "type": "array" + }, + "simpleHistogramFacets": { + "description": "Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.", + "items": { + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "COMPANY_ID", + "EMPLOYMENT_TYPE", + "COMPANY_SIZE", + "DATE_PUBLISHED", + "EDUCATION_LEVEL", + "EXPERIENCE_LEVEL", + "ADMIN_1", + "COUNTRY", + "CITY", + "LOCALE", + "LANGUAGE", + "CATEGORY", + "CITY_COORDINATE", + "ADMIN_1_COUNTRY", + "COMPANY_DISPLAY_NAME", + "BASE_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Possible return values are: * PAST_24_HOURS (The past 24 hours) * PAST_3_DAYS (The past 3 days) * PAST_WEEK (The past 7 days) * PAST_MONTH (The past 30 days) * PAST_YEAR (The past 365 days)", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Company display name.", + "Base compensation unit." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "HistogramResult": { + "description": "Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.", + "id": "HistogramResult", + "properties": { + "searchType": { + "description": "The Histogram search filters.", + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "COMPANY_ID", + "EMPLOYMENT_TYPE", + "COMPANY_SIZE", + "DATE_PUBLISHED", + "EDUCATION_LEVEL", + "EXPERIENCE_LEVEL", + "ADMIN_1", + "COUNTRY", + "CITY", + "LOCALE", + "LANGUAGE", + "CATEGORY", + "CITY_COORDINATE", + "ADMIN_1_COUNTRY", + "COMPANY_DISPLAY_NAME", + "BASE_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Possible return values are: * PAST_24_HOURS (The past 24 hours) * PAST_3_DAYS (The past 3 days) * PAST_WEEK (The past 7 days) * PAST_MONTH (The past 30 days) * PAST_YEAR (The past 365 days)", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Company display name.", + "Base compensation unit." + ], + "type": "string" + }, + "values": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.", + "type": "object" + } + }, + "type": "object" + }, + "HistogramResults": { + "description": "Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest.", + "id": "HistogramResults", + "properties": { + "compensationHistogramResults": { + "description": "Specifies compensation field-based histogram results that match HistogramFacets.compensation_histogram_requests.", + "items": { + "$ref": "CompensationHistogramResult" + }, + "type": "array" + }, + "customAttributeHistogramResults": { + "description": "Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets.", + "items": { + "$ref": "CustomAttributeHistogramResult" + }, + "type": "array" + }, + "simpleHistogramResults": { + "description": "Specifies histogram results that matches HistogramFacets.simple_histogram_facets.", + "items": { + "$ref": "HistogramResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "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.", + "id": "Job", + "properties": { + "addresses": { + "description": "Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "applicationInfo": { + "$ref": "ApplicationInfo", + "description": "Required. At least one field within ApplicationInfo must be specified. Job application information." + }, + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "type": "string" + }, + "companyName": { + "description": "Required. The resource name of the company listing the job, such as \"projects/api-test-project/companies/foo\".", + "type": "string" + }, + "compensationInfo": { + "$ref": "CompensationInfo", + "description": "Optional. Job compensation information." + }, + "customAttributes": { + "additionalProperties": { + "$ref": "CustomAttribute" + }, + "description": "Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", + "type": "object" + }, + "degreeTypes": { + "description": "Optional. The desired education degrees for the job, such as Bachelors, Masters.", + "items": { + "enum": [ + "DEGREE_TYPE_UNSPECIFIED", + "PRIMARY_EDUCATION", + "LOWER_SECONDARY_EDUCATION", + "UPPER_SECONDARY_EDUCATION", + "ADULT_REMEDIAL_EDUCATION", + "ASSOCIATES_OR_EQUIVALENT", + "BACHELORS_OR_EQUIVALENT", + "MASTERS_OR_EQUIVALENT", + "DOCTORAL_OR_EQUIVALENT" + ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "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", + "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; 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.", + "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.", + "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.", + "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; 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." + ], + "type": "string" + }, + "type": "array" + }, + "department": { + "description": "Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", + "type": "string" + }, + "derivedInfo": { + "$ref": "JobDerivedInfo", + "description": "Output only. Derived details about the job posting." + }, + "description": { + "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, 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": "string" + }, + "employmentTypes": { + "description": "Optional. The employment type(s) of a job, for example, full time or part time.", + "items": { + "enum": [ + "EMPLOYMENT_TYPE_UNSPECIFIED", + "FULL_TIME", + "PART_TIME", + "CONTRACTOR", + "CONTRACT_TO_HIRE", + "TEMPORARY", + "INTERN", + "VOLUNTEER", + "PER_DIEM", + "FLY_IN_FLY_OUT", + "OTHER_EMPLOYMENT_TYPE" + ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], + "type": "string" + }, + "type": "array" + }, + "incentives": { + "description": "Optional. 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": "string" + }, + "jobBenefits": { + "description": "Optional. The benefits included with the job.", + "items": { + "enum": [ + "JOB_BENEFIT_UNSPECIFIED", + "CHILD_CARE", + "DENTAL", + "DOMESTIC_PARTNER", + "FLEXIBLE_HOURS", + "MEDICAL", + "LIFE_INSURANCE", + "PARENTAL_LEAVE", + "RETIREMENT_PLAN", + "SICK_DAYS", + "VACATION", + "VISION" + ], + "enumDescriptions": [ + "Default value if the type is not specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], + "type": "string" + }, + "type": "array" + }, + "jobEndTime": { + "description": "Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "jobLevel": { + "description": "Optional. The experience level associated with the job, such as \"Entry Level\".", + "enum": [ + "JOB_LEVEL_UNSPECIFIED", + "ENTRY_LEVEL", + "EXPERIENCED", + "MANAGER", + "DIRECTOR", + "EXECUTIVE" + ], + "enumDescriptions": [ + "The default value if the level is not specified.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", + "Entry- to mid-level managers responsible for managing a team of people.", + "Senior-level managers responsible for managing teams of managers.", + "Executive-level managers and above, including C-level positions." + ], + "type": "string" + }, + "jobStartTime": { + "description": "Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "languageCode": { + "description": "Optional. 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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", + "type": "string" + }, + "name": { + "description": "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}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", + "type": "string" + }, + "postingCreateTime": { + "description": "Output only. The timestamp when this job posting was created.", + "format": "google-datetime", + "type": "string" + }, + "postingExpireTime": { + "description": "Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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.", + "format": "google-datetime", + "type": "string" + }, + "postingPublishTime": { + "description": "Optional. 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.", + "format": "google-datetime", + "type": "string" + }, + "postingRegion": { + "description": "Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", + "enum": [ + "POSTING_REGION_UNSPECIFIED", + "ADMINISTRATIVE_AREA", + "NATION", + "TELECOMMUTE" + ], + "enumDescriptions": [ + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if 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.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "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." + ], + "type": "string" + }, + "postingUpdateTime": { + "description": "Output only. The timestamp when this job posting was last updated.", + "format": "google-datetime", + "type": "string" + }, + "processingOptions": { + "$ref": "ProcessingOptions", "description": "Optional. Options for job processing." }, "promotionValue": { - "description": "Optional. A promotion value of the job, as determined by the client.\nThe value determines the sort order of the jobs returned when searching for\njobs using the featured jobs search call, with higher promotional values\nbeing returned first and ties being resolved by relevance sort. Only the\njobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.\n\nDefault value is 0, and negative values are treated as 0.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "qualifications": { - "description": "Optional. A description of the qualifications required to perform the\njob. The use of this field is recommended\nas an alternative to using the more general description field.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. 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 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": "string" }, "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, assigned by the\nclient to identify a job. This field is intended to be used by clients\nfor client identification and tracking of postings. A job is not allowed\nto be created if there is another job with the same [company_name],\nlanguage_code and requisition_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255.", "type": "string" }, "responsibilities": { - "description": "Optional. A description of job responsibilities. The use of this field is\nrecommended as an alternative to using the more general description\nfield.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" }, "title": { - "description": "Required. The title of the job, such as \"Software Engineer\"\n\nThe maximum number of allowed characters is 500.", + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", "type": "string" }, "visibility": { - "description": "Deprecated. The job is only visible to the owner.\n\nThe visibility of the job.\n\nDefaults to Visibility.ACCOUNT_ONLY if not specified.", + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", "enum": [ "VISIBILITY_UNSPECIFIED", "ACCOUNT_ONLY", @@ -1723,8 +2460,8 @@ "enumDescriptions": [ "Default value.", "The resource is only visible to the GCP account who owns it.", - "The resource is visible to the owner and may be visible to other\napplications and processes at Google.", - "The resource is visible to the owner and may be visible to all other API\nclients." + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." ], "type": "string" } @@ -1732,44 +2469,11 @@ "type": "object" }, "JobDerivedInfo": { - "description": "Output only.\n\nDerived details about the job posting.", + "description": "Output only. Derived details about the job posting.", "id": "JobDerivedInfo", "properties": { "jobCategories": { "description": "Job categories derived from Job.title and Job.description.", - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -1804,12 +2508,45 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "locations": { - "description": "Structured locations of the job, resolved from Job.addresses.\n\nlocations are exactly matched to Job.addresses in the same\norder.", + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", "items": { "$ref": "Location" }, @@ -1819,11 +2556,11 @@ "type": "object" }, "JobEvent": { - "description": "An event issued when a job seeker interacts with the application that\nimplements Cloud Talent Solution.", + "description": "An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.", "id": "JobEvent", "properties": { "jobs": { - "description": "Required. The job name(s) associated with this event.\nFor example, if this is an impression event,\nthis field contains the identifiers of all jobs shown to the job seeker.\nIf this was a view event, this field contains the\nidentifier of the viewed job.", + "description": "Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job.", "items": { "type": "string" }, @@ -1852,22 +2589,22 @@ ], "enumDescriptions": [ "The event is unspecified by other provided values.", - "The job seeker or other entity interacting with the service has\nhad a job rendered in their view, such as in a list of search results in\na compressed or clipped format. This event is typically associated with\nthe viewing of a jobs list on a single page by a job seeker.", - "The job seeker, or other entity interacting with the service, has\nviewed the details of a job, including the full description. This\nevent doesn't apply to the viewing a snippet of a job appearing as a\npart of the job search results. Viewing a snippet is associated with an\nimpression).", - "The job seeker or other entity interacting with the service\nperformed an action to view a job and was redirected to a different\nwebsite for job.", - "The job seeker or other entity interacting with the service\nbegan the process or demonstrated the intention of applying for a job.", - "The job seeker or other entity interacting with the service\nsubmitted an application for a job.", - "The job seeker or other entity interacting with the service\nsubmitted an application for a job with a single click without\nentering information. If a job seeker performs this action, send only\nthis event to the service. Do not also send\nJobEventType.APPLICATION_START or JobEventType.APPLICATION_FINISH\nevents.", - "The job seeker or other entity interacting with the service\nperformed an action to apply to a job and was redirected to a different\nwebsite to complete the application.", - "The job seeker or other entity interacting with the service began the\nprocess or demonstrated the intention of applying for a job from the\nsearch results page without viewing the details of the job posting.\nIf sending this event, JobEventType.VIEW event shouldn't be sent.", - "The job seeker, or other entity interacting with the service, performs an\naction with a single click from the search results page to apply to a job\n(without viewing the details of the job posting), and is redirected\nto a different website to complete the application. If a candidate\nperforms this action, send only this event to the service. Do not also\nsend JobEventType.APPLICATION_START,\nJobEventType.APPLICATION_FINISH or JobEventType.VIEW events.", - "This event should be used when a company submits an application\non behalf of a job seeker. This event is intended for use by staffing\nagencies attempting to place candidates.", - "The job seeker or other entity interacting with the service demonstrated\nan interest in a job by bookmarking or saving it.", - "The job seeker or other entity interacting with the service was\nsent a notification, such as an email alert or device notification,\ncontaining one or more jobs listings generated by the service.", - "The job seeker or other entity interacting with the service was\nemployed by the hiring entity (employer). Send this event\nonly if the job seeker was hired through an application that was\ninitiated by a search conducted through the Cloud Talent Solution\nservice.", - "A recruiter or staffing agency submitted an application on behalf of the\ncandidate after interacting with the service to identify a suitable job\nposting.", - "The entity interacting with the service (for example, the job seeker),\nwas granted an initial interview by the hiring entity (employer). This\nevent should only be sent if the job seeker was granted an interview as\npart of an application that was initiated by a search conducted through /\nrecommendation provided by the Cloud Talent Solution service.", - "The job seeker or other entity interacting with the service showed\nno interest in the job." + "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.", + "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).", + "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.", + "The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.", + "The job seeker or other entity interacting with the service submitted an application for a job.", + "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 or JobEventType.APPLICATION_FINISH events.", + "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.", + "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.", + "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, JobEventType.APPLICATION_FINISH or JobEventType.VIEW events.", + "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.", + "The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.", + "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.", + "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.", + "A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.", + "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.", + "The job seeker or other entity interacting with the service showed no interest in the job." ], "type": "string" } @@ -1875,22 +2612,22 @@ "type": "object" }, "JobQuery": { - "description": "Input only.\n\nThe query required to perform a search query.", + "description": "Input only. The query required to perform a search query.", "id": "JobQuery", "properties": { "commuteFilter": { "$ref": "CommuteFilter", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (for\n example, driving or public transit). Note: This only works with COMMUTE\n MODE. When specified, [JobQuery.location_filters] is\n ignored.\n\n Currently we don't support sorting by commute time." + "description": "Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time." }, "companyDisplayNames": { - "description": "Optional. This filter specifies the exact company display\nname of the jobs to search against.\n\nIf a value isn't specified, jobs within the search results are\nassociated with any company.\n\nIf multiple values are specified, jobs within the search results may be\nassociated with any of the specified companies.\n\nAt most 20 company display name filters are allowed.", + "description": "Optional. This filter specifies the exact company display name of the jobs to search against. 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.", "items": { "type": "string" }, "type": "array" }, "companyNames": { - "description": "Optional. This filter specifies the company entities to search against.\n\nIf a value isn't specified, jobs are searched for against all\ncompanies.\n\nIf multiple values are specified, jobs are searched against the\ncompanies specified.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".\n\nAt most 20 company filters are allowed.", + "description": "Optional. 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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\". At most 20 company filters are allowed.", "items": { "type": "string" }, @@ -1898,31 +2635,18 @@ }, "compensationFilter": { "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to\nJob.compensation_info. For example, if the filter is specified\nas \"Hourly job with per-hour compensation > $15\", only jobs meeting\nthese criteria are searched. If a filter isn't defined, all open jobs\nare searched." + "description": "Optional. This search filter is applied only to 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." }, "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the\nJob.custom_attributes marked as `filterable`.\n\nThe syntax for this expression is a subset of SQL syntax.\n\nSupported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the\nleft of the operator is a custom field key and the right of the operator\nis a number or a quoted string. You must escape backslash (\\\\) and\nquote (\\\") characters.\n\nSupported functions are `LOWER([field_name])` to\nperform a case insensitive match and `EMPTY([field_name])` to filter on the\nexistence of a key.\n\nBoolean expressions (AND/OR/NOT) are supported up to 3 levels of\nnesting (for example, \"((A AND B AND C) OR NOT D) AND E\"), a maximum of 100\ncomparisons or functions are allowed in the expression. The expression\nmust be < 6000 bytes in length.\n\nSample Query:\n`(LOWER(driving_license)=\"class \\\"a\\\"\" OR EMPTY(driving_license)) AND\ndriving_years > 10`", + "description": "Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)=\"class \\\"a\\\"\" OR EMPTY(driving_license)) AND driving_years > 10`", "type": "string" }, "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the\nservice attempts to correct a misspelled query,\nfor example, \"enginee\" is corrected to \"engineer\".\n\nDefaults to false: a spell check is performed.", + "description": "Optional. 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": "boolean" }, "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to\nsearch against, such as EmploymentType.FULL_TIME.\n\nIf a value is not specified, jobs in the search results includes any\nemployment type.\n\nIf multiple values are specified, jobs in the search results include\nany of the specified employment types.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a contracted position with the understanding\nthat it's converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job\nseekers to obtain on-the-job training, typically offered as a summer\nposition.", - "The is an opportunity for an individual to volunteer, where there's no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -1937,45 +2661,25 @@ "FLY_IN_FLY_OUT", "OTHER_EMPLOYMENT_TYPE" ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "jobCategories": { - "description": "Optional. The category filter specifies the categories of jobs to search against.\nSee Category for more information.\n\nIf a value is not specified, jobs from any category are searched against.\n\nIf multiple values are specified, jobs from any of the specified\ncategories are searched against.", - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], + "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -2010,19 +2714,52 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against,\nfor example, \"en-US\".\n\nIf a value isn't specified, the search results can contain jobs in any\nlocale.\n\n\nLanguage codes should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nAt most 10 language code filters are allowed.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", "items": { "type": "string" }, "type": "array" }, "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to\nsearch against. See LocationFilter for more information.\n\nIf a location value isn't specified, jobs fitting the other search\ncriteria are retrieved regardless of where they're located.\n\nIf multiple values are specified, jobs are retrieved from any of the\nspecified locations. If different values are specified for the\nLocationFilter.distance_in_miles parameter, the maximum provided\ndistance is used for all locations.\n\nAt most 5 location filters are allowed.", + "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", "items": { "$ref": "LocationFilter" }, @@ -2030,21 +2767,21 @@ }, "publishTimeRange": { "$ref": "TimestampRange", - "description": "Optional. Jobs published within a range specified by this filter are searched\nagainst." + "description": "Optional. Jobs published within a range specified by this filter are searched against." }, "query": { - "description": "Optional. The query string that matches against the job title, description, and\nlocation fields.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.", "type": "string" }, "queryLanguageCode": { - "description": "The language code of query. For example, \"en-US\". This field helps to\nbetter interpret the query.\n\nIf a value isn't specified, the query language code is automatically\ndetected, which may not be accurate.\n\nLanguage code should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "description": "The language code of 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](https://tools.ietf.org/html/bcp47).", "type": "string" } }, "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -2061,7 +2798,7 @@ "type": "object" }, "ListCompaniesResponse": { - "description": "Output only.\n\nThe List companies response object.", + "description": "Output only. The List companies response object.", "id": "ListCompaniesResponse", "properties": { "companies": { @@ -2073,7 +2810,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2083,11 +2820,11 @@ "type": "object" }, "ListJobsResponse": { - "description": "Output only.\n\nList jobs response.", + "description": "Output only. List jobs response.", "id": "ListJobsResponse", "properties": { "jobs": { - "description": "The Jobs for a given company.\n\nThe maximum number of items returned is based on the limit field\nprovided in the request.", + "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", "items": { "$ref": "Job" }, @@ -2095,7 +2832,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2105,7 +2842,7 @@ "type": "object" }, "Location": { - "description": "Output only.\n\nA resource that represents a location with full geographic information.", + "description": "Output only. A resource that represents a location with full geographic information.", "id": "Location", "properties": { "latLng": { @@ -2113,7 +2850,7 @@ "description": "An object representing a latitude/longitude pair." }, "locationType": { - "description": "The type of a location, which corresponds to the address lines field of\nPostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of\nLocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of\nLocationType#LOCALITY.", + "description": "The type of a location, which corresponds to the address lines field of PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType#LOCALITY.", "enum": [ "LOCATION_TYPE_UNSPECIFIED", "COUNTRY", @@ -2134,7 +2871,7 @@ "A county or equivalent level location.", "A city or equivalent level location.", "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough,\nward, or arrondissement. Sublocalities are usually recognized by a local\npolitical authority. For example, Manhattan and Brooklyn are recognized\nas boroughs by the City of New York, and are therefore modeled as\nsublocalities.", + "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.", "A district or equivalent level location.", "A smaller district or equivalent level display.", "A neighborhood level location.", @@ -2144,10 +2881,10 @@ }, "postalAddress": { "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information,\nsuch as postal delivery and payments addresses. Given a postal address,\na postal service can deliver items to a premises, P.O. Box, or other\ndelivery location." + "description": "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." }, "radiusInMiles": { - "description": "Radius in miles of the job location. This value is derived from the\nlocation bounding box in which a circle with the specified radius\ncentered from LatLng covers the area associated with the job location.\nFor example, currently, \"Mountain View, CA, USA\" has a radius of\n6.17 miles.", + "description": "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 LatLng covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", "format": "double", "type": "number" } @@ -2155,7 +2892,7 @@ "type": "object" }, "LocationFilter": { - "description": "Input only.\n\nGeographic region of the search.", + "description": "Input only. Geographic region of the search.", "id": "LocationFilter", "properties": { "address": { @@ -2163,20 +2900,20 @@ "type": "string" }, "distanceInMiles": { - "description": "Optional. The distance_in_miles is applied when the location being searched for is\nidentified as a city or smaller. When the location being searched for is a\nstate or larger, this field is ignored.", + "description": "Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.", "format": "double", "type": "number" }, "latLng": { "$ref": "LatLng", - "description": "Optional. The latitude and longitude of the geographic center from which to\nsearch. This field's ignored if `address` is provided." + "description": "Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided." }, "regionCode": { - "description": "Optional. CLDR region code of the country/region of the address. This is used\nto address ambiguity of the user-input location, for example, \"Liverpool\"\nagainst \"Liverpool, NY, US\" or \"Liverpool, UK\".\n\nSet this field if all the jobs to search against are from a same region,\nor jobs are world-wide, but the job seeker is from a specific region.\n\nSee http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, \"Liverpool\" against \"Liverpool, NY, US\" or \"Liverpool, UK\". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "telecommutePreference": { - "description": "Optional. Allows the client to return jobs without a\nset location, specifically, telecommuting jobs (telecommuting is considered\nby the service as a special location.\nJob.posting_region indicates if a job permits telecommuting.\nIf this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,\ntelecommuting jobs are searched, and address and lat_lng are\nignored. If not set or set to\nTelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not\nsearched.\n\nThis filter can be used by itself to search exclusively for telecommuting\njobs, or it can be combined with another location\nfilter to search for a combination of job locations,\nsuch as \"Mountain View\" or \"telecommuting\" jobs. However, when used in\ncombination with other location filters, telecommuting jobs can be\ntreated as less relevant than other jobs in the search response.", + "description": "Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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.", "enum": [ "TELECOMMUTE_PREFERENCE_UNSPECIFIED", "TELECOMMUTE_EXCLUDED", @@ -2193,41 +2930,41 @@ "type": "object" }, "MatchingJob": { - "description": "Output only.\n\nJob entry with metadata inside SearchJobsResponse.", + "description": "Output only. Job entry with metadata inside SearchJobsResponse.", "id": "MatchingJob", "properties": { "commuteInfo": { "$ref": "CommuteInfo", - "description": "Commute information which is generated based on specified\n CommuteFilter." + "description": "Commute information which is generated based on specified CommuteFilter." }, "job": { "$ref": "Job", "description": "Job resource that matches the specified SearchJobsRequest." }, "jobSummary": { - "description": "A summary of the job with core information that's displayed on the search\nresults listing page.", + "description": "A summary of the job with core information that's displayed on the search results listing page.", "type": "string" }, "jobTitleSnippet": { - "description": "Contains snippets of text from the Job.job_title field most\nclosely matching a search query's keywords, if available. The matching\nquery keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.", "type": "string" }, "searchTextSnippet": { - "description": "Contains snippets of text from the Job.description and similar\nfields that most closely match a search query's keywords, if available.\nAll HTML tags in the original fields are stripped when returned in this\nfield, and matching query keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the 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": "string" } }, "type": "object" }, "MendelDebugInput": { - "description": "Message representing input to a Mendel server for debug forcing.\nSee go/mendel-debug-forcing for more details.\nNext ID: 2", + "description": "Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2", "id": "MendelDebugInput", "properties": { "namespacedDebugInput": { "additionalProperties": { "$ref": "NamespacedDebugInput" }, - "description": "When a request spans multiple servers, a MendelDebugInput may travel with\nthe request and take effect in all the servers. This field is a map of\nnamespaces to NamespacedMendelDebugInput protos. In a single server, up to\ntwo NamespacedMendelDebugInput protos are applied:\n1. NamespacedMendelDebugInput with the global namespace (key == \"\").\n2. NamespacedMendelDebugInput with the server's namespace.\nWhen both NamespacedMendelDebugInput protos are present, they are merged.\nSee go/mendel-debug-forcing for more details.", + "description": "When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == \"\"). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.", "type": "object" } }, @@ -2242,12 +2979,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } @@ -2259,21 +2996,21 @@ "id": "NamespacedDebugInput", "properties": { "absolutelyForcedExpNames": { - "description": "Set of experiment names to be absolutely forced.\nThese experiments will be forced without evaluating the conditions.", + "description": "Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExpTags": { - "description": "Set of experiment tags to be absolutely forced.\nThe experiments with these tags will be forced without evaluating the\nconditions.", + "description": "Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExps": { - "description": "Set of experiment ids to be absolutely forced.\nThese ids will be forced without evaluating the conditions.", + "description": "Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.", "items": { "format": "int32", "type": "integer" @@ -2281,21 +3018,21 @@ "type": "array" }, "conditionallyForcedExpNames": { - "description": "Set of experiment names to be conditionally forced.\nThese experiments will be forced only if their conditions and their\nparent domain's conditions are true.", + "description": "Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExpTags": { - "description": "Set of experiment tags to be conditionally forced.\nThe experiments with these tags will be forced only if their conditions\nand their parent domain's conditions are true.", + "description": "Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExps": { - "description": "Set of experiment ids to be conditionally forced.\nThese ids will be forced only if their conditions and their parent\ndomain's conditions are true.", + "description": "Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.", "items": { "format": "int32", "type": "integer" @@ -2303,25 +3040,25 @@ "type": "array" }, "disableAutomaticEnrollmentSelection": { - "description": "If true, disable automatic enrollment selection (at all diversion\npoints). Automatic enrollment selection means experiment selection\nprocess based on the experiment's automatic enrollment condition. This\ndoes not disable selection of forced experiments.", + "description": "If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.", "type": "boolean" }, "disableExpNames": { - "description": "Set of experiment names to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If a name corresponds to a domain, the domain\nitself and all descendant experiments and domains are disabled together.", + "description": "Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExpTags": { - "description": "Set of experiment tags to be disabled. All experiments that are tagged\nwith one or more of these tags are disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together.", + "description": "Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExps": { - "description": "Set of experiment ids to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If an ID corresponds to a domain, the domain itself\nand all descendant experiments and domains are disabled together.", + "description": "Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "format": "int32", "type": "integer" @@ -2329,36 +3066,36 @@ "type": "array" }, "disableManualEnrollmentSelection": { - "description": "If true, disable manual enrollment selection (at all diversion points).\nManual enrollment selection means experiment selection process based on\nthe request's manual enrollment states (a.k.a. opt-in experiments).\nThis does not disable selection of forced experiments.", + "description": "If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.", "type": "boolean" }, "disableOrganicSelection": { - "description": "If true, disable organic experiment selection (at all diversion points).\nOrganic selection means experiment selection process based on traffic\nallocation and diversion condition evaluation.\nThis does not disable selection of forced experiments.\n\nThis is useful in cases when it is not known whether experiment selection\nbehavior is responsible for a error or breakage. Disabling organic\nselection may help to isolate the cause of a given problem.", + "description": "If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.", "type": "boolean" }, "forcedFlags": { "additionalProperties": { "type": "string" }, - "description": "Flags to force in a particular experiment state.\nMap from flag name to flag value.", + "description": "Flags to force in a particular experiment state. Map from flag name to flag value.", "type": "object" }, "forcedRollouts": { "additionalProperties": { "type": "boolean" }, - "description": "Rollouts to force in a particular experiment state.\nMap from rollout name to rollout value.", + "description": "Rollouts to force in a particular experiment state. Map from rollout name to rollout value.", "type": "object" } }, "type": "object" }, "NumericBucketingOption": { - "description": "Input only.\n\nUse this field to specify bucketing option for the histogram search response.", + "description": "Input only. Use this field to specify bucketing option for the histogram search response.", "id": "NumericBucketingOption", "properties": { "bucketBounds": { - "description": "Required. Two adjacent values form a histogram bucket. Values should be in\nascending order. For example, if [5, 10, 15] are provided, four buckets are\ncreated: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20\n[buckets_bound is supported.", + "description": "Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported.", "items": { "format": "double", "type": "number" @@ -2366,30 +3103,30 @@ "type": "array" }, "requiresMinMax": { - "description": "Optional. If set to true, the histogram result includes minimum/maximum\nvalue of the numeric field.", + "description": "Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.", "type": "boolean" } }, "type": "object" }, "NumericBucketingResult": { - "description": "Output only.\n\nCustom numeric bucketing result.", + "description": "Output only. Custom numeric bucketing result.", "id": "NumericBucketingResult", "properties": { "counts": { - "description": "Count within each bucket. Its size is the length of\nNumericBucketingOption.bucket_bounds plus 1.", + "description": "Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.", "items": { "$ref": "BucketizedCount" }, "type": "array" }, "maxValue": { - "description": "Stores the maximum value of the numeric field. Is populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" }, "minValue": { - "description": "Stores the minimum value of the numeric field. Will be populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" } @@ -2397,26 +3134,26 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses.\nGiven a postal address, a postal service can deliver items to a premise, P.O.\nBox or similar.\nIt is not intended to model geographical locations (roads, towns,\nmountains).\n\nIn typical usage an address would be created via user input or from importing\nexisting data, depending on the type of process.\n\nAdvice on address input / editing:\n - Use an i18n-ready address widget such as\n https://github.com/google/libaddressinput)\n- Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\nFor more guidance on how to use this schema, please see:\nhttps://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address.\n\nBecause values in address_lines do not have type information and may\nsometimes contain multiple values in a single field (e.g.\n\"Austin, TX\"), it is important that the line order is clear. The order of\naddress lines should be \"envelope order\" for the country/region of the\naddress. In places where this can vary (e.g. Japan), address_language is\nused to make it explicit (e.g. \"ja\" for large-to-small ordering and\n\"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\nan address can be selected based on the language.\n\nThe minimum permitted structural representation of an address consists\nof a region_code with all remaining information placed in the\naddress_lines. It would be possible to format such an address very\napproximately without geocoding, but no semantic reasoning could be\nmade about any of the address components until it was at least\npartially resolved.\n\nCreating an address only containing a region_code and address_lines, and\nthen geocoding is the recommended way to handle completely unstructured\naddresses (as opposed to guessing which parts of the address should be\nlocalities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal\naddresses of a country or region.\nFor example, this can be a state, a province, an oblast, or a prefecture.\nSpecifically, for Spain this is the province and not the autonomous\ncommunity (e.g. \"Barcelona\" and not \"Catalonia\").\nMany countries don't use an administrative area in postal addresses. E.g.\nin Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", "type": "string" }, "languageCode": { - "description": "Optional. BCP-47 language code of the contents of this address (if\nknown). This is often the UI language of the input form or is expected\nto match one of the languages used in the address' country/region, or their\ntransliterated equivalents.\nThis can affect formatting in certain countries, but is not critical\nto the correctness of the data and will never affect any validation or\nother non-formatting related operations.\n\nIf this value is not known, it should be omitted (rather than specifying a\npossibly incorrect default).\n\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address.\nExamples: US city, IT comune, UK post town.\nIn regions of the world where localities are not well defined or do not fit\ninto this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", "type": "string" }, "organization": { @@ -2424,46 +3161,46 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require\npostal codes to be present, but where they are used, they may trigger\nadditional validation with other parts of the address (e.g. state/zip\nvalidation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", "type": "string" }, "recipients": { - "description": "Optional. The recipient at the address.\nThis field may, under certain circumstances, contain multiline information.\nFor example, it might contain \"care of\" information.", + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", "items": { "type": "string" }, "type": "array" }, "regionCode": { - "description": "Required. CLDR region code of the country/region of the address. This\nis never inferred and it is up to the user to ensure the value is\ncorrect. See http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "revision": { - "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is\nthe latest revision.\n\nAll new revisions **must** be backward compatible with old revisions.", + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", "format": "int32", "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used\nin most regions. Where it is used, the value is either a string like\n\"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\nalone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n(Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address.\nFor example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", "type": "string" } }, "type": "object" }, "ProcessingOptions": { - "description": "Input only.\n\nOptions for job processing.", + "description": "Input only. Options for job processing.", "id": "ProcessingOptions", "properties": { "disableStreetAddressResolution": { - "description": "Optional. If set to `true`, the service does not attempt to resolve a\nmore precise address for the job.", + "description": "Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", "type": "boolean" }, "htmlSanitization": { - "description": "Optional. Option for job HTML content sanitization. Applied fields are:\n\n* description\n* applicationInfo.instruction\n* incentives\n* qualifications\n* responsibilities\n\nHTML tags in these fields may be stripped if sanitiazation is not\ndisabled.\n\nDefaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", + "description": "Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", "enum": [ "HTML_SANITIZATION_UNSPECIFIED", "HTML_SANITIZATION_DISABLED", @@ -2472,7 +3209,7 @@ "enumDescriptions": [ "Default value.", "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and\nunordered list markup tags." + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." ], "type": "string" } @@ -2480,63 +3217,63 @@ "type": "object" }, "RequestMetadata": { - "description": "Input only.\n\nMeta information related to the job searcher or entity\nconducting the job search. This information is used to improve the\nperformance of the service.", + "description": "Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.", "id": "RequestMetadata", "properties": { "deviceInfo": { "$ref": "DeviceInfo", - "description": "Optional. The type of device used by the job seeker at the time of the call to the\nservice." + "description": "Optional. The type of device used by the job seeker at the time of the call to the service." }, "domain": { - "description": "Required. The client-defined scope or source of the service call, which typically\nis the domain on\nwhich the service has been implemented and is currently being run.\n\nFor example, if the service is being run by client Foo, Inc., on\njob board www.foo.com and career site www.bar.com, then this field is\nset to \"foo.com\" for use on the job board, and \"bar.com\" for use on the\ncareer site.\n\nIf this field isn't available for some reason, send \"UNKNOWN\".\nAny improvements to the model for a particular tenant site rely on this\nfield being set correctly to a domain.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field isn't available for some reason, send \"UNKNOWN\". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255.", "type": "string" }, "sessionId": { - "description": "Required. A unique session identification string. A session is defined as the\nduration of an end user's interaction with the service over a certain\nperiod.\nObfuscate this field for privacy concerns before\nproviding it to the service.\n\nIf this field is not available for some reason, send \"UNKNOWN\". Note\nthat any improvements to the model for a particular tenant\nsite, rely on this field being set correctly to some unique session_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field is not available for some reason, send \"UNKNOWN\". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255.", "type": "string" }, "userId": { - "description": "Required. A unique user identification string, as determined by the client.\nTo have the strongest positive impact on search quality\nmake sure the client-level is unique.\nObfuscate this field for privacy concerns before\nproviding it to the service.\n\nIf this field is not available for some reason, send \"UNKNOWN\". Note\nthat any improvements to the model for a particular tenant\nsite, rely on this field being set correctly to a unique user_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field is not available for some reason, send \"UNKNOWN\". 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": "string" } }, "type": "object" }, "ResponseMetadata": { - "description": "Output only.\n\nAdditional information returned to client, such as debugging information.", + "description": "Output only. Additional information returned to client, such as debugging information.", "id": "ResponseMetadata", "properties": { "requestId": { - "description": "A unique id associated with this call.\nThis id is logged for tracking purposes.", + "description": "A unique id associated with this call. This id is logged for tracking purposes.", "type": "string" } }, "type": "object" }, "SearchJobsRequest": { - "description": "Input only.\n\nThe Request body of the `SearchJobs` call.", + "description": "Input only. The Request body of the `SearchJobs` call.", "id": "SearchJobsRequest", "properties": { "disableKeywordMatch": { - "description": "Optional. Controls whether to disable exact keyword match on Job.job_title,\nJob.description, Job.company_display_name, Job.locations,\nJob.qualifications. When disable keyword match is turned off, a\nkeyword match returns jobs that do not match given category filters when\nthere are matching keywords. For example, the query \"program manager,\" a\nresult is returned even if the job posting has the title \"software\ndeveloper,\" which does not fall into \"program manager\" ontology, but does\nhave \"program manager\" appearing in its description.\n\nFor queries like \"cloud\" that does not contain title or\nlocation specific ontology, jobs with \"cloud\" keyword matches are returned\nregardless of this flag's value.\n\nPlease use Company.keyword_searchable_custom_fields or\nCompany.keyword_searchable_custom_attributes if company specific\nglobally matched custom field/attribute string values is needed. Enabling\nkeyword match improves recall of subsequent search requests.\n\nDefaults to false.", + "description": "Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query \"program manager,\" a result is returned even if the job posting has the title \"software developer,\" which does not fall into \"program manager\" ontology, but does have \"program manager\" appearing in its description. For queries like \"cloud\" that does not contain title or location specific ontology, jobs with \"cloud\" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.", "type": "boolean" }, "diversificationLevel": { - "description": "Optional. Controls whether highly similar jobs are returned next to each other in\nthe search results. Jobs are identified as highly similar based on\ntheir titles, job categories, and locations. Highly similar results are\nclustered so that only one representative job of the cluster is\ndisplayed to the job seeker higher up in the results, with the other jobs\nbeing displayed lower down in the results.\n\nDefaults to DiversificationLevel.SIMPLE if no value\nis specified.", + "description": "Optional. 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 if no value is specified.", "enum": [ "DIVERSIFICATION_LEVEL_UNSPECIFIED", "DISABLED", "SIMPLE" ], "enumDescriptions": [ - "The diversification level isn't specified. By default, jobs with this\nenum are ordered according to SIMPLE diversifying behavior.", - "Disables diversification. Jobs that would normally be pushed to the last\npage would not have their positions altered. This may result in highly\nsimilar jobs appearing in sequence in the search results.", - "Default diversifying behavior. The result list is ordered so that\nhighly similar results are pushed to the end of the last page of search\nresults." + "The diversification level isn't specified. By default, jobs with this enum are ordered according to SIMPLE diversifying behavior.", + "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.", + "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." ], "type": "string" }, "enableBroadening": { - "description": "Optional. Controls whether to broaden the search when it produces sparse results.\nBroadened queries append results to the end of the matching results\nlist.\n\nDefaults to false.", + "description": "Optional. 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": "boolean" }, "histogramFacets": { @@ -2548,7 +3285,7 @@ "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." }, "jobView": { - "description": "Optional. The desired job attributes returned for jobs in the\nsearch response. Defaults to JobView.SMALL if no value is specified.", + "description": "Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified.", "enum": [ "JOB_VIEW_UNSPECIFIED", "JOB_VIEW_ID_ONLY", @@ -2558,50 +3295,50 @@ ], "enumDescriptions": [ "Default value.", - "A ID only view of job, with following attributes:\nJob.name, Job.requisition_id, Job.language_code.", - "A minimal view of the job, with the following attributes:\nJob.name, Job.requisition_id, Job.title,\nJob.company_name, Job.DerivedInfo.locations, Job.language_code.", - "A small view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.title,\nJob.company_name, Job.DerivedInfo.locations, Job.visibility,\nJob.language_code, Job.description.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", "All available attributes are included in the search results." ], "type": "string" }, "offset": { - "description": "Optional. An integer that specifies the current offset (that is, starting result\nlocation, amongst the jobs deemed by the API as relevant) in search\nresults. This field is only considered if page_token is unset.\n\nThe maximum allowed value is 5000. Otherwise an error is thrown.\n\nFor example, 0 means to return results starting from the first matching\njob, and 10 means to return from the 11th job. This can be used for\npagination, (for example, pageSize = 10 and offset = 10 means to return\nfrom the second page).", + "description": "Optional. 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 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).", "format": "int32", "type": "integer" }, "orderBy": { - "description": "Optional. The criteria determining how search results are sorted. Default is\n\"relevance desc\".\n\nSupported options are:\n\n* `\"relevance desc\"`: By relevance descending, as determined by the API\nalgorithms. Relevance thresholding of query results is only available\nwith this ordering.\n* `\"posting_publish_time desc\"`: By Job.posting_publish_time\ndescending.\n* `\"posting_update_time desc\"`: By Job.posting_update_time\ndescending.\n* `\"title\"`: By Job.title ascending.\n* `\"title desc\"`: By Job.title descending.\n* `\"annualized_base_compensation\"`: By job's\nCompensationInfo.annualized_base_compensation_range ascending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_base_compensation desc\"`: By job's\nCompensationInfo.annualized_base_compensation_range descending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_total_compensation\"`: By job's\nCompensationInfo.annualized_total_compensation_range ascending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_total_compensation desc\"`: By job's\nCompensationInfo.annualized_total_compensation_range descending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.", + "description": "Optional. 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 descending. * `\"posting_update_time desc\"`: By Job.posting_update_time descending. * `\"title\"`: By Job.title ascending. * `\"title desc\"`: By Job.title descending. * `\"annualized_base_compensation\"`: By job's 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 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 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 descending. Jobs whose annualized base compensation is unspecified are put at the end of search results.", "type": "string" }, "pageSize": { - "description": "Optional. A limit on the number of jobs returned in the search results.\nIncreasing this value above the default value of 10 can increase search\nresponse time. The value can be between 1 and 100.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "pageToken": { - "description": "Optional. The token specifying the current offset within\nsearch results. See SearchJobsResponse.next_page_token for\nan explanation of how to obtain the next set of query results.", + "description": "Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.", "type": "string" }, "requestMetadata": { "$ref": "RequestMetadata", - "description": "Required. The meta information collected about the job searcher, used to improve the\nsearch quality of the service. The identifiers (such as `user_id`) are\nprovided by users, and must be unique and consistent." + "description": "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." }, "requirePreciseResultSize": { - "description": "Optional. Controls if the search job request requires the return of a precise\ncount of the first 300 results. Setting this to `true` ensures\nconsistency in the number of results per page. Best practice is to set this\nvalue to true if a client allows users to jump directly to a\nnon-sequential search results page.\n\nEnabling this flag may adversely impact performance.\n\nDefaults to false.", + "description": "This field is deprecated.", "type": "boolean" }, "searchMode": { - "description": "Optional. Mode of a search.\n\nDefaults to SearchMode.JOB_SEARCH.", + "description": "Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH.", "enum": [ "SEARCH_MODE_UNSPECIFIED", "JOB_SEARCH", "FEATURED_JOB_SEARCH" ], "enumDescriptions": [ - "The mode of the search method isn't specified. The default search\nbehavior is identical to JOB_SEARCH search behavior.", - "The job search matches against all jobs, and featured jobs\n(jobs with promotionValue > 0) are not specially handled.", - "The job search matches only against featured jobs (jobs with a\npromotionValue > 0). This method doesn't return any jobs having a\npromotionValue <= 0. The search results order is determined by the\npromotionValue (jobs with a higher promotionValue are returned higher up\nin the search results), with relevance being used as a tiebreaker." + "The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior.", + "The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.", + "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." ], "type": "string" } @@ -2609,25 +3346,25 @@ "type": "object" }, "SearchJobsResponse": { - "description": "Output only.\n\nResponse for SearchJob method.", + "description": "Output only. Response for SearchJob method.", "id": "SearchJobsResponse", "properties": { "broadenedQueryJobsCount": { - "description": "If query broadening is enabled, we may append additional results from the\nbroadened query. This number indicates how many of the jobs returned in the\njobs field are from the broadened query. These results are always at the\nend of the jobs list. In particular, a value of 0, or if the field isn't\nset, all the jobs in the jobs list are from the original\n(without broadening) query. If this field is non-zero, subsequent requests\nwith offset after this result set should contain all broadened results.", + "description": "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.", "format": "int32", "type": "integer" }, "estimatedTotalSize": { - "description": "An estimation of the number of jobs that match the specified query.\n\nThis number is not guaranteed to be accurate. For accurate results,\nsee enable_precise_result_size.", + "description": "An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size.", "format": "int32", "type": "integer" }, "histogramResults": { "$ref": "HistogramResults", - "description": "The histogram results that match specified\nSearchJobsRequest.histogram_facets." + "description": "The histogram results that match specified SearchJobsRequest.histogram_facets." }, "locationFilters": { - "description": "The location filters that the service applied to the specified query. If\nany filters are lat-lng based, the JobLocation.location_type is\nJobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", + "description": "The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", "items": { "$ref": "Location" }, @@ -2642,10 +3379,10 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { - "description": "The token that specifies the starting position of the next page of results.\nThis field is empty if there are no more results.", + "description": "The token that specifies the starting position of the next page of results. This field is empty if there are no more results.", "type": "string" }, "spellCorrection": { @@ -2653,7 +3390,7 @@ "description": "The spell checking result, and correction." }, "totalSize": { - "description": "The precise result count, which is available only if the client set\nenable_precise_result_size to `true`, or if the response\nis the last page of results. Otherwise, the value is `-1`.", + "description": "The precise result count with limit 100,000.", "format": "int32", "type": "integer" } @@ -2661,7 +3398,7 @@ "type": "object" }, "SpellingCorrection": { - "description": "Output only.\n\nSpell check result.", + "description": "Output only. Spell check result.", "id": "SpellingCorrection", "properties": { "corrected": { @@ -2675,12 +3412,39 @@ }, "type": "object" }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, "TimeOfDay": { - "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.", + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, @@ -2695,7 +3459,7 @@ "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } @@ -2720,7 +3484,7 @@ "type": "object" }, "UpdateCompanyRequest": { - "description": "Input only.\n\nRequest for updating a specified company.", + "description": "Input only. Request for updating a specified company.", "id": "UpdateCompanyRequest", "properties": { "company": { @@ -2728,7 +3492,7 @@ "description": "Required. The company resource to replace the current resource in the system." }, "updateMask": { - "description": "Optional but strongly recommended for the best service\nexperience.\n\nIf update_mask is provided, only the specified fields in\ncompany are updated. Otherwise all the fields are updated.\n\nA field mask to specify the company fields to be updated. Only\ntop level fields of Company are supported.", + "description": "Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported.", "format": "google-fieldmask", "type": "string" } @@ -2736,7 +3500,7 @@ "type": "object" }, "UpdateJobRequest": { - "description": "Input only.\n\nUpdate job request.", + "description": "Input only. Update job request.", "id": "UpdateJobRequest", "properties": { "job": { @@ -2744,7 +3508,7 @@ "description": "Required. The Job to be updated." }, "updateMask": { - "description": "Optional but strongly recommended to be provided for the best service\nexperience.\n\nIf update_mask is provided, only the specified fields in\njob are updated. Otherwise all the fields are updated.\n\nA field mask to restrict the fields that are updated. Only\ntop level fields of Job are supported.", + "description": "Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported.", "format": "google-fieldmask", "type": "string" } diff --git a/discovery/jobs-v3p1beta1.json b/discovery/jobs-v3p1beta1.json index 22a45b19aa..b95d750fc8 100644 --- a/discovery/jobs-v3p1beta1.json +++ b/discovery/jobs-v3p1beta1.json @@ -15,7 +15,7 @@ "baseUrl": "https://jobs.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Talent Solution", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.\n", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "fullyEncodeReservedExpansion": true, @@ -111,7 +111,7 @@ "projects": { "methods": { "complete": { - "description": "Completes the specified prefix with keyword suggestions.\nIntended for use by a job search auto-complete search box.", + "description": "Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.", "flatPath": "v3p1beta1/projects/{projectsId}:complete", "httpMethod": "GET", "id": "jobs.projects.complete", @@ -120,36 +120,36 @@ ], "parameters": { "companyName": { - "description": "Optional. If provided, restricts completion to specified company.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Optional. If provided, restricts completion to specified company. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "query", "type": "string" }, "languageCode": { - "description": "Deprecated. Use language_codes instead.\n\nOptional.\n\nThe language of the query. This is\nthe BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nFor CompletionType.JOB_TITLE type, only open jobs with the same\nlanguage_code are returned.\n\nFor CompletionType.COMPANY_NAME type,\nonly companies having open jobs with the same language_code are\nreturned.\n\nFor CompletionType.COMBINED type, only open jobs with the same\nlanguage_code or companies having open jobs with the same\nlanguage_code are returned.\n\nThe maximum number of allowed characters is 255.", + "description": "Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.", "location": "query", "type": "string" }, "languageCodes": { - "description": "Optional. The list of languages of the query. This is\nthe BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nFor CompletionType.JOB_TITLE type, only open jobs with the same\nlanguage_codes are returned.\n\nFor CompletionType.COMPANY_NAME type,\nonly companies having open jobs with the same language_codes are\nreturned.\n\nFor CompletionType.COMBINED type, only open jobs with the same\nlanguage_codes or companies having open jobs with the same\nlanguage_codes are returned.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255.", "location": "query", "repeated": true, "type": "string" }, "name": { - "description": "Required. Resource name of project the completion is performed within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of project the completion is performed within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Required. Completion result count.\n\nThe maximum allowed page size is 10.", + "description": "Required. Completion result count. The maximum allowed page size is 10.", "format": "int32", "location": "query", "type": "integer" }, "query": { - "description": "Required. The query used to generate suggestions.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. The query used to generate suggestions. The maximum number of allowed characters is 255.", "location": "query", "type": "string" }, @@ -160,6 +160,11 @@ "TENANT", "PUBLIC" ], + "enumDescriptions": [ + "Default value.", + "Suggestions are based only on the data provided by the client.", + "Suggestions are based on all jobs data in the system that's visible to the client" + ], "location": "query", "type": "string" }, @@ -171,6 +176,12 @@ "COMPANY_NAME", "COMBINED" ], + "enumDescriptions": [ + "Default value.", + "Only suggest job titles.", + "Only suggest company names.", + "Suggest both job titles and company names." + ], "location": "query", "type": "string" } @@ -189,7 +200,7 @@ "clientEvents": { "methods": { "create": { - "description": "Report events issued when end user interacts with customer's application\nthat uses Cloud Talent Solution. You may inspect the created events in\n[self service\ntools](https://console.cloud.google.com/talent-solution/overview).\n[Learn\nmore](https://cloud.google.com/talent-solution/docs/management-tools)\nabout self service tools.", + "description": "Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.", "flatPath": "v3p1beta1/projects/{projectsId}/clientEvents", "httpMethod": "POST", "id": "jobs.projects.clientEvents.create", @@ -231,7 +242,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the project under which the company is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of the project under which the company is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -251,7 +262,7 @@ ] }, "delete": { - "description": "Deletes specified company.\nPrerequisite: The company has no jobs associated with it.", + "description": "Deletes specified company. Prerequisite: The company has no jobs associated with it.", "flatPath": "v3p1beta1/projects/{projectsId}/companies/{companiesId}", "httpMethod": "DELETE", "id": "jobs.projects.companies.delete", @@ -260,7 +271,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the company to be deleted.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Required. The resource name of the company to be deleted. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -286,7 +297,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the company to be retrieved.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "Required. The resource name of the company to be retrieved. The format is \"projects/{project_id}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -312,7 +323,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. The maximum number of companies to be returned, at most 100.\nDefault is 100 if a non-positive number is provided.", + "description": "Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.", "format": "int32", "location": "query", "type": "integer" @@ -323,14 +334,14 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the project under which the company is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. Resource name of the project under which the company is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, "requireOpenJobs": { - "description": "Optional. Set to true if the companies requested must have open jobs.\n\nDefaults to false.\n\nIf true, at most page_size of companies are fetched, among which\nonly those with open jobs are returned.", + "description": "Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.", "location": "query", "type": "boolean" } @@ -345,7 +356,7 @@ ] }, "patch": { - "description": "Updates specified company. Company names can't be updated. To update a\ncompany name, delete the company and all jobs associated with it, and only\nthen re-create them.", + "description": "Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.", "flatPath": "v3p1beta1/projects/{projectsId}/companies/{companiesId}", "httpMethod": "PATCH", "id": "jobs.projects.companies.patch", @@ -354,7 +365,7 @@ ], "parameters": { "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "location": "path", "pattern": "^projects/[^/]+/companies/[^/]+$", "required": true, @@ -387,7 +398,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -407,7 +418,7 @@ ] }, "create": { - "description": "Creates a new job.\n\nTypically, the job becomes searchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs", "httpMethod": "POST", "id": "jobs.projects.jobs.create", @@ -416,7 +427,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -436,7 +447,7 @@ ] }, "delete": { - "description": "Deletes the specified job.\n\nTypically, the job becomes unsearchable within 10 seconds, but it may take\nup to 5 minutes.", + "description": "Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "DELETE", "id": "jobs.projects.jobs.delete", @@ -445,7 +456,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the job to be deleted.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".", + "description": "Required. The resource name of the job to be deleted. The format is \"projects/{project_id}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\".", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -462,7 +473,7 @@ ] }, "get": { - "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED\nwithin the last 90 days.", + "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "GET", "id": "jobs.projects.jobs.get", @@ -471,7 +482,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the job to retrieve.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".", + "description": "Required. The resource name of the job to retrieve. The format is \"projects/{project_id}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\".", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -497,12 +508,12 @@ ], "parameters": { "filter": { - "description": "Required. The filter string specifies the jobs to be enumerated.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Optional)\n\nSample Query:\n\n* companyName = \"projects/api-test-project/companies/123\"\n* companyName = \"projects/api-test-project/companies/123\" AND requisitionId\n= \"req-1\"", + "description": "Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = \"projects/api-test-project/companies/123\" * companyName = \"projects/api-test-project/companies/123\" AND requisitionId = \"req-1\"", "location": "query", "type": "string" }, "jobView": { - "description": "Optional. The desired job attributes returned for jobs in the\nsearch response. Defaults to JobView.JOB_VIEW_FULL if no value is\nspecified.", + "description": "Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.", "enum": [ "JOB_VIEW_UNSPECIFIED", "JOB_VIEW_ID_ONLY", @@ -510,11 +521,18 @@ "JOB_VIEW_SMALL", "JOB_VIEW_FULL" ], + "enumDescriptions": [ + "Default value.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", + "All available attributes are included in the search results." + ], "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results.\n\nIf job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed\npage size is 1000. Otherwise, the maximum allowed page size is 100.\n\nDefault is 100 if empty or a number < 1 is specified.", + "description": "Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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.", "format": "int32", "location": "query", "type": "integer" @@ -525,7 +543,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the project under which the job is created.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project under which the job is created. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -542,7 +560,7 @@ ] }, "patch": { - "description": "Updates specified job.\n\nTypically, updated contents become visible in search results within 10\nseconds, but it may take up to 5 minutes.", + "description": "Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs/{jobsId}", "httpMethod": "PATCH", "id": "jobs.projects.jobs.patch", @@ -551,7 +569,7 @@ ], "parameters": { "name": { - "description": "Required during job update.\n\nThe resource name for the job. This is generated by the service when a\njob is created.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".\n\nUse of this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "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}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "location": "path", "pattern": "^projects/[^/]+/jobs/[^/]+$", "required": true, @@ -571,7 +589,7 @@ ] }, "search": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs that the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs:search", "httpMethod": "POST", "id": "jobs.projects.jobs.search", @@ -580,7 +598,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project to search within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project to search within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -600,7 +618,7 @@ ] }, "searchForAlert": { - "description": "Searches for jobs using the provided SearchJobsRequest.\n\nThis API call is intended for the use case of targeting passive job\nseekers (for example, job seekers who have signed up to receive email\nalerts about potential job opportunities), and has different algorithmic\nadjustments that are targeted to passive job seekers.\n\nThis call constrains the visibility of jobs\npresent in the database, and only returns jobs the caller has\npermission to search against.", + "description": "Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.", "flatPath": "v3p1beta1/projects/{projectsId}/jobs:searchForAlert", "httpMethod": "POST", "id": "jobs.projects.jobs.searchForAlert", @@ -609,7 +627,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the project to search within.\n\nThe format is \"projects/{project_id}\", for example,\n\"projects/api-test-project\".", + "description": "Required. The resource name of the project to search within. The format is \"projects/{project_id}\", for example, \"projects/api-test-project\".", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -633,7 +651,7 @@ "operations": { "methods": { "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v3p1beta1/projects/{projectsId}/operations/{operationsId}", "httpMethod": "GET", "id": "jobs.projects.operations.get", @@ -663,7 +681,7 @@ } } }, - "revision": "20200505", + "revision": "20200929", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -671,18 +689,18 @@ "id": "ApplicationInfo", "properties": { "emails": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this field to specify email address(es) to which resumes or\napplications can be sent.\n\nThe maximum number of allowed characters for each entry is 255.", + "description": "Optional but at least one of uris, emails or instruction must be specified. 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.", "items": { "type": "string" }, "type": "array" }, "instruction": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this field to provide instructions, such as \"Mail your application\nto ...\", that a candidate can follow to apply for the job.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 3,000.", + "description": "Optional but at least one of uris, emails or instruction must be specified. 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": "string" }, "uris": { - "description": "Optional but at least one of uris,\nemails or instruction must be\nspecified.\n\nUse this URI field to direct an applicant to a website, for example to\nlink to an online application form.\n\nThe maximum number of allowed characters for each entry is 2,000.", + "description": "Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", "items": { "type": "string" }, @@ -692,11 +710,11 @@ "type": "object" }, "BatchDeleteJobsRequest": { - "description": "Input only.\n\nBatch delete jobs request.", + "description": "Input only. Batch delete jobs request.", "id": "BatchDeleteJobsRequest", "properties": { "filter": { - "description": "Required. The filter string specifies the jobs to be deleted.\n\nSupported operator: =, AND\n\nThe fields eligible for filtering are:\n\n* `companyName` (Required)\n* `requisitionId` (Required)\n\nSample Query: companyName = \"projects/api-test-project/companies/123\" AND\nrequisitionId = \"req-1\"", + "description": "Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = \"projects/api-test-project/companies/123\" AND requisitionId = \"req-1\"", "type": "string" } }, @@ -730,13 +748,13 @@ }, "range": { "$ref": "BucketRange", - "description": "Bucket range on which histogram was performed for the numeric field,\nthat is, the count represents number of jobs in this range." + "description": "Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range." } }, "type": "object" }, "ClientEvent": { - "description": "An event issued when an end user interacts with the application that\nimplements Cloud Talent Solution. Providing this information improves the\nquality of search and recommendation for the API clients, enabling the\nservice to perform optimally. The number of events sent must be consistent\nwith other calls, such as job searches, issued to the service by the client.", + "description": "An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of search and recommendation 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.", "id": "ClientEvent", "properties": { "createTime": { @@ -745,37 +763,37 @@ "type": "string" }, "eventId": { - "description": "Required. A unique identifier, generated by the client application. This `event_id`\nis used to establish the relationship between different events\n(see parent_event_id).", + "description": "Required. A unique identifier, generated by the client application. This `event_id` is used to establish the relationship between different events (see parent_event_id).", "type": "string" }, "extraInfo": { "additionalProperties": { "type": "string" }, - "description": "Optional. Extra information about this event. Used for storing information with no\nmatching field in event payload, for example, user application specific\ncontext or details.\n\nAt most 20 keys are supported. The maximum total size of all keys and\nvalues is 2 KB.", + "description": "Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB.", "type": "object" }, "jobEvent": { "$ref": "JobEvent", - "description": "A event issued when a job seeker interacts with the application that\nimplements Cloud Talent Solution." + "description": "A event issued when a job seeker interacts with the application that implements Cloud Talent Solution." }, "parentEventId": { - "description": "Optional. The event_id of an event that resulted in the current event. For example, a\nJob view event usually follows a parent\nimpression event: A job seeker first does a\nsearch where a list of jobs appears\n(impression). The job seeker then selects a\nresult and views the description of a particular job (Job\nview).", + "description": "Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job (Job view).", "type": "string" }, "requestId": { - "description": "Required. A unique ID generated in the API responses. It can be found in\nResponseMetadata.request_id.", + "description": "Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.", "type": "string" } }, "type": "object" }, "CommuteFilter": { - "description": "Input only.\n\nParameters needed for commute search.", + "description": "Input only. Parameters needed for commute search.", "id": "CommuteFilter", "properties": { "allowImpreciseAddresses": { - "description": "Optional. If true, jobs without \"precise\" addresses (street level addresses or GPS\ncoordinates) might also be returned. For city and coarser level addresses,\ntext matching is used. If this field is set to false or is not specified,\nonly jobs that include precise addresses are returned by Commute\nSearch.\n\nNote: If `allow_imprecise_addresses` is set to true, Commute Search is not\nable to calculate accurate commute times to jobs with city level and\ncoarser address information. Jobs with imprecise addresses will return a\n`travel_duration` time of 0 regardless of distance from the job seeker.", + "description": "Optional. If true, jobs without \"precise\" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker.", "type": "boolean" }, "commuteMethod": { @@ -790,7 +808,7 @@ "enumDescriptions": [ "Commute method is not specified.", "Commute time is calculated based on driving time.", - "Commute time is calculated based on public transit including bus, metro,\nsubway, etc.", + "Commute time is calculated based on public transit including bus, metro, subway, etc.", "Commute time is calculated based on walking time.", "Commute time is calculated based on biking time." ], @@ -798,7 +816,7 @@ }, "departureTime": { "$ref": "TimeOfDay", - "description": "Optional. The departure time used to calculate traffic impact, represented as\ngoogle.type.TimeOfDay in local time zone.\n\nCurrently traffic model is restricted to hour level resolution." + "description": "Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution." }, "roadTraffic": { "description": "Optional. Specifies the traffic density to use when calculating commute time.", @@ -816,10 +834,10 @@ }, "startCoordinates": { "$ref": "LatLng", - "description": "Required. The latitude and longitude of the location from which to calculate the\ncommute time." + "description": "Required. The latitude and longitude of the location from which to calculate the commute time." }, "travelDuration": { - "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s`\n(one hour). Format is `123s`.", + "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.", "format": "google-duration", "type": "string" } @@ -827,7 +845,7 @@ "type": "object" }, "CommuteInfo": { - "description": "Output only.\n\nCommute details related to this job.", + "description": "Output only. Commute details related to this job.", "id": "CommuteInfo", "properties": { "jobLocation": { @@ -835,7 +853,7 @@ "description": "Location used as the destination in the commute calculation." }, "travelDuration": { - "description": "The number of seconds required to travel to the job location from the\nquery location. A duration of 0 seconds indicates that the job is not\nreachable within the requested duration, but was returned as part of an\nexpanded query.", + "description": "The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.", "format": "google-duration", "type": "string" } @@ -843,11 +861,11 @@ "type": "object" }, "Company": { - "description": "A Company resource represents a company in the service. A company is the\nentity that owns job postings, that is, the hiring entity responsible for\nemploying applicants for the job position.", + "description": "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.", "id": "Company", "properties": { "careerSiteUri": { - "description": "Optional. The URI to employer's career site or careers page on the employer's web\nsite, for example, \"https://careers.google.com\".", + "description": "Optional. The URI to employer's career site or careers page on the employer's web site, for example, \"https://careers.google.com\".", "type": "string" }, "derivedInfo": { @@ -859,19 +877,19 @@ "type": "string" }, "eeoText": { - "description": "Optional. Equal Employment Opportunity legal disclaimer text to be\nassociated with all jobs, and typically to be displayed in all\nroles.\n\nThe maximum number of allowed characters is 500.", + "description": "Optional. 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": "string" }, "externalId": { - "description": "Required. Client side company identifier, used to uniquely identify the\ncompany.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.", "type": "string" }, "headquartersAddress": { - "description": "Optional. The street address of the company's main headquarters, which may be\ndifferent from the job location. The service attempts\nto geolocate the provided address, and populates a more specific\nlocation wherever possible in DerivedInfo.headquarters_location.", + "description": "Optional. 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.", "type": "string" }, "hiringAgency": { - "description": "Optional. Set to true if it is the hiring agency that post jobs for other\nemployers.\n\nDefaults to false if not provided.", + "description": "Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.", "type": "boolean" }, "imageUri": { @@ -879,14 +897,14 @@ "type": "string" }, "keywordSearchableJobCustomAttributes": { - "description": "Optional. A list of keys of filterable Job.custom_attributes, whose\ncorresponding `string_values` are used in keyword search. Jobs with\n`string_values` under these specified field keys are returned if any\nof the values matches the search keyword. Custom field values with\nparenthesis, brackets and special symbols won't be properly searchable,\nand those keyword queries need to be surrounded by quotes.", + "description": "Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes.", "items": { "type": "string" }, "type": "array" }, "name": { - "description": "Required during company update.\n\nThe resource name for a company. This is generated by the service when a\ncompany is created.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".", + "description": "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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\".", "type": "string" }, "size": { @@ -914,11 +932,11 @@ "type": "string" }, "suspended": { - "description": "Output only. Indicates whether a company is flagged to be suspended from\npublic availability by the service when job content appears suspicious,\nabusive, or spammy.", + "description": "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": "boolean" }, "websiteUri": { - "description": "Optional. The URI representing the company's primary web site or home page,\nfor example, \"https://www.google.com\".\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. 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": "string" } }, @@ -930,13 +948,13 @@ "properties": { "headquartersLocation": { "$ref": "Location", - "description": "A structured headquarters location of the company, resolved from\nCompany.hq_location if provided." + "description": "A structured headquarters location of the company, resolved from Company.hq_location if provided." } }, "type": "object" }, "CompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such\nas base pay, bonus, or other compensation type.\n\nAnnualization: One compensation entry can be annualized if\n- it contains valid amount or range.\n- and its expected_units_per_year is set or can be derived.\nIts annualized range is determined as (amount or range) times\nexpected_units_per_year.", + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", "id": "CompensationEntry", "properties": { "amount": { @@ -944,11 +962,11 @@ "description": "Optional. Compensation amount." }, "description": { - "description": "Optional. Compensation description. For example, could\nindicate equity terms or provide additional context to an estimated\nbonus.", + "description": "Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", "type": "string" }, "expectedUnitsPerYear": { - "description": "Optional. Expected number of units paid each year. If not specified, when\nJob.employment_types is FULLTIME, a default value is inferred\nbased on unit. Default values:\n- HOURLY: 2080\n- DAILY: 260\n- WEEKLY: 52\n- MONTHLY: 12\n- ANNUAL: 1", + "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", "format": "double", "type": "number" }, @@ -957,7 +975,7 @@ "description": "Optional. Compensation range." }, "type": { - "description": "Optional. Compensation type.\n\nDefault is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.", + "description": "Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED.", "enum": [ "COMPENSATION_TYPE_UNSPECIFIED", "BASE", @@ -971,7 +989,7 @@ ], "enumDescriptions": [ "Default value.", - "Base compensation: Refers to the fixed amount of money paid to an\nemployee by an employer in return for work performed. Base compensation\ndoes not include benefits, bonuses or any other potential compensation\nfrom an employer.", + "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.", "Signing bonus.", "Equity.", @@ -983,7 +1001,7 @@ "type": "string" }, "unit": { - "description": "Optional. Frequency of the specified amount.\n\nDefault is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", "HOURLY", @@ -1010,11 +1028,11 @@ "type": "object" }, "CompensationFilter": { - "description": "Input only.\n\nFilter on job compensation type and amount.", + "description": "Input only. Filter on job compensation type and amount.", "id": "CompensationFilter", "properties": { "includeJobsWithUnspecifiedCompensationRange": { - "description": "Optional. If set to true, jobs with unspecified compensation range fields are\nincluded.", + "description": "Optional. If set to true, jobs with unspecified compensation range fields are included.", "type": "boolean" }, "range": { @@ -1032,25 +1050,15 @@ ], "enumDescriptions": [ "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and\nonly if the job contains a base CompensationEntry and the base\nCompensationEntry's unit matches provided units.\nPopulate one or more units.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job\nis a match if and only if the job contains a base CompensationEntry, and\nthe base entry's unit matches provided compensation_units and amount\nor range overlaps with provided compensation_range.\n\nSee CompensationInfo.CompensationEntry for definition of\nbase compensation entry.\n\nSet exactly one units and populate range.", - "Filter by annualized base compensation amount and `base compensation\nentry's` unit. Populate range and zero or more units.", - "Filter by annualized total compensation amount and `base compensation\nentry's` unit . Populate range and zero or more units." + "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units. See CompensationInfo.CompensationEntry for definition of base compensation entry.", + "Filter by `base compensation entry's` unit 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 compensation_units and amount or range overlaps with provided compensation_range. See CompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one units and populate range.", + "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate range and zero or more units.", + "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate range and zero or more units." ], "type": "string" }, "units": { - "description": "Required. Specify desired `base compensation entry's`\nCompensationInfo.CompensationUnit.", - "enumDescriptions": [ - "Default value.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], + "description": "Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.", "items": { "enum": [ "COMPENSATION_UNIT_UNSPECIFIED", @@ -1062,6 +1070,16 @@ "ONE_TIME", "OTHER_COMPENSATION_UNIT" ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], "type": "string" }, "type": "array" @@ -1070,7 +1088,7 @@ "type": "object" }, "CompensationHistogramRequest": { - "description": "Input only.\n\nCompensation based histogram request.", + "description": "Input only. Compensation based histogram request.", "id": "CompensationHistogramRequest", "properties": { "bucketingOption": { @@ -1078,7 +1096,7 @@ "description": "Required. Numeric histogram options, like buckets, whether include min or max value." }, "type": { - "description": "Required. Type of the request, representing which field the histogramming should be\nperformed over. A single request can only specify one histogram of each\n`CompensationHistogramRequestType`.", + "description": "Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1087,9 +1105,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1097,7 +1115,7 @@ "type": "object" }, "CompensationHistogramResult": { - "description": "Output only.\n\nCompensation based histogram result.", + "description": "Output only. Compensation based histogram result.", "id": "CompensationHistogramResult", "properties": { "result": { @@ -1105,7 +1123,7 @@ "description": "Histogram result." }, "type": { - "description": "Type of the request, corresponding to\nCompensationHistogramRequest.type.", + "description": "Type of the request, corresponding to CompensationHistogramRequest.type.", "enum": [ "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", "BASE", @@ -1114,9 +1132,9 @@ ], "enumDescriptions": [ "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for\ndefinition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry\nfor definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry\nfor definition of annualized total compensation." + "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", + "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", + "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." ], "type": "string" } @@ -1129,14 +1147,14 @@ "properties": { "annualizedBaseCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized base compensation range. Computed as\nbase compensation entry's CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "annualizedTotalCompensationRange": { "$ref": "CompensationRange", - "description": "Output only. Annualized total compensation range. Computed as\nall compensation entries' CompensationEntry.compensation times\nCompensationEntry.expected_units_per_year.\n\nSee CompensationEntry for explanation on compensation annualization." + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." }, "entries": { - "description": "Optional. Job compensation information.\n\nAt most one entry can be of type\nCompensationInfo.CompensationType.BASE, which is\nreferred as ** base compensation entry ** for the job.", + "description": "Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", "items": { "$ref": "CompensationEntry" }, @@ -1151,17 +1169,17 @@ "properties": { "maxCompensation": { "$ref": "Money", - "description": "Optional. The maximum amount of compensation. If left empty, the value is set\nto a maximal compensation value and the currency code is set to\nmatch the currency code of\nmin_compensation." + "description": "Optional. 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 of min_compensation." }, "minCompensation": { "$ref": "Money", - "description": "Optional. The minimum amount of compensation. If left empty, the value is set\nto zero and the currency code is set to match the\ncurrency code of max_compensation." + "description": "Optional. 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 of max_compensation." } }, "type": "object" }, "CompleteQueryResponse": { - "description": "Output only.\n\nResponse of auto-complete query.", + "description": "Output only. Response of auto-complete query.", "id": "CompleteQueryResponse", "properties": { "completionResults": { @@ -1173,13 +1191,13 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." } }, "type": "object" }, "CompletionResult": { - "description": "Output only.\n\nResource that represents completion results.", + "description": "Output only. Resource that represents completion results.", "id": "CompletionResult", "properties": { "imageUri": { @@ -1215,13 +1233,13 @@ "properties": { "clientEvent": { "$ref": "ClientEvent", - "description": "Required. Events issued when end user interacts with customer's application that\nuses Cloud Talent Solution." + "description": "Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution." } }, "type": "object" }, "CreateCompanyRequest": { - "description": "Input only.\n\nThe Request of the CreateCompany method.", + "description": "Input only. The Request of the CreateCompany method.", "id": "CreateCompanyRequest", "properties": { "company": { @@ -1232,7 +1250,7 @@ "type": "object" }, "CreateJobRequest": { - "description": "Input only.\n\nCreate job request.", + "description": "Input only. Create job request.", "id": "CreateJobRequest", "properties": { "job": { @@ -1247,11 +1265,11 @@ "id": "CustomAttribute", "properties": { "filterable": { - "description": "Optional. If the `filterable` flag is true, the custom field values may be used for\ncustom attribute filters JobQuery.custom_attribute_filter.\nIf false, these values may not be used for custom attribute filters.\n\nDefault is false.", + "description": "Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", "type": "boolean" }, "longValues": { - "description": "Optional but exactly one of string_values or long_values must\nbe specified.\n\nThis field is used to perform number range search.\n(`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.\n\nCurrently at most 1 long_values is supported.", + "description": "Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", "items": { "format": "int64", "type": "string" @@ -1259,7 +1277,7 @@ "type": "array" }, "stringValues": { - "description": "Optional but exactly one of string_values or long_values must\nbe specified.\n\nThis field is used to perform a string match (`CASE_SENSITIVE_MATCH` or\n`CASE_INSENSITIVE_MATCH`) search.\nFor filterable `string_value`s, a maximum total number of 200 values\nis allowed, with each `string_value` has a byte size of no more than\n500B. For unfilterable `string_values`, the maximum total byte size of\nunfilterable `string_values` is 50KB.\n\nEmpty string is not allowed.", + "description": "Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed.", "items": { "type": "string" }, @@ -1269,26 +1287,26 @@ "type": "object" }, "CustomAttributeHistogramRequest": { - "description": "Custom attributes histogram request. An error is thrown if neither\nstring_value_histogram or long_value_histogram_bucketing_option has\nbeen defined.", + "description": "Custom attributes histogram request. An error is thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.", "id": "CustomAttributeHistogramRequest", "properties": { "key": { - "description": "Required. Specifies the custom field key to perform a histogram on. If specified\nwithout `long_value_histogram_bucketing_option`, histogram on string values\nof the given `key` is triggered, otherwise histogram is performed on long\nvalues.", + "description": "Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.", "type": "string" }, "longValueHistogramBucketingOption": { "$ref": "NumericBucketingOption", - "description": "Optional. Specifies buckets used to perform a range histogram on Job's\nfilterable long custom field values, or min/max value requirements." + "description": "Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements." }, "stringValueHistogram": { - "description": "Optional. If set to true, the response includes the histogram value for\neach key as a string.", + "description": "Optional. If set to true, the response includes the histogram value for each key as a string.", "type": "boolean" } }, "type": "object" }, "CustomAttributeHistogramResult": { - "description": "Output only.\n\nCustom attribute histogram result.", + "description": "Output only. Custom attribute histogram result.", "id": "CustomAttributeHistogramResult", "properties": { "key": { @@ -1297,25 +1315,25 @@ }, "longValueHistogramResult": { "$ref": "NumericBucketingResult", - "description": "Stores bucketed histogram counting result or min/max values for\ncustom attribute long values associated with `key`." + "description": "Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`." }, "stringValueHistogramResult": { "additionalProperties": { "format": "int32", "type": "integer" }, - "description": "Stores a map from the values of string custom field associated\nwith `key` to the number of jobs with that value in this histogram result.", + "description": "Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.", "type": "object" } }, "type": "object" }, "CustomRankingInfo": { - "description": "Input only.\n\nCustom ranking information for SearchJobsRequest.", + "description": "Input only. Custom ranking information for SearchJobsRequest.", "id": "CustomRankingInfo", "properties": { "importanceLevel": { - "description": "Required. Controls over how important the score of\nCustomRankingInfo.ranking_expression gets applied to job's final\nranking position.\n\nAn error is thrown if not specified.", + "description": "Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified.", "enum": [ "IMPORTANCE_LEVEL_UNSPECIFIED", "NONE", @@ -1327,24 +1345,24 @@ ], "enumDescriptions": [ "Default value if the importance level is not specified.", - "The given ranking expression is of None importance, existing relevance\nscore (determined by API algorithm) dominates job's final ranking\nposition.", - "The given ranking expression is of Low importance in terms of job's\nfinal ranking position compared to existing relevance\nscore (determined by API algorithm).", - "The given ranking expression is of Mild importance in terms of job's\nfinal ranking position compared to existing relevance\nscore (determined by API algorithm).", - "The given ranking expression is of Medium importance in terms of job's\nfinal ranking position compared to existing relevance\nscore (determined by API algorithm).", - "The given ranking expression is of High importance in terms of job's\nfinal ranking position compared to existing relevance\nscore (determined by API algorithm).", - "The given ranking expression is of Extreme importance, and dominates\njob's final ranking position with existing relevance\nscore (determined by API algorithm) ignored." + "The given ranking expression is of None importance, existing relevance score (determined by API algorithm) dominates job's final ranking position.", + "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).", + "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).", + "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).", + "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).", + "The given ranking expression is of Extreme importance, and dominates job's final ranking position with existing relevance score (determined by API algorithm) ignored." ], "type": "string" }, "rankingExpression": { - "description": "Required. Controls over how job documents get ranked on top of existing relevance\nscore (determined by API algorithm). A combination of the ranking\nexpression and relevance score is used to determine job's final ranking\nposition.\n\nThe syntax for this expression is a subset of Google SQL syntax.\n\nSupported operators are: +, -, *, /, where the left and right side of\nthe operator is either a numeric Job.custom_attributes key,\ninteger/double value or an expression that can be evaluated to a number.\n\nParenthesis are supported to adjust calculation precedence. The\nexpression must be < 100 characters in length.\n\nThe expression is considered invalid for a job if the expression\nreferences custom attributes that are not populated on the job or if the\nexpression results in a divide by zero. If an expression is invalid for a\njob, that job is demoted to the end of the results.\n\nSample ranking expression\n(year + 25) * 0.25 - (freshness / 0.5)", + "description": "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 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 < 100 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": "string" } }, "type": "object" }, "DeviceInfo": { - "description": "Device information collected from the job seeker, candidate, or\nother entity conducting the job search. Providing this information improves\nthe quality of the search results across devices.", + "description": "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.", "id": "DeviceInfo", "properties": { "deviceType": { @@ -1360,256 +1378,313 @@ ], "enumDescriptions": [ "The device type isn't specified.", - "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet\nExplorer)", - "A mobile device web browser, such as a phone or tablet with a Chrome\nbrowser.", + "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)", + "A mobile device web browser, such as a phone or tablet with a Chrome browser.", "An Android device native application.", "An iOS device native application.", - "A bot, as opposed to a device operated by human beings, such as a web\ncrawler.", + "A bot, as opposed to a device operated by human beings, such as a web crawler.", "Other devices types." ], "type": "string" }, "id": { - "description": "Optional. A device-specific ID. The ID must be a unique identifier that\ndistinguishes the device from other devices.", + "description": "Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.", "type": "string" } }, "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, - "HistogramFacets": { - "description": "Input only.\n\nHistogram facets to be specified in SearchJobsRequest.", - "id": "HistogramFacets", + "GoogleCloudTalentV4BatchCreateJobsResponse": { + "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchCreateJobsResponse", "properties": { - "compensationHistogramFacets": { - "description": "Optional. Specifies compensation field-based histogram requests.\nDuplicate values of CompensationHistogramRequest.type are not allowed.", + "jobResults": { + "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", "items": { - "$ref": "CompensationHistogramRequest" + "$ref": "GoogleCloudTalentV4JobResult" }, "type": "array" - }, - "customAttributeHistogramFacets": { - "description": "Optional. Specifies the custom attributes histogram requests.\nDuplicate values of CustomAttributeHistogramRequest.key are not\nallowed.", + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchDeleteJobsResponse": { + "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchDeleteJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", "items": { - "$ref": "CustomAttributeHistogramRequest" + "$ref": "GoogleCloudTalentV4JobResult" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4BatchOperationMetadata": { + "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", + "id": "GoogleCloudTalentV4BatchOperationMetadata", + "properties": { + "createTime": { + "description": "The time when the batch operation is created.", + "format": "google-datetime", + "type": "string" }, - "simpleHistogramFacets": { - "description": "Optional. Specifies the simple type of histogram facets, for example,\n`COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.", + "endTime": { + "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of failed item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of a long running operation.", + "enum": [ + "STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "SUCCEEDED", + "FAILED", + "CANCELLING", + "CANCELLED" + ], "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Possible return values are:\n* PAST_24_HOURS (The past 24 hours)\n* PAST_3_DAYS (The past 3 days)\n* PAST_WEEK (The past 7 days)\n* PAST_MONTH (The past 30 days)\n* PAST_YEAR (The past 365 days)", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Company display name.", - "Base compensation unit." + "Default value.", + "The batch operation is being prepared for processing.", + "The batch operation is actively being processed.", + "The batch operation is processed, and at least one item has been successfully processed.", + "The batch operation is done and no item has been successfully processed.", + "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", + "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." ], - "items": { - "enum": [ - "SEARCH_TYPE_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN_1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN_1_COUNTRY", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "type": "string" - }, - "type": "array" + "type": "string" + }, + "stateDescription": { + "description": "More detailed information about operation state.", + "type": "string" + }, + "successCount": { + "description": "Count of successful item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Count of total item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "HistogramQuery": { - "description": "Input Only.\n\nThe histogram request.", - "id": "HistogramQuery", + "GoogleCloudTalentV4BatchUpdateJobsResponse": { + "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "GoogleCloudTalentV4BatchUpdateJobsResponse", "properties": { - "histogramQuery": { - "description": "An expression specifies a histogram request against matching resources\n(for example, jobs) for searches.\n\nExpression syntax is a aggregation function call with histogram facets and\nother options.\n\nAvailable aggregation function calls are:\n* `count(string_histogram_facet)`: Count the number of matching entity, for\n each distinct attribute value.\n* `count(numeric_histogram_facet, list of buckets)`: Count the number of\n matching entity within each bucket.\n\nData types:\n\n* Histogram facet: facet names with format a-zA-Z+.\n* String: string like \"any string with backslash escape for quote(\\\").\"\n* Number: whole number and floating point number like 10, -1 and -0.01.\n* List: list of elements with comma(,) separator surrounded by square\nbrackets. For example, [1, 2, 3] and [\"one\", \"two\", \"three\"].\n\nBuilt-in constants:\n\n* MIN (minimum number similar to java Double.MIN_VALUE)\n* MAX (maximum number similar to java Double.MAX_VALUE)\n\nBuilt-in functions:\n\n* bucket(start, end[, label]): bucket built-in function creates a bucket\nwith range of start, end). Note that the end is exclusive. For example,\nbucket(1, MAX, \"positive number\") or bucket(1, 10).\n\nJob histogram facets:\n\n* company_id: histogram by [Job.distributor_company_id.\n* company_display_name: histogram by Job.company_display_name.\n* employment_type: histogram by Job.employment_types. For example,\n\"FULL_TIME\", \"PART_TIME\".\n* company_size: histogram by CompanySize, for example, \"SMALL\",\n\"MEDIUM\", \"BIG\".\n* publish_time_in_month: histogram by the Job.publish_time in months.\nMust specify list of numeric buckets in spec.\n* publish_time_in_year: histogram by the Job.publish_time in years.\nMust specify list of numeric buckets in spec.\n* degree_type: histogram by the Job.degree_type. For example,\n\"Bachelors\", \"Masters\".\n* job_level: histogram by the Job.job_level. For example, \"Entry\nLevel\".\n* country: histogram by the country code of jobs. For example, \"US\", \"FR\".\n* admin1: histogram by the admin1 code of jobs, which is a global\nplaceholder referring to the state, province, or the particular term a\ncountry uses to define the geographic structure below the country level.\nFor example, \"CA\", \"IL\".\n* city: histogram by a combination of the \"city name, admin1 code\". For\nexample, \"Mountain View, CA\", \"New York, NY\".\n* admin1_country: histogram by a combination of the \"admin1 code, country\".\nFor example, \"CA, US\", \"IL, US\".\n* city_coordinate: histogram by the city center's GPS coordinates (latitude\nand longitude). For example, 37.4038522,-122.0987765. Since the coordinates\nof a city center can change, customers may need to refresh them\nperiodically.\n* locale: histogram by the Job.language_code. For example, \"en-US\",\n\"fr-FR\".\n* language: histogram by the language subtag of the Job.language_code.\nFor example, \"en\", \"fr\".\n* category: histogram by the JobCategory. For example,\n\"COMPUTER_AND_IT\", \"HEALTHCARE\".\n* base_compensation_unit: histogram by the CompensationUnit of base\nsalary. For example, \"WEEKLY\", \"MONTHLY\".\n* base_compensation: histogram by the base salary. Must specify list of\nnumeric buckets to group results by.\n* annualized_base_compensation: histogram by the base annualized salary.\nMust specify list of numeric buckets to group results by.\n* annualized_total_compensation: histogram by the total annualized salary.\nMust specify list of numeric buckets to group results by.\n* string_custom_attribute: histogram by string Job.custom_attributes.\nValues can be accessed via square bracket notations like\nstring_custom_attribute[\"key1\"].\n* numeric_custom_attribute: histogram by numeric Job.custom_attributes.\nValues can be accessed via square bracket notations like\nnumeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to\ngroup results by.\n\nExample expressions:\n* count(admin1)\n* count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000),\nbucket(100000, MAX)])\n* count(string_custom_attribute[\"some-string-custom-attribute\"])\n* count(numeric_custom_attribute[\"some-numeric-custom-attribute\"],\n[bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\"])", - "type": "string" + "jobResults": { + "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "GoogleCloudTalentV4JobResult" + }, + "type": "array" } }, "type": "object" }, - "HistogramQueryResult": { - "description": "Output only.\n\nHistogram result that matches HistogramSpec specified in searches.", - "id": "HistogramQueryResult", + "GoogleCloudTalentV4CompensationInfo": { + "description": "Job compensation details.", + "id": "GoogleCloudTalentV4CompensationInfo", "properties": { - "histogram": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "A map from the values of the facet associated with distinct values to the\nnumber of matching entries with corresponding value.\n\nThe key format is:\n* (for string histogram) string values stored in the field.\n* (for named numeric bucket) name specified in `bucket()` function, like\n for `bucket(0, MAX, \"non-negative\")`, the key will be `non-negative`.\n* (for anonymous numeric bucket) range formatted as `-`, for\nexample, `0-1000`, `MIN-0`, and `0-MAX`.", - "type": "object" + "annualizedBaseCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true }, - "histogramQuery": { - "description": "Requested histogram expression.", - "type": "string" + "annualizedTotalCompensationRange": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "entries": { + "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", + "items": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationEntry" + }, + "type": "array" } }, "type": "object" }, - "HistogramResult": { - "description": "Output only.\n\nResult of a histogram call. The response contains the histogram map for the\nsearch type specified by HistogramResult.field.\nThe response is a map of each filter value to the corresponding count of\njobs for that filter.", - "id": "HistogramResult", + "GoogleCloudTalentV4CompensationInfoCompensationEntry": { + "description": "A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationEntry", "properties": { - "searchType": { - "description": "The Histogram search filters.", + "amount": { + "$ref": "Money", + "description": "Compensation amount." + }, + "description": { + "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", + "type": "string" + }, + "expectedUnitsPerYear": { + "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", + "description": "Compensation range." + }, + "type": { + "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", "enum": [ - "SEARCH_TYPE_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN_1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN_1_COUNTRY", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" + "COMPENSATION_TYPE_UNSPECIFIED", + "BASE", + "BONUS", + "SIGNING_BONUS", + "EQUITY", + "PROFIT_SHARING", + "COMMISSIONS", + "TIPS", + "OTHER_COMPENSATION_TYPE" ], "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Possible return values are:\n* PAST_24_HOURS (The past 24 hours)\n* PAST_3_DAYS (The past 3 days)\n* PAST_WEEK (The past 7 days)\n* PAST_MONTH (The past 30 days)\n* PAST_YEAR (The past 365 days)", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for\nreferring to state, province, or the particular term a country uses to\ndefine the geographic structure below the country level.\nExamples include states codes such as \"CA\", \"IL\", \"NY\", and\nprovinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example,\n\"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\".\n\nThis is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or\n\"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for\nexample, 37.4038522,-122.0987765. Since the coordinates of a city center\ncan change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field\ndiffers from `JOB_ADMIN1`, which can be used in multiple countries.", - "Company display name.", - "Base compensation unit." + "Default value.", + "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.", + "Signing bonus.", + "Equity.", + "Profit sharing.", + "Commission.", + "Tips.", + "Other compensation type." ], "type": "string" }, - "values": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "description": "A map from the values of field to the number of jobs with that value\nin this search result.\n\nKey: search type (filter names, such as the companyName).\n\nValues: the count of jobs that match the filter for this search.", - "type": "object" + "unit": { + "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "enum": [ + "COMPENSATION_UNIT_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY", + "ONE_TIME", + "OTHER_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], + "type": "string" } }, "type": "object" }, - "HistogramResults": { - "description": "Output only.\n\nHistogram results that match HistogramFacets specified in\nSearchJobsRequest.", - "id": "HistogramResults", + "GoogleCloudTalentV4CompensationInfoCompensationRange": { + "description": "Compensation range.", + "id": "GoogleCloudTalentV4CompensationInfoCompensationRange", "properties": { - "compensationHistogramResults": { - "description": "Specifies compensation field-based histogram results that match\nHistogramFacets.compensation_histogram_requests.", - "items": { - "$ref": "CompensationHistogramResult" - }, - "type": "array" + "maxCompensation": { + "$ref": "Money", + "description": "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 of min_compensation." }, - "customAttributeHistogramResults": { - "description": "Specifies histogram results for custom attributes that match\nHistogramFacets.custom_attribute_histogram_facets.", + "minCompensation": { + "$ref": "Money", + "description": "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 of max_compensation." + } + }, + "type": "object" + }, + "GoogleCloudTalentV4CustomAttribute": { + "description": "Custom attribute values that are either filterable or non-filterable.", + "id": "GoogleCloudTalentV4CustomAttribute", + "properties": { + "filterable": { + "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", + "type": "boolean" + }, + "keywordSearchable": { + "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", + "type": "boolean" + }, + "longValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", "items": { - "$ref": "CustomAttributeHistogramResult" + "format": "int64", + "type": "string" }, "type": "array" }, - "simpleHistogramResults": { - "description": "Specifies histogram results that matches\nHistogramFacets.simple_histogram_facets.", + "stringValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", "items": { - "$ref": "HistogramResult" + "type": "string" }, "type": "array" } }, "type": "object" }, - "Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\"\nor \"job requisition\"). A job belongs to a Company, which is the hiring\nentity responsible for the job.", - "id": "Job", + "GoogleCloudTalentV4Job": { + "description": "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.", + "id": "GoogleCloudTalentV4Job", "properties": { "addresses": { - "description": "Optional but strongly recommended for the best service experience.\n\nLocation(s) where the employer is looking to hire for this job posting.\n\nSpecifying the full street address(es) of the hiring location enables\nbetter API results, especially job searches by commute time.\n\nAt most 50 locations are allowed for best search performance. If a job has\nmore locations, it is suggested to split it into multiple jobs with unique\nrequisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as\nmultiple jobs with the same company_name, language_code and\nrequisition_id are not allowed. If the original requisition_id must\nbe preserved, a custom field should be used for storage. It is also\nsuggested to group the locations that close to each other in the same job\nfor better search experience.\n\nThe maximum number of allowed characters is 500.", + "description": "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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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.", "items": { "type": "string" }, "type": "array" }, "applicationInfo": { - "$ref": "ApplicationInfo", - "description": "Required. At least one field within ApplicationInfo must be specified.\n\nJob application information." + "$ref": "GoogleCloudTalentV4JobApplicationInfo", + "description": "Job application information." }, - "companyDisplayName": { - "description": "Output only. Display name of the company listing the job.", + "company": { + "description": "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\".", "type": "string" }, - "companyName": { - "description": "Required. The resource name of the company listing the job, such as\n\"projects/api-test-project/companies/foo\".", + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "readOnly": true, "type": "string" }, "compensationInfo": { - "$ref": "CompensationInfo", - "description": "Optional. Job compensation information." + "$ref": "GoogleCloudTalentV4CompensationInfo", + "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." }, "customAttributes": { "additionalProperties": { - "$ref": "CustomAttribute" + "$ref": "GoogleCloudTalentV4CustomAttribute" }, - "description": "Optional. A map of fields to hold both filterable and non-filterable custom job\nattributes that are not covered by the provided structured fields.\n\nThe keys of the map are strings up to 64 bytes and must match the\npattern: a-zA-Z*. For example, key0LikeThis or\nKEY_1_LIKE_THIS.\n\nAt most 100 filterable and at most 100 unfilterable keys are supported.\nFor filterable `string_values`, across all keys at most 200 values are\nallowed, with each string no more than 255 characters. For unfilterable\n`string_values`, the maximum total size of `string_values` across all keys\nis 50KB.", + "description": "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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", "type": "object" }, "degreeTypes": { - "description": "Optional. The desired education degrees for the job, such as Bachelors, Masters.", - "enumDescriptions": [ - "Default value. Represents no degree, or early childhood education.\nMaps to ISCED code 0.\nEx) Kindergarten", - "Primary education which is typically the first stage of compulsory\neducation. ISCED code 1.\nEx) Elementary school", - "Lower secondary education; First stage of secondary education building on\nprimary education, typically with a more subject-oriented curriculum.\nISCED code 2.\nEx) Middle school", - "Middle education; Second/final stage of secondary education preparing for\ntertiary education and/or providing skills relevant to employment.\nUsually with an increased range of subject options and streams. ISCED\ncode 3.\nEx) High school", - "Adult Remedial Education; Programmes providing learning experiences that\nbuild on secondary education and prepare for labour market entry and/or\ntertiary education. The content is broader than secondary but not as\ncomplex as tertiary education. ISCED code 4.", - "Associate's or equivalent; Short first tertiary programmes that are\ntypically practically-based, occupationally-specific and prepare for\nlabour market entry. These programmes may also provide a pathway to other\ntertiary programmes. ISCED code 5.", - "Bachelor's or equivalent; Programmes designed to provide intermediate\nacademic and/or professional knowledge, skills and competencies leading\nto a first tertiary degree or equivalent qualification. ISCED code 6.", - "Master's or equivalent; Programmes designed to provide advanced academic\nand/or professional knowledge, skills and competencies leading to a\nsecond tertiary degree or equivalent qualification. ISCED code 7.", - "Doctoral or equivalent; Programmes designed primarily to lead to an\nadvanced research qualification, usually concluding with the submission\nand defense of a substantive dissertation of publishable quality based on\noriginal research. ISCED code 8." - ], + "description": "The desired education degrees for the job, such as Bachelors, Masters.", "items": { "enum": [ "DEGREE_TYPE_UNSPECIFIED", @@ -1622,37 +1697,36 @@ "MASTERS_OR_EQUIVALENT", "DOCTORAL_OR_EQUIVALENT" ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "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", + "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; 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.", + "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.", + "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.", + "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; 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." + ], "type": "string" }, "type": "array" }, "department": { - "description": "Optional. The department or functional area within the company with the open\nposition.\n\nThe maximum number of allowed characters is 255.", + "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", "type": "string" }, "derivedInfo": { - "$ref": "JobDerivedInfo", - "description": "Output only. Derived details about the job posting." + "$ref": "GoogleCloudTalentV4JobDerivedInfo", + "description": "Output only. Derived details about the job posting.", + "readOnly": true }, "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph\ndescription of the company and related information. Separate fields are\nprovided on the job object for responsibilities,\nqualifications, and other job characteristics. Use of\nthese separate job fields is recommended.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 100,000.", + "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, 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": "string" }, "employmentTypes": { - "description": "Optional. The employment type(s) of a job, for example,\nfull time or\npart time.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a contracted position with the understanding\nthat it's converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job\nseekers to obtain on-the-job training, typically offered as a summer\nposition.", - "The is an opportunity for an individual to volunteer, where there's no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "The employment type(s) of a job, for example, full time or part time.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -1667,30 +1741,679 @@ "FLY_IN_FLY_OUT", "OTHER_EMPLOYMENT_TYPE" ], + "enumDescriptions": [ + "The default value if the employment type isn't specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "incentives": { - "description": "Optional. A description of bonus, commission, and other compensation\nincentives associated with the job not including salary or pay.\n\nThe maximum number of allowed characters is 10,000.", + "description": "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": "string" }, "jobBenefits": { - "description": "Optional. The benefits included with the job.", + "description": "The benefits included with the job.", + "items": { + "enum": [ + "JOB_BENEFIT_UNSPECIFIED", + "CHILD_CARE", + "DENTAL", + "DOMESTIC_PARTNER", + "FLEXIBLE_HOURS", + "MEDICAL", + "LIFE_INSURANCE", + "PARENTAL_LEAVE", + "RETIREMENT_PLAN", + "SICK_DAYS", + "VACATION", + "VISION" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], + "type": "string" + }, + "type": "array" + }, + "jobEndTime": { + "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "jobLevel": { + "description": "The experience level associated with the job, such as \"Entry Level\".", + "enum": [ + "JOB_LEVEL_UNSPECIFIED", + "ENTRY_LEVEL", + "EXPERIENCED", + "MANAGER", + "DIRECTOR", + "EXECUTIVE" + ], "enumDescriptions": [ - "Default value if the type is not specified.", - "The job includes access to programs that support child care, such\nas daycare.", - "The job includes dental services covered by a dental\ninsurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services covered by a medical insurance plan.", - "The job includes a life insurance plan provided by the employer or\navailable for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn\nchild.", - "The job includes a workplace retirement plan provided by the\nemployer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "The job includes paid time off for vacation.", - "The job includes vision services covered by a vision\ninsurance plan." + "The default value if the level isn't specified.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", + "Entry- to mid-level managers responsible for managing a team of people.", + "Senior-level managers responsible for managing teams of managers.", + "Executive-level managers and above, including C-level positions." + ], + "type": "string" + }, + "jobStartTime": { + "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "languageCode": { + "description": "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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", + "type": "string" + }, + "name": { + "description": "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\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", + "type": "string" + }, + "postingCreateTime": { + "description": "Output only. The timestamp when this job posting was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "postingExpireTime": { + "description": "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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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.", + "format": "google-datetime", + "type": "string" + }, + "postingPublishTime": { + "description": "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.", + "format": "google-datetime", + "type": "string" + }, + "postingRegion": { + "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", + "enum": [ + "POSTING_REGION_UNSPECIFIED", + "ADMINISTRATIVE_AREA", + "NATION", + "TELECOMMUTE" + ], + "enumDescriptions": [ + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if 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.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "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." + ], + "type": "string" + }, + "postingUpdateTime": { + "description": "Output only. The timestamp when this job posting was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "processingOptions": { + "$ref": "GoogleCloudTalentV4JobProcessingOptions", + "description": "Options for job processing." + }, + "promotionValue": { + "description": "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.", + "format": "int32", + "type": "integer" + }, + "qualifications": { + "description": "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 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": "string" + }, + "requisitionId": { + "description": "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, language_code and requisition_id. The maximum number of allowed characters is 255.", + "type": "string" + }, + "responsibilities": { + "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" + }, + "title": { + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", + "type": "string" + }, + "visibility": { + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "ACCOUNT_ONLY", + "SHARED_WITH_GOOGLE", + "SHARED_WITH_PUBLIC" + ], + "enumDescriptions": [ + "Default value.", + "The resource is only visible to the GCP account who owns it.", + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobApplicationInfo": { + "description": "Application related details of a job posting.", + "id": "GoogleCloudTalentV4JobApplicationInfo", + "properties": { + "emails": { + "description": "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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "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": "string" + }, + "uris": { + "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobDerivedInfo": { + "description": "Derived details about the job posting.", + "id": "GoogleCloudTalentV4JobDerivedInfo", + "properties": { + "jobCategories": { + "description": "Job categories derived from Job.title and Job.description.", + "items": { + "enum": [ + "JOB_CATEGORY_UNSPECIFIED", + "ACCOUNTING_AND_FINANCE", + "ADMINISTRATIVE_AND_OFFICE", + "ADVERTISING_AND_MARKETING", + "ANIMAL_CARE", + "ART_FASHION_AND_DESIGN", + "BUSINESS_OPERATIONS", + "CLEANING_AND_FACILITIES", + "COMPUTER_AND_IT", + "CONSTRUCTION", + "CUSTOMER_SERVICE", + "EDUCATION", + "ENTERTAINMENT_AND_TRAVEL", + "FARMING_AND_OUTDOORS", + "HEALTHCARE", + "HUMAN_RESOURCES", + "INSTALLATION_MAINTENANCE_AND_REPAIR", + "LEGAL", + "MANAGEMENT", + "MANUFACTURING_AND_WAREHOUSE", + "MEDIA_COMMUNICATIONS_AND_WRITING", + "OIL_GAS_AND_MINING", + "PERSONAL_CARE_AND_SERVICES", + "PROTECTIVE_SERVICES", + "REAL_ESTATE", + "RESTAURANT_AND_HOSPITALITY", + "SALES_AND_RETAIL", + "SCIENCE_AND_ENGINEERING", + "SOCIAL_SERVICES_AND_NON_PROFIT", + "SPORTS_FITNESS_AND_RECREATION", + "TRANSPORTATION_AND_LOGISTICS" + ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], + "type": "string" + }, + "type": "array" + }, + "locations": { + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", + "items": { + "$ref": "GoogleCloudTalentV4Location" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobProcessingOptions": { + "description": "Options for job processing.", + "id": "GoogleCloudTalentV4JobProcessingOptions", + "properties": { + "disableStreetAddressResolution": { + "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", + "type": "boolean" + }, + "htmlSanitization": { + "description": "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.", + "enum": [ + "HTML_SANITIZATION_UNSPECIFIED", + "HTML_SANITIZATION_DISABLED", + "SIMPLE_FORMATTING_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables sanitization on HTML input.", + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudTalentV4JobResult": { + "description": "Mutation result of a job from a batch operation.", + "id": "GoogleCloudTalentV4JobResult", + "properties": { + "job": { + "$ref": "GoogleCloudTalentV4Job", + "description": "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." + }, + "status": { + "$ref": "Status", + "description": "The status of the job processed. This field is populated if the processing of the job fails." + } + }, + "type": "object" + }, + "GoogleCloudTalentV4Location": { + "description": "A resource that represents a location with full geographic information.", + "id": "GoogleCloudTalentV4Location", + "properties": { + "latLng": { + "$ref": "LatLng", + "description": "An object representing a latitude/longitude pair." + }, + "locationType": { + "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "COUNTRY", + "ADMINISTRATIVE_AREA", + "SUB_ADMINISTRATIVE_AREA", + "LOCALITY", + "POSTAL_CODE", + "SUB_LOCALITY", + "SUB_LOCALITY_1", + "SUB_LOCALITY_2", + "NEIGHBORHOOD", + "STREET_ADDRESS" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "A country level location.", + "A state or equivalent level location.", + "A county or equivalent level location.", + "A city or equivalent level location.", + "A postal code level location.", + "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.", + "A district or equivalent level location.", + "A smaller district or equivalent level display.", + "A neighborhood level location.", + "A street address level location." + ], + "type": "string" + }, + "postalAddress": { + "$ref": "PostalAddress", + "description": "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." + }, + "radiusMiles": { + "description": "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 covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "HistogramFacets": { + "description": "Input only. Histogram facets to be specified in SearchJobsRequest.", + "id": "HistogramFacets", + "properties": { + "compensationHistogramFacets": { + "description": "Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.", + "items": { + "$ref": "CompensationHistogramRequest" + }, + "type": "array" + }, + "customAttributeHistogramFacets": { + "description": "Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.", + "items": { + "$ref": "CustomAttributeHistogramRequest" + }, + "type": "array" + }, + "simpleHistogramFacets": { + "description": "Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc.", + "items": { + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "COMPANY_ID", + "EMPLOYMENT_TYPE", + "COMPANY_SIZE", + "DATE_PUBLISHED", + "EDUCATION_LEVEL", + "EXPERIENCE_LEVEL", + "ADMIN_1", + "COUNTRY", + "CITY", + "LOCALE", + "LANGUAGE", + "CATEGORY", + "CITY_COORDINATE", + "ADMIN_1_COUNTRY", + "COMPANY_DISPLAY_NAME", + "BASE_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Possible return values are: * PAST_24_HOURS (The past 24 hours) * PAST_3_DAYS (The past 3 days) * PAST_WEEK (The past 7 days) * PAST_MONTH (The past 30 days) * PAST_YEAR (The past 365 days)", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Company display name.", + "Base compensation unit." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "HistogramQuery": { + "description": "Input Only. The histogram request.", + "id": "HistogramQuery", + "properties": { + "histogramQuery": { + "description": "An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * 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_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, \"Bachelors\", \"Masters\". * job_level: histogram by the 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. For example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code. For example, \"en\", \"fr\". * category: histogram by the JobCategory. For example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the 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. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric 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": "string" + } + }, + "type": "object" + }, + "HistogramQueryResult": { + "description": "Output only. Histogram result that matches HistogramSpec specified in searches.", + "id": "HistogramQueryResult", + "properties": { + "histogram": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "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 for `bucket(0, MAX, \"non-negative\")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`.", + "type": "object" + }, + "histogramQuery": { + "description": "Requested histogram expression.", + "type": "string" + } + }, + "type": "object" + }, + "HistogramResult": { + "description": "Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.", + "id": "HistogramResult", + "properties": { + "searchType": { + "description": "The Histogram search filters.", + "enum": [ + "SEARCH_TYPE_UNSPECIFIED", + "COMPANY_ID", + "EMPLOYMENT_TYPE", + "COMPANY_SIZE", + "DATE_PUBLISHED", + "EDUCATION_LEVEL", + "EXPERIENCE_LEVEL", + "ADMIN_1", + "COUNTRY", + "CITY", + "LOCALE", + "LANGUAGE", + "CATEGORY", + "CITY_COORDINATE", + "ADMIN_1_COUNTRY", + "COMPANY_DISPLAY_NAME", + "BASE_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "The default value if search type is not specified.", + "Filter by the company id field.", + "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", + "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", + "Filter by the date published field. Possible return values are: * PAST_24_HOURS (The past 24 hours) * PAST_3_DAYS (The past 3 days) * PAST_WEEK (The past 7 days) * PAST_MONTH (The past 30 days) * PAST_YEAR (The past 365 days)", + "Filter by the required education level of the job.", + "Filter by the required experience level of the job.", + "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", + "Filter by the country code of job, such as US, JP, FR.", + "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", + "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", + "Filter by the Category.", + "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", + "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", + "Company display name.", + "Base compensation unit." ], + "type": "string" + }, + "values": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.", + "type": "object" + } + }, + "type": "object" + }, + "HistogramResults": { + "description": "Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest.", + "id": "HistogramResults", + "properties": { + "compensationHistogramResults": { + "description": "Specifies compensation field-based histogram results that match HistogramFacets.compensation_histogram_requests.", + "items": { + "$ref": "CompensationHistogramResult" + }, + "type": "array" + }, + "customAttributeHistogramResults": { + "description": "Specifies histogram results for custom attributes that match HistogramFacets.custom_attribute_histogram_facets.", + "items": { + "$ref": "CustomAttributeHistogramResult" + }, + "type": "array" + }, + "simpleHistogramResults": { + "description": "Specifies histogram results that matches HistogramFacets.simple_histogram_facets.", + "items": { + "$ref": "HistogramResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "Job": { + "description": "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.", + "id": "Job", + "properties": { + "addresses": { + "description": "Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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.", + "items": { + "type": "string" + }, + "type": "array" + }, + "applicationInfo": { + "$ref": "ApplicationInfo", + "description": "Required. At least one field within ApplicationInfo must be specified. Job application information." + }, + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "type": "string" + }, + "companyName": { + "description": "Required. The resource name of the company listing the job, such as \"projects/api-test-project/companies/foo\".", + "type": "string" + }, + "compensationInfo": { + "$ref": "CompensationInfo", + "description": "Optional. Job compensation information." + }, + "customAttributes": { + "additionalProperties": { + "$ref": "CustomAttribute" + }, + "description": "Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", + "type": "object" + }, + "degreeTypes": { + "description": "Optional. The desired education degrees for the job, such as Bachelors, Masters.", + "items": { + "enum": [ + "DEGREE_TYPE_UNSPECIFIED", + "PRIMARY_EDUCATION", + "LOWER_SECONDARY_EDUCATION", + "UPPER_SECONDARY_EDUCATION", + "ADULT_REMEDIAL_EDUCATION", + "ASSOCIATES_OR_EQUIVALENT", + "BACHELORS_OR_EQUIVALENT", + "MASTERS_OR_EQUIVALENT", + "DOCTORAL_OR_EQUIVALENT" + ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "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", + "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; 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.", + "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.", + "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.", + "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; 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." + ], + "type": "string" + }, + "type": "array" + }, + "department": { + "description": "Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", + "type": "string" + }, + "derivedInfo": { + "$ref": "JobDerivedInfo", + "description": "Output only. Derived details about the job posting." + }, + "description": { + "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, 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": "string" + }, + "employmentTypes": { + "description": "Optional. The employment type(s) of a job, for example, full time or part time.", + "items": { + "enum": [ + "EMPLOYMENT_TYPE_UNSPECIFIED", + "FULL_TIME", + "PART_TIME", + "CONTRACTOR", + "CONTRACT_TO_HIRE", + "TEMPORARY", + "INTERN", + "VOLUNTEER", + "PER_DIEM", + "FLY_IN_FLY_OUT", + "OTHER_EMPLOYMENT_TYPE" + ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], + "type": "string" + }, + "type": "array" + }, + "incentives": { + "description": "Optional. 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": "string" + }, + "jobBenefits": { + "description": "Optional. The benefits included with the job.", "items": { "enum": [ "JOB_BENEFIT_UNSPECIFIED", @@ -1706,12 +2429,26 @@ "VACATION", "VISION" ], + "enumDescriptions": [ + "Default value if the type is not specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], "type": "string" }, "type": "array" }, "jobEndTime": { - "description": "Optional. The end timestamp of the job. Typically this field is used for contracting\nengagements. Invalid timestamps are ignored.", + "description": "Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", "format": "google-datetime", "type": "string" }, @@ -1727,8 +2464,8 @@ ], "enumDescriptions": [ "The default value if the level is not specified.", - "Entry-level individual contributors, typically with less than 2 years of\nexperience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of\nexperience in a similar role.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", "Entry- to mid-level managers responsible for managing a team of people.", "Senior-level managers responsible for managing teams of managers.", "Executive-level managers and above, including C-level positions." @@ -1736,16 +2473,16 @@ "type": "string" }, "jobStartTime": { - "description": "Optional. The start timestamp of the job in UTC time zone. Typically this field\nis used for contracting engagements. Invalid timestamps are ignored.", + "description": "Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", "format": "google-datetime", "type": "string" }, "languageCode": { - "description": "Optional. The language of the posting. This field is distinct from\nany requirements for fluency that are associated with the job.\n\nLanguage codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:\nclass=\"external\" target=\"_blank\" }.\n\nIf this field is unspecified and Job.description is present, detected\nlanguage code based on Job.description is assigned, otherwise\ndefaults to 'en_US'.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", "type": "string" }, "name": { - "description": "Required during job update.\n\nThe resource name for the job. This is generated by the service when a\njob is created.\n\nThe format is \"projects/{project_id}/jobs/{job_id}\",\nfor example, \"projects/api-test-project/jobs/1234\".\n\nUse of this field in job queries and API calls is preferred over the use of\nrequisition_id since this value is unique.", + "description": "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}/jobs/{job_id}\", for example, \"projects/api-test-project/jobs/1234\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", "type": "string" }, "postingCreateTime": { @@ -1754,17 +2491,17 @@ "type": "string" }, "postingExpireTime": { - "description": "Optional but strongly recommended for the best service\nexperience.\n\nThe expiration timestamp of the job. After this timestamp, the\njob is marked as expired, and it no longer appears in search results. The\nexpired job can't be deleted or listed by the DeleteJob and\nListJobs APIs, but it can be retrieved with the GetJob API or\nupdated with the UpdateJob API. An expired job can be updated and\nopened again by using a future expiration timestamp. Updating an expired\njob fails if there is another existing open job with same company_name,\nlanguage_code and requisition_id.\n\nThe expired jobs are retained in our system for 90 days. However, the\noverall expired job count cannot exceed 3 times the maximum of open jobs\ncount over the past week, otherwise jobs with earlier expire time are\ncleaned first. Expired jobs are no longer accessible after they are cleaned\nout.\n\nInvalid timestamps are ignored, and treated as expire time not provided.\n\nTimestamp before the instant request is made is considered valid, the job\nwill be treated as expired immediately.\n\nIf this value is not provided at the time of job creation or is invalid,\nthe job posting expires after 30 days from the job's creation time. For\nexample, if the job was created on 2017/01/01 13:00AM UTC with an\nunspecified expiration date, the job expires after 2017/01/31 13:00AM UTC.\n\nIf this value is not provided on job update, it depends on the field masks\nset by UpdateJobRequest.update_mask. If the field masks include\nexpiry_time, or the masks are empty meaning that every field is\nupdated, the job posting expires after 30 days from the job's last\nupdate time. Otherwise the expiration date isn't updated.", + "description": "Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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.", "format": "google-datetime", "type": "string" }, "postingPublishTime": { - "description": "Optional. The timestamp this job posting was most recently published. The default\nvalue is the time the request arrives at the server. Invalid timestamps are\nignored.", + "description": "Optional. 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.", "format": "google-datetime", "type": "string" }, "postingRegion": { - "description": "Optional. The job PostingRegion (for example, state, country) throughout which\nthe job is available. If this field is set, a\nLocationFilter in a search query within the job region\nfinds this job posting if an exact location match isn't specified.\nIf this field is set to PostingRegion.NATION or\nPostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses\nto the same location level as this field is strongly recommended.", + "description": "Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", "enum": [ "POSTING_REGION_UNSPECIFIED", "ADMINISTRATIVE_AREA", @@ -1772,10 +2509,10 @@ "TELECOMMUTE" ], "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it\nmatches the LocationFilter.", - "In addition to exact location matching, job posting is returned when the\nLocationFilter in the search query is in the same administrative area\nas the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job\nis posted in \"CA, USA\", it's returned if LocationFilter has\n\"Mountain View\".\n\nAdministrative area refers to top-level administrative subdivision of this\ncountry. For example, US state, IT region, UK constituent nation and\nJP prefecture.", - "In addition to exact location matching, job is returned when\nLocationFilter in search query is in the same country as this job.\nFor example, if a `NATION_WIDE` job is posted in \"USA\", it's\nreturned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute).\nIf locations are provided with this value, the job is\nconsidered as having a location, but telecommuting is allowed." + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if 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.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "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." ], "type": "string" }, @@ -1789,28 +2526,28 @@ "description": "Optional. Options for job processing." }, "promotionValue": { - "description": "Optional. A promotion value of the job, as determined by the client.\nThe value determines the sort order of the jobs returned when searching for\njobs using the featured jobs search call, with higher promotional values\nbeing returned first and ties being resolved by relevance sort. Only the\njobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH.\n\nDefault value is 0, and negative values are treated as 0.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "qualifications": { - "description": "Optional. A description of the qualifications required to perform the\njob. The use of this field is recommended\nas an alternative to using the more general description field.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. 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 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": "string" }, "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, assigned by the\nclient to identify a job. This field is intended to be used by clients\nfor client identification and tracking of postings. A job is not allowed\nto be created if there is another job with the same [company_name],\nlanguage_code and requisition_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255.", "type": "string" }, "responsibilities": { - "description": "Optional. A description of job responsibilities. The use of this field is\nrecommended as an alternative to using the more general description\nfield.\n\nThis field accepts and sanitizes HTML input, and also accepts\nbold, italic, ordered list, and unordered list markup tags.\n\nThe maximum number of allowed characters is 10,000.", + "description": "Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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": "string" }, "title": { - "description": "Required. The title of the job, such as \"Software Engineer\"\n\nThe maximum number of allowed characters is 500.", + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", "type": "string" }, "visibility": { - "description": "Deprecated. The job is only visible to the owner.\n\nThe visibility of the job.\n\nDefaults to Visibility.ACCOUNT_ONLY if not specified.", + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", "enum": [ "VISIBILITY_UNSPECIFIED", "ACCOUNT_ONLY", @@ -1820,8 +2557,8 @@ "enumDescriptions": [ "Default value.", "The resource is only visible to the GCP account who owns it.", - "The resource is visible to the owner and may be visible to other\napplications and processes at Google.", - "The resource is visible to the owner and may be visible to all other API\nclients." + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." ], "type": "string" } @@ -1829,44 +2566,11 @@ "type": "object" }, "JobDerivedInfo": { - "description": "Output only.\n\nDerived details about the job posting.", + "description": "Output only. Derived details about the job posting.", "id": "JobDerivedInfo", "properties": { "jobCategories": { "description": "Job categories derived from Job.title and Job.description.", - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -1901,12 +2605,45 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "locations": { - "description": "Structured locations of the job, resolved from Job.addresses.\n\nlocations are exactly matched to Job.addresses in the same\norder.", + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", "items": { "$ref": "Location" }, @@ -1916,11 +2653,11 @@ "type": "object" }, "JobEvent": { - "description": "An event issued when a job seeker interacts with the application that\nimplements Cloud Talent Solution.", + "description": "An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.", "id": "JobEvent", "properties": { "jobs": { - "description": "Required. The job name(s) associated with this event.\nFor example, if this is an impression event,\nthis field contains the identifiers of all jobs shown to the job seeker.\nIf this was a view event, this field contains the\nidentifier of the viewed job.", + "description": "Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job.", "items": { "type": "string" }, @@ -1949,22 +2686,22 @@ ], "enumDescriptions": [ "The event is unspecified by other provided values.", - "The job seeker or other entity interacting with the service has\nhad a job rendered in their view, such as in a list of search results in\na compressed or clipped format. This event is typically associated with\nthe viewing of a jobs list on a single page by a job seeker.", - "The job seeker, or other entity interacting with the service, has\nviewed the details of a job, including the full description. This\nevent doesn't apply to the viewing a snippet of a job appearing as a\npart of the job search results. Viewing a snippet is associated with an\nimpression).", - "The job seeker or other entity interacting with the service\nperformed an action to view a job and was redirected to a different\nwebsite for job.", - "The job seeker or other entity interacting with the service\nbegan the process or demonstrated the intention of applying for a job.", - "The job seeker or other entity interacting with the service\nsubmitted an application for a job.", - "The job seeker or other entity interacting with the service\nsubmitted an application for a job with a single click without\nentering information. If a job seeker performs this action, send only\nthis event to the service. Do not also send\nJobEventType.APPLICATION_START or JobEventType.APPLICATION_FINISH\nevents.", - "The job seeker or other entity interacting with the service\nperformed an action to apply to a job and was redirected to a different\nwebsite to complete the application.", - "The job seeker or other entity interacting with the service began the\nprocess or demonstrated the intention of applying for a job from the\nsearch results page without viewing the details of the job posting.\nIf sending this event, JobEventType.VIEW event shouldn't be sent.", - "The job seeker, or other entity interacting with the service, performs an\naction with a single click from the search results page to apply to a job\n(without viewing the details of the job posting), and is redirected\nto a different website to complete the application. If a candidate\nperforms this action, send only this event to the service. Do not also\nsend JobEventType.APPLICATION_START,\nJobEventType.APPLICATION_FINISH or JobEventType.VIEW events.", - "This event should be used when a company submits an application\non behalf of a job seeker. This event is intended for use by staffing\nagencies attempting to place candidates.", - "The job seeker or other entity interacting with the service demonstrated\nan interest in a job by bookmarking or saving it.", - "The job seeker or other entity interacting with the service was\nsent a notification, such as an email alert or device notification,\ncontaining one or more jobs listings generated by the service.", - "The job seeker or other entity interacting with the service was\nemployed by the hiring entity (employer). Send this event\nonly if the job seeker was hired through an application that was\ninitiated by a search conducted through the Cloud Talent Solution\nservice.", - "A recruiter or staffing agency submitted an application on behalf of the\ncandidate after interacting with the service to identify a suitable job\nposting.", - "The entity interacting with the service (for example, the job seeker),\nwas granted an initial interview by the hiring entity (employer). This\nevent should only be sent if the job seeker was granted an interview as\npart of an application that was initiated by a search conducted through /\nrecommendation provided by the Cloud Talent Solution service.", - "The job seeker or other entity interacting with the service showed\nno interest in the job." + "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.", + "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).", + "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.", + "The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.", + "The job seeker or other entity interacting with the service submitted an application for a job.", + "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 or JobEventType.APPLICATION_FINISH events.", + "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.", + "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.", + "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, JobEventType.APPLICATION_FINISH or JobEventType.VIEW events.", + "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.", + "The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.", + "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.", + "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.", + "A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.", + "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.", + "The job seeker or other entity interacting with the service showed no interest in the job." ], "type": "string" } @@ -1972,22 +2709,22 @@ "type": "object" }, "JobQuery": { - "description": "Input only.\n\nThe query required to perform a search query.", + "description": "Input only. The query required to perform a search query.", "id": "JobQuery", "properties": { "commuteFilter": { "$ref": "CommuteFilter", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (for\n example, driving or public transit). Note: This only works with COMMUTE\n MODE. When specified, [JobQuery.location_filters] is\n ignored.\n\n Currently we don't support sorting by commute time." + "description": "Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time." }, "companyDisplayNames": { - "description": "Optional. This filter specifies the exact company display\nname of the jobs to search against.\n\nIf a value isn't specified, jobs within the search results are\nassociated with any company.\n\nIf multiple values are specified, jobs within the search results may be\nassociated with any of the specified companies.\n\nAt most 20 company display name filters are allowed.", + "description": "Optional. This filter specifies the exact company display name of the jobs to search against. 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.", "items": { "type": "string" }, "type": "array" }, "companyNames": { - "description": "Optional. This filter specifies the company entities to search against.\n\nIf a value isn't specified, jobs are searched for against all\ncompanies.\n\nIf multiple values are specified, jobs are searched against the\ncompanies specified.\n\nThe format is \"projects/{project_id}/companies/{company_id}\", for example,\n\"projects/api-test-project/companies/foo\".\n\nAt most 20 company filters are allowed.", + "description": "Optional. 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}/companies/{company_id}\", for example, \"projects/api-test-project/companies/foo\". At most 20 company filters are allowed.", "items": { "type": "string" }, @@ -1995,31 +2732,18 @@ }, "compensationFilter": { "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to\nJob.compensation_info. For example, if the filter is specified\nas \"Hourly job with per-hour compensation > $15\", only jobs meeting\nthese criteria are searched. If a filter isn't defined, all open jobs\nare searched." + "description": "Optional. This search filter is applied only to 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." }, "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the\nJob.custom_attributes marked as `filterable`.\n\nThe syntax for this expression is a subset of SQL syntax.\n\nSupported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the\nleft of the operator is a custom field key and the right of the operator\nis a number or a quoted string. You must escape backslash (\\\\) and\nquote (\\\") characters.\n\nSupported functions are `LOWER([field_name])` to\nperform a case insensitive match and `EMPTY([field_name])` to filter on the\nexistence of a key.\n\nBoolean expressions (AND/OR/NOT) are supported up to 3 levels of\nnesting (for example, \"((A AND B AND C) OR NOT D) AND E\"), a maximum of 100\ncomparisons or functions are allowed in the expression. The expression\nmust be < 6000 bytes in length.\n\nSample Query:\n`(LOWER(driving_license)=\"class \\\"a\\\"\" OR EMPTY(driving_license)) AND\ndriving_years > 10`", + "description": "Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)=\"class \\\"a\\\"\" OR EMPTY(driving_license)) AND driving_years > 10`", "type": "string" }, "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the\nservice attempts to correct a misspelled query,\nfor example, \"enginee\" is corrected to \"engineer\".\n\nDefaults to false: a spell check is performed.", + "description": "Optional. 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": "boolean" }, "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to\nsearch against, such as EmploymentType.FULL_TIME.\n\nIf a value is not specified, jobs in the search results includes any\nemployment type.\n\nIf multiple values are specified, jobs in the search results include\nany of the specified employment types.", - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full\ntime employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job,\ntypically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee,\nposition.", - "The job is offered as a contracted position with the understanding\nthat it's converted into a full-time position at the end of the\ncontract. Jobs of this type are also returned by a search for\nEmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually\na short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job\nseekers to obtain on-the-job training, typically offered as a summer\nposition.", - "The is an opportunity for an individual to volunteer, where there's no\nexpectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a\nflexible schedule.", - "The job involves employing people in remote areas and flying them\ntemporarily to the work site instead of relocating employees and their\nfamilies permanently.", - "The job does not fit any of the other listed types." - ], + "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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.", "items": { "enum": [ "EMPLOYMENT_TYPE_UNSPECIFIED", @@ -2034,52 +2758,32 @@ "FLY_IN_FLY_OUT", "OTHER_EMPLOYMENT_TYPE" ], + "enumDescriptions": [ + "The default value if the employment type is not specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "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 jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "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.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], "type": "string" }, "type": "array" }, "excludedJobs": { - "description": "Optional. This filter specifies a list of job names to be excluded during search.\n\nAt most 400 excluded job names are allowed.", + "description": "Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.", "items": { "type": "string" }, "type": "array" }, "jobCategories": { - "description": "Optional. The category filter specifies the categories of jobs to search against.\nSee Category for more information.\n\nIf a value is not specified, jobs from any category are searched against.\n\nIf multiple values are specified, jobs from any of the specified\ncategories are searched against.", - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category,\nsuch as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], + "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", "items": { "enum": [ "JOB_CATEGORY_UNSPECIFIED", @@ -2114,19 +2818,52 @@ "SPORTS_FITNESS_AND_RECREATION", "TRANSPORTATION_AND_LOGISTICS" ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], "type": "string" }, "type": "array" }, "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against,\nfor example, \"en-US\".\n\nIf a value isn't specified, the search results can contain jobs in any\nlocale.\n\n\nLanguage codes should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).\n\nAt most 10 language code filters are allowed.", + "description": "Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", "items": { "type": "string" }, "type": "array" }, "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to\nsearch against. See LocationFilter for more information.\n\nIf a location value isn't specified, jobs fitting the other search\ncriteria are retrieved regardless of where they're located.\n\nIf multiple values are specified, jobs are retrieved from any of the\nspecified locations. If different values are specified for the\nLocationFilter.distance_in_miles parameter, the maximum provided\ndistance is used for all locations.\n\nAt most 5 location filters are allowed.", + "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", "items": { "$ref": "LocationFilter" }, @@ -2134,21 +2871,21 @@ }, "publishTimeRange": { "$ref": "TimestampRange", - "description": "Optional. Jobs published within a range specified by this filter are searched\nagainst." + "description": "Optional. Jobs published within a range specified by this filter are searched against." }, "query": { - "description": "Optional. The query string that matches against the job title, description, and\nlocation fields.\n\nThe maximum number of allowed characters is 255.", + "description": "Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.", "type": "string" }, "queryLanguageCode": { - "description": "The language code of query. For example, \"en-US\". This field helps to\nbetter interpret the query.\n\nIf a value isn't specified, the query language code is automatically\ndetected, which may not be accurate.\n\nLanguage code should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\n[Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "description": "The language code of 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](https://tools.ietf.org/html/bcp47).", "type": "string" } }, "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\nWGS84\nstandard. Values must be within normalized ranges.", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -2165,7 +2902,7 @@ "type": "object" }, "ListCompaniesResponse": { - "description": "Output only.\n\nThe List companies response object.", + "description": "Output only. The List companies response object.", "id": "ListCompaniesResponse", "properties": { "companies": { @@ -2177,7 +2914,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2187,11 +2924,11 @@ "type": "object" }, "ListJobsResponse": { - "description": "Output only.\n\nList jobs response.", + "description": "Output only. List jobs response.", "id": "ListJobsResponse", "properties": { "jobs": { - "description": "The Jobs for a given company.\n\nThe maximum number of items returned is based on the limit field\nprovided in the request.", + "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", "items": { "$ref": "Job" }, @@ -2199,7 +2936,7 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { "description": "A token to retrieve the next page of results.", @@ -2209,7 +2946,7 @@ "type": "object" }, "Location": { - "description": "Output only.\n\nA resource that represents a location with full geographic information.", + "description": "Output only. A resource that represents a location with full geographic information.", "id": "Location", "properties": { "latLng": { @@ -2217,7 +2954,7 @@ "description": "An object representing a latitude/longitude pair." }, "locationType": { - "description": "The type of a location, which corresponds to the address lines field of\nPostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of\nLocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of\nLocationType#LOCALITY.", + "description": "The type of a location, which corresponds to the address lines field of PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType#LOCALITY.", "enum": [ "LOCATION_TYPE_UNSPECIFIED", "COUNTRY", @@ -2238,7 +2975,7 @@ "A county or equivalent level location.", "A city or equivalent level location.", "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough,\nward, or arrondissement. Sublocalities are usually recognized by a local\npolitical authority. For example, Manhattan and Brooklyn are recognized\nas boroughs by the City of New York, and are therefore modeled as\nsublocalities.", + "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.", "A district or equivalent level location.", "A smaller district or equivalent level display.", "A neighborhood level location.", @@ -2248,10 +2985,10 @@ }, "postalAddress": { "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information,\nsuch as postal delivery and payments addresses. Given a postal address,\na postal service can deliver items to a premises, P.O. Box, or other\ndelivery location." + "description": "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." }, "radiusInMiles": { - "description": "Radius in miles of the job location. This value is derived from the\nlocation bounding box in which a circle with the specified radius\ncentered from LatLng covers the area associated with the job location.\nFor example, currently, \"Mountain View, CA, USA\" has a radius of\n6.17 miles.", + "description": "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 LatLng covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", "format": "double", "type": "number" } @@ -2259,7 +2996,7 @@ "type": "object" }, "LocationFilter": { - "description": "Input only.\n\nGeographic region of the search.", + "description": "Input only. Geographic region of the search.", "id": "LocationFilter", "properties": { "address": { @@ -2267,20 +3004,20 @@ "type": "string" }, "distanceInMiles": { - "description": "Optional. The distance_in_miles is applied when the location being searched for is\nidentified as a city or smaller. When the location being searched for is a\nstate or larger, this field is ignored.", + "description": "Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.", "format": "double", "type": "number" }, "latLng": { "$ref": "LatLng", - "description": "Optional. The latitude and longitude of the geographic center from which to\nsearch. This field's ignored if `address` is provided." + "description": "Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if `address` is provided." }, "regionCode": { - "description": "Optional. CLDR region code of the country/region of the address. This is used\nto address ambiguity of the user-input location, for example, \"Liverpool\"\nagainst \"Liverpool, NY, US\" or \"Liverpool, UK\".\n\nSet this field if all the jobs to search against are from a same region,\nor jobs are world-wide, but the job seeker is from a specific region.\n\nSee http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, \"Liverpool\" against \"Liverpool, NY, US\" or \"Liverpool, UK\". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "telecommutePreference": { - "description": "Optional. Allows the client to return jobs without a\nset location, specifically, telecommuting jobs (telecommuting is considered\nby the service as a special location.\nJob.posting_region indicates if a job permits telecommuting.\nIf this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED,\ntelecommuting jobs are searched, and address and lat_lng are\nignored. If not set or set to\nTelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not\nsearched.\n\nThis filter can be used by itself to search exclusively for telecommuting\njobs, or it can be combined with another location\nfilter to search for a combination of job locations,\nsuch as \"Mountain View\" or \"telecommuting\" jobs. However, when used in\ncombination with other location filters, telecommuting jobs can be\ntreated as less relevant than other jobs in the search response.", + "description": "Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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.", "enum": [ "TELECOMMUTE_PREFERENCE_UNSPECIFIED", "TELECOMMUTE_EXCLUDED", @@ -2297,41 +3034,41 @@ "type": "object" }, "MatchingJob": { - "description": "Output only.\n\nJob entry with metadata inside SearchJobsResponse.", + "description": "Output only. Job entry with metadata inside SearchJobsResponse.", "id": "MatchingJob", "properties": { "commuteInfo": { "$ref": "CommuteInfo", - "description": "Commute information which is generated based on specified\n CommuteFilter." + "description": "Commute information which is generated based on specified CommuteFilter." }, "job": { "$ref": "Job", "description": "Job resource that matches the specified SearchJobsRequest." }, "jobSummary": { - "description": "A summary of the job with core information that's displayed on the search\nresults listing page.", + "description": "A summary of the job with core information that's displayed on the search results listing page.", "type": "string" }, "jobTitleSnippet": { - "description": "Contains snippets of text from the Job.job_title field most\nclosely matching a search query's keywords, if available. The matching\nquery keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.", "type": "string" }, "searchTextSnippet": { - "description": "Contains snippets of text from the Job.description and similar\nfields that most closely match a search query's keywords, if available.\nAll HTML tags in the original fields are stripped when returned in this\nfield, and matching query keywords are enclosed in HTML bold tags.", + "description": "Contains snippets of text from the 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": "string" } }, "type": "object" }, "MendelDebugInput": { - "description": "Message representing input to a Mendel server for debug forcing.\nSee go/mendel-debug-forcing for more details.\nNext ID: 2", + "description": "Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2", "id": "MendelDebugInput", "properties": { "namespacedDebugInput": { "additionalProperties": { "$ref": "NamespacedDebugInput" }, - "description": "When a request spans multiple servers, a MendelDebugInput may travel with\nthe request and take effect in all the servers. This field is a map of\nnamespaces to NamespacedMendelDebugInput protos. In a single server, up to\ntwo NamespacedMendelDebugInput protos are applied:\n1. NamespacedMendelDebugInput with the global namespace (key == \"\").\n2. NamespacedMendelDebugInput with the server's namespace.\nWhen both NamespacedMendelDebugInput protos are present, they are merged.\nSee go/mendel-debug-forcing for more details.", + "description": "When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == \"\"). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.", "type": "object" } }, @@ -2346,12 +3083,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } @@ -2363,21 +3100,21 @@ "id": "NamespacedDebugInput", "properties": { "absolutelyForcedExpNames": { - "description": "Set of experiment names to be absolutely forced.\nThese experiments will be forced without evaluating the conditions.", + "description": "Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExpTags": { - "description": "Set of experiment tags to be absolutely forced.\nThe experiments with these tags will be forced without evaluating the\nconditions.", + "description": "Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.", "items": { "type": "string" }, "type": "array" }, "absolutelyForcedExps": { - "description": "Set of experiment ids to be absolutely forced.\nThese ids will be forced without evaluating the conditions.", + "description": "Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.", "items": { "format": "int32", "type": "integer" @@ -2385,21 +3122,21 @@ "type": "array" }, "conditionallyForcedExpNames": { - "description": "Set of experiment names to be conditionally forced.\nThese experiments will be forced only if their conditions and their\nparent domain's conditions are true.", + "description": "Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExpTags": { - "description": "Set of experiment tags to be conditionally forced.\nThe experiments with these tags will be forced only if their conditions\nand their parent domain's conditions are true.", + "description": "Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.", "items": { "type": "string" }, "type": "array" }, "conditionallyForcedExps": { - "description": "Set of experiment ids to be conditionally forced.\nThese ids will be forced only if their conditions and their parent\ndomain's conditions are true.", + "description": "Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.", "items": { "format": "int32", "type": "integer" @@ -2407,25 +3144,25 @@ "type": "array" }, "disableAutomaticEnrollmentSelection": { - "description": "If true, disable automatic enrollment selection (at all diversion\npoints). Automatic enrollment selection means experiment selection\nprocess based on the experiment's automatic enrollment condition. This\ndoes not disable selection of forced experiments.", + "description": "If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.", "type": "boolean" }, "disableExpNames": { - "description": "Set of experiment names to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If a name corresponds to a domain, the domain\nitself and all descendant experiments and domains are disabled together.", + "description": "Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExpTags": { - "description": "Set of experiment tags to be disabled. All experiments that are tagged\nwith one or more of these tags are disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together.", + "description": "Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.", "items": { "type": "string" }, "type": "array" }, "disableExps": { - "description": "Set of experiment ids to be disabled.\nIf an experiment is disabled, it is never selected nor forced.\nIf an aggregate experiment is disabled, its partitions are disabled\ntogether. If an experiment with an enrollment is disabled, the enrollment\nis disabled together. If an ID corresponds to a domain, the domain itself\nand all descendant experiments and domains are disabled together.", + "description": "Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", "items": { "format": "int32", "type": "integer" @@ -2433,36 +3170,36 @@ "type": "array" }, "disableManualEnrollmentSelection": { - "description": "If true, disable manual enrollment selection (at all diversion points).\nManual enrollment selection means experiment selection process based on\nthe request's manual enrollment states (a.k.a. opt-in experiments).\nThis does not disable selection of forced experiments.", + "description": "If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.", "type": "boolean" }, "disableOrganicSelection": { - "description": "If true, disable organic experiment selection (at all diversion points).\nOrganic selection means experiment selection process based on traffic\nallocation and diversion condition evaluation.\nThis does not disable selection of forced experiments.\n\nThis is useful in cases when it is not known whether experiment selection\nbehavior is responsible for a error or breakage. Disabling organic\nselection may help to isolate the cause of a given problem.", + "description": "If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.", "type": "boolean" }, "forcedFlags": { "additionalProperties": { "type": "string" }, - "description": "Flags to force in a particular experiment state.\nMap from flag name to flag value.", + "description": "Flags to force in a particular experiment state. Map from flag name to flag value.", "type": "object" }, "forcedRollouts": { "additionalProperties": { "type": "boolean" }, - "description": "Rollouts to force in a particular experiment state.\nMap from rollout name to rollout value.", + "description": "Rollouts to force in a particular experiment state. Map from rollout name to rollout value.", "type": "object" } }, "type": "object" }, "NumericBucketingOption": { - "description": "Input only.\n\nUse this field to specify bucketing option for the histogram search response.", + "description": "Input only. Use this field to specify bucketing option for the histogram search response.", "id": "NumericBucketingOption", "properties": { "bucketBounds": { - "description": "Required. Two adjacent values form a histogram bucket. Values should be in\nascending order. For example, if [5, 10, 15] are provided, four buckets are\ncreated: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20\n[buckets_bound is supported.", + "description": "Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported.", "items": { "format": "double", "type": "number" @@ -2470,30 +3207,30 @@ "type": "array" }, "requiresMinMax": { - "description": "Optional. If set to true, the histogram result includes minimum/maximum\nvalue of the numeric field.", + "description": "Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.", "type": "boolean" } }, "type": "object" }, "NumericBucketingResult": { - "description": "Output only.\n\nCustom numeric bucketing result.", + "description": "Output only. Custom numeric bucketing result.", "id": "NumericBucketingResult", "properties": { "counts": { - "description": "Count within each bucket. Its size is the length of\nNumericBucketingOption.bucket_bounds plus 1.", + "description": "Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.", "items": { "$ref": "BucketizedCount" }, "type": "array" }, "maxValue": { - "description": "Stores the maximum value of the numeric field. Is populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the maximum value of the numeric field. Is populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" }, "minValue": { - "description": "Stores the minimum value of the numeric field. Will be populated only if\n[NumericBucketingOption.requires_min_max] is set to true.", + "description": "Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", "format": "double", "type": "number" } @@ -2501,11 +3238,11 @@ "type": "object" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "properties": { "done": { - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { @@ -2517,11 +3254,11 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "response": { @@ -2529,33 +3266,33 @@ "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses.\nGiven a postal address, a postal service can deliver items to a premise, P.O.\nBox or similar.\nIt is not intended to model geographical locations (roads, towns,\nmountains).\n\nIn typical usage an address would be created via user input or from importing\nexisting data, depending on the type of process.\n\nAdvice on address input / editing:\n - Use an i18n-ready address widget such as\n https://github.com/google/libaddressinput)\n- Users should not be presented with UI elements for input or editing of\n fields outside countries where that field is used.\n\nFor more guidance on how to use this schema, please see:\nhttps://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address.\n\nBecause values in address_lines do not have type information and may\nsometimes contain multiple values in a single field (e.g.\n\"Austin, TX\"), it is important that the line order is clear. The order of\naddress lines should be \"envelope order\" for the country/region of the\naddress. In places where this can vary (e.g. Japan), address_language is\nused to make it explicit (e.g. \"ja\" for large-to-small ordering and\n\"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of\nan address can be selected based on the language.\n\nThe minimum permitted structural representation of an address consists\nof a region_code with all remaining information placed in the\naddress_lines. It would be possible to format such an address very\napproximately without geocoding, but no semantic reasoning could be\nmade about any of the address components until it was at least\npartially resolved.\n\nCreating an address only containing a region_code and address_lines, and\nthen geocoding is the recommended way to handle completely unstructured\naddresses (as opposed to guessing which parts of the address should be\nlocalities or administrative areas).", + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", "items": { "type": "string" }, "type": "array" }, "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal\naddresses of a country or region.\nFor example, this can be a state, a province, an oblast, or a prefecture.\nSpecifically, for Spain this is the province and not the autonomous\ncommunity (e.g. \"Barcelona\" and not \"Catalonia\").\nMany countries don't use an administrative area in postal addresses. E.g.\nin Switzerland this should be left unpopulated.", + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", "type": "string" }, "languageCode": { - "description": "Optional. BCP-47 language code of the contents of this address (if\nknown). This is often the UI language of the input form or is expected\nto match one of the languages used in the address' country/region, or their\ntransliterated equivalents.\nThis can affect formatting in certain countries, but is not critical\nto the correctness of the data and will never affect any validation or\nother non-formatting related operations.\n\nIf this value is not known, it should be omitted (rather than specifying a\npossibly incorrect default).\n\nExamples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", "type": "string" }, "locality": { - "description": "Optional. Generally refers to the city/town portion of the address.\nExamples: US city, IT comune, UK post town.\nIn regions of the world where localities are not well defined or do not fit\ninto this structure well, leave locality empty and use address_lines.", + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", "type": "string" }, "organization": { @@ -2563,46 +3300,46 @@ "type": "string" }, "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require\npostal codes to be present, but where they are used, they may trigger\nadditional validation with other parts of the address (e.g. state/zip\nvalidation in the U.S.A.).", + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", "type": "string" }, "recipients": { - "description": "Optional. The recipient at the address.\nThis field may, under certain circumstances, contain multiline information.\nFor example, it might contain \"care of\" information.", + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", "items": { "type": "string" }, "type": "array" }, "regionCode": { - "description": "Required. CLDR region code of the country/region of the address. This\nis never inferred and it is up to the user to ensure the value is\ncorrect. See http://cldr.unicode.org/ and\nhttp://www.unicode.org/cldr/charts/30/supplemental/territory_information.html\nfor details. Example: \"CH\" for Switzerland.", + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", "type": "string" }, "revision": { - "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is\nthe latest revision.\n\nAll new revisions **must** be backward compatible with old revisions.", + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", "format": "int32", "type": "integer" }, "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used\nin most regions. Where it is used, the value is either a string like\n\"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number\nalone, representing the \"sector code\" (Jamaica), \"delivery area indicator\"\n(Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", "type": "string" }, "sublocality": { - "description": "Optional. Sublocality of the address.\nFor example, this can be neighborhoods, boroughs, districts.", + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", "type": "string" } }, "type": "object" }, "ProcessingOptions": { - "description": "Input only.\n\nOptions for job processing.", + "description": "Input only. Options for job processing.", "id": "ProcessingOptions", "properties": { "disableStreetAddressResolution": { - "description": "Optional. If set to `true`, the service does not attempt to resolve a\nmore precise address for the job.", + "description": "Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", "type": "boolean" }, "htmlSanitization": { - "description": "Optional. Option for job HTML content sanitization. Applied fields are:\n\n* description\n* applicationInfo.instruction\n* incentives\n* qualifications\n* responsibilities\n\nHTML tags in these fields may be stripped if sanitiazation is not\ndisabled.\n\nDefaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", + "description": "Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", "enum": [ "HTML_SANITIZATION_UNSPECIFIED", "HTML_SANITIZATION_DISABLED", @@ -2611,7 +3348,7 @@ "enumDescriptions": [ "Default value.", "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and\nunordered list markup tags." + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." ], "type": "string" } @@ -2619,67 +3356,67 @@ "type": "object" }, "RequestMetadata": { - "description": "Input only.\n\nMeta information related to the job searcher or entity\nconducting the job search. This information is used to improve the\nperformance of the service.", + "description": "Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.", "id": "RequestMetadata", "properties": { "deviceInfo": { "$ref": "DeviceInfo", - "description": "Optional. The type of device used by the job seeker at the time of the call to the\nservice." + "description": "Optional. The type of device used by the job seeker at the time of the call to the service." }, "domain": { - "description": "Required. The client-defined scope or source of the service call, which typically\nis the domain on\nwhich the service has been implemented and is currently being run.\n\nFor example, if the service is being run by client Foo, Inc., on\njob board www.foo.com and career site www.bar.com, then this field is\nset to \"foo.com\" for use on the job board, and \"bar.com\" for use on the\ncareer site.\n\nIf this field isn't available for some reason, send \"UNKNOWN\".\nAny improvements to the model for a particular tenant site rely on this\nfield being set correctly to a domain.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field isn't available for some reason, send \"UNKNOWN\". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255.", "type": "string" }, "sessionId": { - "description": "Required. A unique session identification string. A session is defined as the\nduration of an end user's interaction with the service over a certain\nperiod.\nObfuscate this field for privacy concerns before\nproviding it to the service.\n\nIf this field is not available for some reason, send \"UNKNOWN\". Note\nthat any improvements to the model for a particular tenant\nsite, rely on this field being set correctly to some unique session_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field is not available for some reason, send \"UNKNOWN\". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255.", "type": "string" }, "userId": { - "description": "Required. A unique user identification string, as determined by the client.\nTo have the strongest positive impact on search quality\nmake sure the client-level is unique.\nObfuscate this field for privacy concerns before\nproviding it to the service.\n\nIf this field is not available for some reason, send \"UNKNOWN\". Note\nthat any improvements to the model for a particular tenant\nsite, rely on this field being set correctly to a unique user_id.\n\nThe maximum number of allowed characters is 255.", + "description": "Required. 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. If this field is not available for some reason, send \"UNKNOWN\". 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": "string" } }, "type": "object" }, "ResponseMetadata": { - "description": "Output only.\n\nAdditional information returned to client, such as debugging information.", + "description": "Output only. Additional information returned to client, such as debugging information.", "id": "ResponseMetadata", "properties": { "requestId": { - "description": "A unique id associated with this call.\nThis id is logged for tracking purposes.", + "description": "A unique id associated with this call. This id is logged for tracking purposes.", "type": "string" } }, "type": "object" }, "SearchJobsRequest": { - "description": "Input only.\n\nThe Request body of the `SearchJobs` call.", + "description": "Input only. The Request body of the `SearchJobs` call.", "id": "SearchJobsRequest", "properties": { "customRankingInfo": { "$ref": "CustomRankingInfo", - "description": "Optional. Controls over how job documents get ranked on top of existing relevance\nscore (determined by API algorithm)." + "description": "Optional. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm)." }, "disableKeywordMatch": { - "description": "Optional. Controls whether to disable exact keyword match on Job.job_title,\nJob.description, Job.company_display_name, Job.locations,\nJob.qualifications. When disable keyword match is turned off, a\nkeyword match returns jobs that do not match given category filters when\nthere are matching keywords. For example, the query \"program manager,\" a\nresult is returned even if the job posting has the title \"software\ndeveloper,\" which does not fall into \"program manager\" ontology, but does\nhave \"program manager\" appearing in its description.\n\nFor queries like \"cloud\" that does not contain title or\nlocation specific ontology, jobs with \"cloud\" keyword matches are returned\nregardless of this flag's value.\n\nPlease use Company.keyword_searchable_custom_fields or\nCompany.keyword_searchable_custom_attributes if company specific\nglobally matched custom field/attribute string values is needed. Enabling\nkeyword match improves recall of subsequent search requests.\n\nDefaults to false.", + "description": "Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query \"program manager,\" a result is returned even if the job posting has the title \"software developer,\" which does not fall into \"program manager\" ontology, but does have \"program manager\" appearing in its description. For queries like \"cloud\" that does not contain title or location specific ontology, jobs with \"cloud\" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.", "type": "boolean" }, "diversificationLevel": { - "description": "Optional. Controls whether highly similar jobs are returned next to each other in\nthe search results. Jobs are identified as highly similar based on\ntheir titles, job categories, and locations. Highly similar results are\nclustered so that only one representative job of the cluster is\ndisplayed to the job seeker higher up in the results, with the other jobs\nbeing displayed lower down in the results.\n\nDefaults to DiversificationLevel.SIMPLE if no value\nis specified.", + "description": "Optional. 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 if no value is specified.", "enum": [ "DIVERSIFICATION_LEVEL_UNSPECIFIED", "DISABLED", "SIMPLE" ], "enumDescriptions": [ - "The diversification level isn't specified. By default, jobs with this\nenum are ordered according to SIMPLE diversifying behavior.", - "Disables diversification. Jobs that would normally be pushed to the last\npage would not have their positions altered. This may result in highly\nsimilar jobs appearing in sequence in the search results.", - "Default diversifying behavior. The result list is ordered so that\nhighly similar results are pushed to the end of the last page of search\nresults." + "The diversification level isn't specified. By default, jobs with this enum are ordered according to SIMPLE diversifying behavior.", + "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.", + "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." ], "type": "string" }, "enableBroadening": { - "description": "Optional. Controls whether to broaden the search when it produces sparse results.\nBroadened queries append results to the end of the matching results\nlist.\n\nDefaults to false.", + "description": "Optional. 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": "boolean" }, "histogramFacets": { @@ -2698,7 +3435,7 @@ "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." }, "jobView": { - "description": "Optional. The desired job attributes returned for jobs in the\nsearch response. Defaults to JobView.SMALL if no value is specified.", + "description": "Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified.", "enum": [ "JOB_VIEW_UNSPECIFIED", "JOB_VIEW_ID_ONLY", @@ -2708,50 +3445,50 @@ ], "enumDescriptions": [ "Default value.", - "A ID only view of job, with following attributes:\nJob.name, Job.requisition_id, Job.language_code.", - "A minimal view of the job, with the following attributes:\nJob.name, Job.requisition_id, Job.title,\nJob.company_name, Job.DerivedInfo.locations, Job.language_code.", - "A small view of the job, with the following attributes in the search\nresults: Job.name, Job.requisition_id, Job.title,\nJob.company_name, Job.DerivedInfo.locations, Job.visibility,\nJob.language_code, Job.description.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company_name, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", "All available attributes are included in the search results." ], "type": "string" }, "offset": { - "description": "Optional. An integer that specifies the current offset (that is, starting result\nlocation, amongst the jobs deemed by the API as relevant) in search\nresults. This field is only considered if page_token is unset.\n\nThe maximum allowed value is 5000. Otherwise an error is thrown.\n\nFor example, 0 means to return results starting from the first matching\njob, and 10 means to return from the 11th job. This can be used for\npagination, (for example, pageSize = 10 and offset = 10 means to return\nfrom the second page).", + "description": "Optional. 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 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).", "format": "int32", "type": "integer" }, "orderBy": { - "description": "Optional. The criteria determining how search results are sorted. Default is\n\"relevance desc\".\n\nSupported options are:\n\n* `\"relevance desc\"`: By relevance descending, as determined by the API\nalgorithms. Relevance thresholding of query results is only available\nwith this ordering.\n* `\"posting_publish_time desc\"`: By Job.posting_publish_time\ndescending.\n* `\"posting_update_time desc\"`: By Job.posting_update_time\ndescending.\n* `\"title\"`: By Job.title ascending.\n* `\"title desc\"`: By Job.title descending.\n* `\"annualized_base_compensation\"`: By job's\nCompensationInfo.annualized_base_compensation_range ascending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_base_compensation desc\"`: By job's\nCompensationInfo.annualized_base_compensation_range descending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_total_compensation\"`: By job's\nCompensationInfo.annualized_total_compensation_range ascending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"annualized_total_compensation desc\"`: By job's\nCompensationInfo.annualized_total_compensation_range descending. Jobs\nwhose annualized base compensation is unspecified are put at the end of\nsearch results.\n* `\"custom_ranking desc\"`: By the relevance score adjusted to the\nSearchJobsRequest.custom_ranking_info.ranking_expression with weight\nfactor assigned by\nSearchJobsRequest.custom_ranking_info.importance_level in descending\norder.\n* Location sorting: Use the special syntax to order jobs by distance:
\n\"`distance_from('Hawaii')`\": Order by distance from Hawaii.
\n\"`distance_from(19.89, 155.5)`\": Order by distance from a coordinate.
\n\"`distance_from('Hawaii'), distance_from('Puerto Rico')`\": Order by\nmultiple locations. See details below.
\n\"`distance_from('Hawaii'), distance_from(19.89, 155.5)`\": Order by\nmultiple locations. See details below.
\nThe string can have a maximum of 256 characters. When multiple distance\ncenters are provided, a job that is close to any of the distance centers\nwould have a high rank. When a job has multiple locations, the job location\nclosest to one of the distance centers will be used. Jobs that don't have\nlocations will be ranked at the bottom. Distance is calculated with a\nprecision of 11.3 meters (37.4 feet). Diversification strategy is still\napplied unless explicitly disabled in\ndiversification_level.", + "description": "Optional. 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 descending. * `\"posting_update_time desc\"`: By Job.posting_update_time descending. * `\"title\"`: By Job.title ascending. * `\"title desc\"`: By Job.title descending. * `\"annualized_base_compensation\"`: By job's 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 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 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 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.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.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.", "type": "string" }, "pageSize": { - "description": "Optional. A limit on the number of jobs returned in the search results.\nIncreasing this value above the default value of 10 can increase search\nresponse time. The value can be between 1 and 100.", + "description": "Optional. 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.", "format": "int32", "type": "integer" }, "pageToken": { - "description": "Optional. The token specifying the current offset within\nsearch results. See SearchJobsResponse.next_page_token for\nan explanation of how to obtain the next set of query results.", + "description": "Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.", "type": "string" }, "requestMetadata": { "$ref": "RequestMetadata", - "description": "Required. The meta information collected about the job searcher, used to improve the\nsearch quality of the service. The identifiers (such as `user_id`) are\nprovided by users, and must be unique and consistent." + "description": "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." }, "requirePreciseResultSize": { - "description": "Optional. Controls if the search job request requires the return of a precise\ncount of the first 300 results. Setting this to `true` ensures\nconsistency in the number of results per page. Best practice is to set this\nvalue to true if a client allows users to jump directly to a\nnon-sequential search results page.\n\nEnabling this flag may adversely impact performance.\n\nDefaults to false.", + "description": "This field is deprecated.", "type": "boolean" }, "searchMode": { - "description": "Optional. Mode of a search.\n\nDefaults to SearchMode.JOB_SEARCH.", + "description": "Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH.", "enum": [ "SEARCH_MODE_UNSPECIFIED", "JOB_SEARCH", "FEATURED_JOB_SEARCH" ], "enumDescriptions": [ - "The mode of the search method isn't specified. The default search\nbehavior is identical to JOB_SEARCH search behavior.", - "The job search matches against all jobs, and featured jobs\n(jobs with promotionValue > 0) are not specially handled.", - "The job search matches only against featured jobs (jobs with a\npromotionValue > 0). This method doesn't return any jobs having a\npromotionValue <= 0. The search results order is determined by the\npromotionValue (jobs with a higher promotionValue are returned higher up\nin the search results), with relevance being used as a tiebreaker." + "The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior.", + "The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.", + "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." ], "type": "string" } @@ -2759,21 +3496,21 @@ "type": "object" }, "SearchJobsResponse": { - "description": "Output only.\n\nResponse for SearchJob method.", + "description": "Output only. Response for SearchJob method.", "id": "SearchJobsResponse", "properties": { "broadenedQueryJobsCount": { - "description": "If query broadening is enabled, we may append additional results from the\nbroadened query. This number indicates how many of the jobs returned in the\njobs field are from the broadened query. These results are always at the\nend of the jobs list. In particular, a value of 0, or if the field isn't\nset, all the jobs in the jobs list are from the original\n(without broadening) query. If this field is non-zero, subsequent requests\nwith offset after this result set should contain all broadened results.", + "description": "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.", "format": "int32", "type": "integer" }, "estimatedTotalSize": { - "description": "An estimation of the number of jobs that match the specified query.\n\nThis number is not guaranteed to be accurate. For accurate results,\nsee enable_precise_result_size.", + "description": "An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size.", "format": "int32", "type": "integer" }, "histogramQueryResults": { - "description": "The histogram results that match with specified\nSearchJobsRequest.histogram_queries.", + "description": "The histogram results that match with specified SearchJobsRequest.histogram_queries.", "items": { "$ref": "HistogramQueryResult" }, @@ -2781,10 +3518,10 @@ }, "histogramResults": { "$ref": "HistogramResults", - "description": "The histogram results that match specified\nSearchJobsRequest.histogram_facets." + "description": "The histogram results that match specified SearchJobsRequest.histogram_facets." }, "locationFilters": { - "description": "The location filters that the service applied to the specified query. If\nany filters are lat-lng based, the JobLocation.location_type is\nJobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", + "description": "The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", "items": { "$ref": "Location" }, @@ -2799,10 +3536,10 @@ }, "metadata": { "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request\ntracking id." + "description": "Additional information for the API invocation, such as the request tracking id." }, "nextPageToken": { - "description": "The token that specifies the starting position of the next page of results.\nThis field is empty if there are no more results.", + "description": "The token that specifies the starting position of the next page of results. This field is empty if there are no more results.", "type": "string" }, "spellCorrection": { @@ -2810,7 +3547,7 @@ "description": "The spell checking result, and correction." }, "totalSize": { - "description": "The precise result count, which is available only if the client set\nenable_precise_result_size to `true`, or if the response\nis the last page of results. Otherwise, the value is `-1`.", + "description": "The precise result count with limit 100,000.", "format": "int32", "type": "integer" } @@ -2818,7 +3555,7 @@ "type": "object" }, "SpellingCorrection": { - "description": "Output only.\n\nSpell check result.", + "description": "Output only. Spell check result.", "id": "SpellingCorrection", "properties": { "corrected": { @@ -2833,7 +3570,7 @@ "type": "object" }, "Status": { - "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { @@ -2842,7 +3579,7 @@ "type": "integer" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -2853,18 +3590,18 @@ "type": "array" }, "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, "TimeOfDay": { - "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.", + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, @@ -2879,7 +3616,7 @@ "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } @@ -2904,7 +3641,7 @@ "type": "object" }, "UpdateCompanyRequest": { - "description": "Input only.\n\nRequest for updating a specified company.", + "description": "Input only. Request for updating a specified company.", "id": "UpdateCompanyRequest", "properties": { "company": { @@ -2912,7 +3649,7 @@ "description": "Required. The company resource to replace the current resource in the system." }, "updateMask": { - "description": "Optional but strongly recommended for the best service\nexperience.\n\nIf update_mask is provided, only the specified fields in\ncompany are updated. Otherwise all the fields are updated.\n\nA field mask to specify the company fields to be updated. Only\ntop level fields of Company are supported.", + "description": "Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported.", "format": "google-fieldmask", "type": "string" } @@ -2920,7 +3657,7 @@ "type": "object" }, "UpdateJobRequest": { - "description": "Input only.\n\nUpdate job request.", + "description": "Input only. Update job request.", "id": "UpdateJobRequest", "properties": { "job": { @@ -2928,7 +3665,7 @@ "description": "Required. The Job to be updated." }, "updateMask": { - "description": "Optional but strongly recommended to be provided for the best service\nexperience.\n\nIf update_mask is provided, only the specified fields in\njob are updated. Otherwise all the fields are updated.\n\nA field mask to restrict the fields that are updated. Only\ntop level fields of Job are supported.", + "description": "Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported.", "format": "google-fieldmask", "type": "string" } diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 01e04aabc9..ae57222ba1 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -132,11 +132,11 @@ export namespace jobs_v2 { } /** - * Input only. Batch delete jobs request. + * Input only. Batch delete jobs request. */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1" */ filter?: string | null; } @@ -167,7 +167,7 @@ export namespace jobs_v2 { to?: number | null; } /** - * Output only. Commute details related to this job. + * Output only. Commute details related to this job. */ export interface Schema$CommuteInfo { /** @@ -180,7 +180,7 @@ export namespace jobs_v2 { travelDuration?: string | null; } /** - * Input only. Parameters needed for commute search. + * Input only. Parameters needed for commute search. */ export interface Schema$CommutePreference { /** @@ -225,7 +225,7 @@ export namespace jobs_v2 { */ companySize?: string | null; /** - * Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. + * Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. */ disableLocationOptimization?: boolean | null; /** @@ -233,19 +233,19 @@ export namespace jobs_v2 { */ displayName?: string | null; /** - * Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. + * Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. */ distributorBillingCompanyId?: string | null; /** - * Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. + * Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. */ distributorCompanyId?: string | null; /** - * Optional. 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. + * Optional. 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. */ eeoText?: string | null; /** - * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean | null; /** @@ -253,7 +253,7 @@ export namespace jobs_v2 { */ hqLocation?: string | null; /** - * Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. + * Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. */ imageUrl?: string | null; /** @@ -261,11 +261,11 @@ export namespace jobs_v2 { */ keywordSearchableCustomAttributes?: string[] | null; /** - * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. + * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. */ keywordSearchableCustomFields?: number[] | null; /** - * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string | null; /** @@ -277,7 +277,7 @@ export namespace jobs_v2 { */ suspended?: boolean | null; /** - * Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". + * Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". */ title?: string | null; /** @@ -286,7 +286,7 @@ export namespace jobs_v2 { website?: string | null; } /** - * A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`. + * A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`. */ export interface Schema$CompanyInfoSource { /** @@ -307,7 +307,7 @@ export namespace jobs_v2 { unknownTypeId?: string | null; } /** - * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -315,7 +315,7 @@ export namespace jobs_v2 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string | null; /** @@ -331,12 +331,12 @@ export namespace jobs_v2 { */ type?: string | null; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string | null; } /** - * Input only. Filter on job compensation type and amount. + * Input only. Filter on job compensation type and amount. */ export interface Schema$CompensationFilter { /** @@ -357,7 +357,7 @@ export namespace jobs_v2 { units?: string[] | null; } /** - * Input only. Compensation based histogram request. + * Input only. Compensation based histogram request. */ export interface Schema$CompensationHistogramRequest { /** @@ -370,7 +370,7 @@ export namespace jobs_v2 { type?: string | null; } /** - * Output only. Compensation based histogram result. + * Output only. Compensation based histogram result. */ export interface Schema$CompensationHistogramResult { /** @@ -387,31 +387,31 @@ export namespace jobs_v2 { */ export interface Schema$CompensationInfo { /** - * Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation. + * Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation. */ amount?: Schema$Money; /** - * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; /** - * Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. + * Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. */ max?: Schema$Money; /** - * Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. + * Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. */ min?: Schema$Money; /** - * Deprecated. Use entries instead. Optional. Type of job compensation. + * Deprecated. Use entries instead. Optional. Type of job compensation. */ type?: string | null; } @@ -429,7 +429,7 @@ export namespace jobs_v2 { min?: Schema$Money; } /** - * Output only. Response of auto-complete query. + * Output only. Response of auto-complete query. */ export interface Schema$CompleteQueryResponse { /** @@ -442,7 +442,7 @@ export namespace jobs_v2 { metadata?: Schema$ResponseMetadata; } /** - * Output only. Resource that represents completion results. + * Output only. Resource that represents completion results. */ export interface Schema$CompletionResult { /** @@ -459,11 +459,11 @@ export namespace jobs_v2 { type?: string | null; } /** - * Input only. Create job request. + * Input only. Create job request. */ export interface Schema$CreateJobRequest { /** - * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean | null; /** @@ -480,15 +480,15 @@ export namespace jobs_v2 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ filterable?: boolean | null; /** - * Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed. + * Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed. */ longValue?: string | null; /** - * Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed. + * Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed. */ stringValues?: Schema$StringValues; } @@ -510,7 +510,7 @@ export namespace jobs_v2 { stringValueHistogram?: boolean | null; } /** - * Output only. Custom attribute histogram result. + * Output only. Custom attribute histogram result. */ export interface Schema$CustomAttributeHistogramResult { /** @@ -536,7 +536,7 @@ export namespace jobs_v2 { values?: string[] | null; } /** - * Input only. Custom field filter of the search. + * Input only. Custom field filter of the search. */ export interface Schema$CustomFieldFilter { /** @@ -549,7 +549,7 @@ export namespace jobs_v2 { type?: string | null; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** @@ -566,7 +566,7 @@ export namespace jobs_v2 { year?: number | null; } /** - * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes. */ export interface Schema$DeleteJobsByFilterRequest { /** @@ -579,7 +579,7 @@ export namespace jobs_v2 { filter?: Schema$Filter; } /** - * Input only. 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. + * Input only. 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. */ export interface Schema$DeviceInfo { /** @@ -592,11 +592,11 @@ export namespace jobs_v2 { id?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount. + * Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount. */ export interface Schema$ExtendedCompensationFilter { /** @@ -621,7 +621,7 @@ export namespace jobs_v2 { type?: string | null; } /** - * Deprecated. Use CompensationInfo. Describes job compensation. + * Deprecated. Use CompensationInfo. Describes job compensation. */ export interface Schema$ExtendedCompensationInfo { /** @@ -645,12 +645,12 @@ export namespace jobs_v2 { */ currency?: string | null; /** - * Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$ExtendedCompensationInfoCompensationEntry[]; } /** - * Deprecated. See CompensationInfo. A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + * Deprecated. See CompensationInfo. A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$ExtendedCompensationInfoCompensationEntry { /** @@ -674,7 +674,7 @@ export namespace jobs_v2 { */ type?: string | null; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string | null; /** @@ -683,7 +683,7 @@ export namespace jobs_v2 { unspecified?: boolean | null; } /** - * Deprecated. See CompensationInfo. Compensation range. + * Deprecated. See CompensationInfo. Compensation range. */ export interface Schema$ExtendedCompensationInfoCompensationRange { /** @@ -696,7 +696,7 @@ export namespace jobs_v2 { min?: Schema$ExtendedCompensationInfoDecimal; } /** - * Deprecated. See CompensationInfo. Decimal number. + * Deprecated. See CompensationInfo. Decimal number. */ export interface Schema$ExtendedCompensationInfoDecimal { /** @@ -709,7 +709,7 @@ export namespace jobs_v2 { units?: string | null; } /** - * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted. + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted. */ export interface Schema$Filter { /** @@ -718,15 +718,15 @@ export namespace jobs_v2 { requisitionId?: string | null; } /** - * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method. + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method. */ export interface Schema$GetHistogramRequest { /** - * Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false. + * Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false. */ allowBroadening?: boolean | null; /** - * Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram. + * Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram. */ filters?: Schema$JobFilters; /** @@ -738,12 +738,12 @@ export namespace jobs_v2 { */ requestMetadata?: Schema$RequestMetadata; /** - * Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution. + * Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution. */ searchTypes?: string[] | null; } /** - * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method. + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method. */ export interface Schema$GetHistogramResponse { /** @@ -756,7 +756,355 @@ export namespace jobs_v2 { results?: Schema$HistogramResult[]; } /** - * Input only. Histogram facets to be specified in SearchJobsRequest. + * The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchCreateJobsResponse { + /** + * List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchDeleteJobsResponse { + /** + * List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata. + */ + export interface Schema$GoogleCloudTalentV4BatchOperationMetadata { + /** + * The time when the batch operation is created. + */ + createTime?: string | null; + /** + * The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`. + */ + endTime?: string | null; + /** + * Count of failed item(s) inside an operation. + */ + failureCount?: number | null; + /** + * The state of a long running operation. + */ + state?: string | null; + /** + * More detailed information about operation state. + */ + stateDescription?: string | null; + /** + * Count of successful item(s) inside an operation. + */ + successCount?: number | null; + /** + * Count of total item(s) inside an operation. + */ + totalCount?: number | null; + /** + * The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned. + */ + updateTime?: string | null; + } + /** + * The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchUpdateJobsResponse { + /** + * List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Job compensation details. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfo { + /** + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedBaseCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedTotalCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job. + */ + entries?: Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry[]; + } + /** + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry { + /** + * Compensation amount. + */ + amount?: Schema$Money; + /** + * Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + */ + description?: string | null; + /** + * Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 + */ + expectedUnitsPerYear?: number | null; + /** + * Compensation range. + */ + range?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED. + */ + type?: string | null; + /** + * Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + */ + unit?: string | null; + } + /** + * Compensation range. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationRange { + /** + * 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 of min_compensation. + */ + maxCompensation?: Schema$Money; + /** + * 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 of max_compensation. + */ + minCompensation?: Schema$Money; + } + /** + * Custom attribute values that are either filterable or non-filterable. + */ + export interface Schema$GoogleCloudTalentV4CustomAttribute { + /** + * If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + */ + filterable?: boolean | null; + /** + * If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false. + */ + keywordSearchable?: boolean | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. + */ + longValues?: string[] | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed. + */ + stringValues?: string[] | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudTalentV4Job { + /** + * 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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. + */ + addresses?: string[] | null; + /** + * Job application information. + */ + applicationInfo?: Schema$GoogleCloudTalentV4JobApplicationInfo; + /** + * 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". + */ + company?: string | null; + /** + * Output only. Display name of the company listing the job. + */ + companyDisplayName?: string | null; + /** + * Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee. + */ + compensationInfo?: Schema$GoogleCloudTalentV4CompensationInfo; + /** + * 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + */ + customAttributes?: { + [key: string]: Schema$GoogleCloudTalentV4CustomAttribute; + } | null; + /** + * The desired education degrees for the job, such as Bachelors, Masters. + */ + degreeTypes?: string[] | null; + /** + * The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + */ + department?: string | null; + /** + * Output only. Derived details about the job posting. + */ + derivedInfo?: Schema$GoogleCloudTalentV4JobDerivedInfo; + /** + * 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, 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. + */ + description?: string | null; + /** + * The employment type(s) of a job, for example, full time or part time. + */ + employmentTypes?: string[] | null; + /** + * 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. + */ + incentives?: string | null; + /** + * The benefits included with the job. + */ + jobBenefits?: string[] | null; + /** + * The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobEndTime?: string | null; + /** + * The experience level associated with the job, such as "Entry Level". + */ + jobLevel?: string | null; + /** + * The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobStartTime?: string | null; + /** + * 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + */ + languageCode?: string | null; + /** + * 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". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + */ + name?: string | null; + /** + * Output only. The timestamp when this job posting was created. + */ + postingCreateTime?: string | null; + /** + * 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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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. + */ + postingExpireTime?: string | null; + /** + * 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. + */ + postingPublishTime?: string | null; + /** + * The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. + */ + postingRegion?: string | null; + /** + * Output only. The timestamp when this job posting was last updated. + */ + postingUpdateTime?: string | null; + /** + * Options for job processing. + */ + processingOptions?: Schema$GoogleCloudTalentV4JobProcessingOptions; + /** + * 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. + */ + promotionValue?: number | null; + /** + * 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 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. + */ + qualifications?: string | null; + /** + * 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, language_code and requisition_id. The maximum number of allowed characters is 255. + */ + requisitionId?: string | null; + /** + * A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + */ + responsibilities?: string | null; + /** + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + */ + title?: string | null; + /** + * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. + */ + visibility?: string | null; + } + /** + * Application related details of a job posting. + */ + export interface Schema$GoogleCloudTalentV4JobApplicationInfo { + /** + * 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. + */ + emails?: string[] | null; + /** + * 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. + */ + instruction?: string | null; + /** + * Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. + */ + uris?: string[] | null; + } + /** + * Derived details about the job posting. + */ + export interface Schema$GoogleCloudTalentV4JobDerivedInfo { + /** + * Job categories derived from Job.title and Job.description. + */ + jobCategories?: string[] | null; + /** + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. + */ + locations?: Schema$GoogleCloudTalentV4Location[]; + } + /** + * Options for job processing. + */ + export interface Schema$GoogleCloudTalentV4JobProcessingOptions { + /** + * If set to `true`, the service does not attempt to resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * 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. + */ + htmlSanitization?: string | null; + } + /** + * Mutation result of a job from a batch operation. + */ + export interface Schema$GoogleCloudTalentV4JobResult { + /** + * 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. + */ + job?: Schema$GoogleCloudTalentV4Job; + /** + * The status of the job processed. This field is populated if the processing of the job fails. + */ + status?: Schema$Status; + } + /** + * A resource that represents a location with full geographic information. + */ + export interface Schema$GoogleCloudTalentV4Location { + /** + * An object representing a latitude/longitude pair. + */ + latLng?: Schema$LatLng; + /** + * The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. + */ + locationType?: string | null; + /** + * 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. + */ + postalAddress?: Schema$PostalAddress; + /** + * 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 covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. + */ + radiusMiles?: number | null; + } + /** + * Input only. Histogram facets to be specified in SearchJobsRequest. */ export interface Schema$HistogramFacets { /** @@ -773,7 +1121,7 @@ export namespace jobs_v2 { simpleHistogramFacets?: string[] | null; } /** - * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -781,12 +1129,12 @@ export namespace jobs_v2 { */ searchType?: string | null; /** - * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number} | null; } /** - * Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest. + * Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** @@ -807,15 +1155,15 @@ export namespace jobs_v2 { */ export interface Schema$Job { /** - * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255. */ applicationEmailList?: string[] | null; /** - * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. 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. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. 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. */ applicationInstruction?: string | null; /** - * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000. + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000. */ applicationUrls?: string[] | null; /** @@ -827,11 +1175,11 @@ export namespace jobs_v2 { */ companyDisplayName?: string | null; /** - * Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id. + * Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id. */ companyName?: string | null; /** - * Deprecated. Use company_display_name instead. Output only. The name of the company listing the job. + * Deprecated. Use company_display_name instead. Output only. The name of the company listing the job. */ companyTitle?: string | null; /** @@ -843,19 +1191,19 @@ export namespace jobs_v2 { */ createTime?: string | null; /** - * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** - * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string | null; /** - * 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, 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. + * 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, 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. */ description?: string | null; /** - * Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255. + * Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255. */ distributorCompanyId?: string | null; /** @@ -871,23 +1219,23 @@ export namespace jobs_v2 { */ endDate?: Schema$Date; /** - * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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 requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not 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 is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_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. + * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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 requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not 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 is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_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. */ expireTime?: string | null; /** - * Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. + * Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. */ expiryDate?: Schema$Date; /** - * Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown. + * Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown. */ extendedCompensationInfo?: Schema$ExtendedCompensationInfo; /** - * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned. + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned. */ filterableCustomFields?: {[key: string]: Schema$CustomField} | null; /** - * Optional. 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. + * Optional. 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. */ incentives?: string | null; /** @@ -895,11 +1243,11 @@ export namespace jobs_v2 { */ jobLocations?: Schema$JobLocation[]; /** - * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ jobTitle?: string | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string | null; /** @@ -907,15 +1255,15 @@ export namespace jobs_v2 { */ level?: string | null; /** - * Optional but strongly recommended for the best service experience. Location(s) where the emploeyer 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original 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. + * Optional but strongly recommended for the best service experience. Location(s) where the emploeyer 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original 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. */ locations?: string[] | null; /** - * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string | null; /** - * Optional. 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. + * Optional. 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. */ promotionValue?: number | null; /** @@ -923,7 +1271,7 @@ export namespace jobs_v2 { */ publishDate?: Schema$Date; /** - * Optional. 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 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. + * Optional. 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 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. */ qualifications?: string | null; /** @@ -935,11 +1283,11 @@ export namespace jobs_v2 { */ region?: string | null; /** - * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255. */ requisitionId?: string | null; /** - * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. */ responsibilities?: string | null; /** @@ -947,7 +1295,7 @@ export namespace jobs_v2 { */ startDate?: Schema$Date; /** - * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string. + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string. */ unindexedCustomFields?: {[key: string]: Schema$CustomField} | null; /** @@ -960,23 +1308,23 @@ export namespace jobs_v2 { visibility?: string | null; } /** - * Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. + * Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. */ export interface Schema$JobFilters { /** - * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ categories?: string[] | null; /** - * Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time. */ commuteFilter?: Schema$CommutePreference; /** - * Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. + * Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. */ companyNames?: string[] | null; /** - * Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be 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 title filters are allowed. + * Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be 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 title filters are allowed. */ companyTitles?: string[] | null; /** @@ -984,31 +1332,31 @@ export namespace jobs_v2 { */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<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"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() 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"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ customAttributeFilter?: string | null; /** - * Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown. + * Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown. */ customFieldFilters?: {[key: string]: Schema$CustomFieldFilter} | null; /** - * Optional. 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. + * Optional. 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. */ disableSpellCheck?: boolean | null; /** - * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[] | null; /** - * Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched. + * Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched. */ extendedCompensationFilter?: Schema$ExtendedCompensationFilter; /** - * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[] | null; /** - * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** @@ -1016,16 +1364,16 @@ export namespace jobs_v2 { */ publishDateRange?: string | null; /** - * Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. + * Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. */ query?: string | null; /** - * Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. + * Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. */ tenantJobOnly?: boolean | null; } /** - * Output only. A resource that represents a location with full geographic information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$JobLocation { /** @@ -1046,7 +1394,7 @@ export namespace jobs_v2 { radiusMeters?: number | null; } /** - * Input only. Options for job processing. + * Input only. Options for job processing. */ export interface Schema$JobProcessingOptions { /** @@ -1054,28 +1402,28 @@ export namespace jobs_v2 { */ disableStreetAddressResolution?: boolean | null; /** - * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string | null; } /** - * Input only. The query required to perform a search query or histogram. + * Input only. The query required to perform a search query or histogram. */ export interface Schema$JobQuery { /** - * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ categories?: string[] | null; /** - * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommutePreference; /** - * Optional. This filter specifies the exact company display name of the jobs to search against. 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. + * Optional. This filter specifies the exact company display name of the jobs to search against. 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. */ companyDisplayNames?: string[] | null; /** - * Optional. 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. At most 20 company filters are allowed. + * Optional. 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. At most 20 company filters are allowed. */ companyNames?: string[] | null; /** @@ -1083,23 +1431,23 @@ export namespace jobs_v2 { */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<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 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() 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 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 */ customAttributeFilter?: string | null; /** - * Optional. 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. + * Optional. 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. */ disableSpellCheck?: boolean | null; /** - * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. */ employmentTypes?: string[] | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[] | null; /** - * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** @@ -1107,12 +1455,12 @@ export namespace jobs_v2 { */ publishDateRange?: string | null; /** - * Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes. + * Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes. */ query?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -1125,7 +1473,7 @@ export namespace jobs_v2 { longitude?: number | null; } /** - * Output only. The List companies response object. + * Output only. The List companies response object. */ export interface Schema$ListCompaniesResponse { /** @@ -1142,11 +1490,11 @@ export namespace jobs_v2 { nextPageToken?: string | null; } /** - * Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object. + * Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object. */ export interface Schema$ListCompanyJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** @@ -1163,11 +1511,11 @@ export namespace jobs_v2 { totalSize?: string | null; } /** - * Output only. List jobs response. + * Output only. List jobs response. */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** @@ -1180,7 +1528,7 @@ export namespace jobs_v2 { nextPageToken?: string | null; } /** - * Input only. Geographic region of the search. + * Input only. Geographic region of the search. */ export interface Schema$LocationFilter { /** @@ -1200,16 +1548,16 @@ export namespace jobs_v2 { */ name?: string | null; /** - * Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string | null; } /** - * Output only. Job entry with metadata inside SearchJobsResponse. + * Output only. Job entry with metadata inside SearchJobsResponse. */ export interface Schema$MatchingJob { /** - * Commute information which is generated based on specified CommutePreference. + * Commute information which is generated based on specified CommutePreference. */ commuteInfo?: Schema$CommuteInfo; /** @@ -1304,7 +1652,7 @@ export namespace jobs_v2 { */ disableManualEnrollmentSelection?: boolean | null; /** - * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. */ disableOrganicSelection?: boolean | null; /** @@ -1317,7 +1665,7 @@ export namespace jobs_v2 { forcedRollouts?: {[key: string]: boolean} | null; } /** - * Input only. Use this field to specify bucketing option for the histogram search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** @@ -1330,7 +1678,7 @@ export namespace jobs_v2 { requiresMinMax?: boolean | null; } /** - * Output only. Custom numeric bucketing result. + * Output only. Custom numeric bucketing result. */ export interface Schema$NumericBucketingResult { /** @@ -1347,11 +1695,11 @@ export namespace jobs_v2 { minValue?: number | null; } /** - * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** @@ -1359,7 +1707,7 @@ export namespace jobs_v2 { */ administrativeArea?: string | null; /** - * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string | null; /** @@ -1383,7 +1731,7 @@ export namespace jobs_v2 { */ regionCode?: string | null; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number | null; /** @@ -1396,7 +1744,7 @@ export namespace jobs_v2 { sublocality?: string | null; } /** - * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** @@ -1404,20 +1752,20 @@ export namespace jobs_v2 { */ deviceInfo?: Schema$DeviceInfo; /** - * Required. 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 <em>Foo, Inc.</em>, 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. + * Required. 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. */ domain?: string | null; /** - * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. + * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. */ sessionId?: string | null; /** - * Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id. + * Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id. */ userId?: string | null; } /** - * Output only. Additional information returned to client, such as debugging information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** @@ -1434,23 +1782,23 @@ export namespace jobs_v2 { requestId?: string | null; } /** - * Input only. The Request body of the `SearchJobs` call. + * Input only. The Request body of the `SearchJobs` call. */ export interface Schema$SearchJobsRequest { /** - * Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false. + * Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false. */ disableRelevanceThresholding?: boolean | null; /** - * Optional. 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. + * Optional. 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. */ enableBroadening?: boolean | null; /** - * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. + * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. */ enablePreciseResultSize?: boolean | null; /** - * Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location. + * Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location. */ filters?: Schema$JobFilters; /** @@ -1466,11 +1814,11 @@ export namespace jobs_v2 { */ mode?: string | null; /** - * Optional. 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 is unset. 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). + * Optional. 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 is unset. 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). */ offset?: number | null; /** - * Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. + * Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. */ orderBy?: string | null; /** @@ -1495,7 +1843,7 @@ export namespace jobs_v2 { sortBy?: string | null; } /** - * Output only. Response for SearchJob method. + * Output only. Response for SearchJob method. */ export interface Schema$SearchJobsResponse { /** @@ -1507,7 +1855,7 @@ export namespace jobs_v2 { */ appliedJobLocationFilters?: Schema$JobLocation[]; /** - * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size. */ estimatedTotalSize?: string | null; /** @@ -1544,7 +1892,7 @@ export namespace jobs_v2 { totalSize?: string | null; } /** - * Output only. Spell check result. + * Output only. Spell check result. */ export interface Schema$SpellingCorrection { /** @@ -1556,6 +1904,23 @@ export namespace jobs_v2 { */ correctedText?: string | null; } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } /** * Represents array of string values. */ @@ -1566,11 +1931,11 @@ export namespace jobs_v2 { values?: string[] | null; } /** - * Input only. Update job request. + * Input only. Update job request. */ export interface Schema$UpdateJobRequest { /** - * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job. + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job. */ disableStreetAddressResolution?: boolean | null; /** @@ -1578,11 +1943,11 @@ export namespace jobs_v2 { */ job?: Schema$Job; /** - * Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set. + * Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set. */ processingOptions?: Schema$JobProcessingOptions; /** - * Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated) + * Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated) */ updateJobFields?: string | null; } @@ -1794,8 +2159,7 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.companies.delete({ - * // Required. The resource name of the company to be deleted, - * // such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * // Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". * name: 'companies/my-companie', * }); * console.log(res.data); @@ -1923,8 +2287,7 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.companies.get({ - * // Required. Resource name of the company to retrieve, - * // such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * // Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". * name: 'companies/my-companie', * }); * console.log(res.data); @@ -2071,15 +2434,9 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.companies.list({ - * // Optional. Set to true if the companies request must have open jobs. - * // - * // Defaults to false. - * // - * // If true, at most page_size of companies are fetched, among which - * // only those with open jobs are returned. + * // Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * mustHaveOpenJobs: 'placeholder-value', - * // Optional. The maximum number of companies to be returned, at most 100. - * // Default is 100 if a non-positive number is provided. + * // Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * pageSize: 'placeholder-value', * // Optional. The starting indicator from which to return results. * pageToken: 'placeholder-value', @@ -2103,7 +2460,7 @@ export namespace jobs_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.mustHaveOpenJobs Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * @param {boolean=} params.mustHaveOpenJobs Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * @param {string=} params.pageToken Optional. The starting indicator from which to return results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2220,33 +2577,9 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.companies.patch({ - * // Required during company update. - * // - * // The resource name for a company. This is generated by the service when a - * // company is created, for example, - * // "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * // Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". * name: 'companies/my-companie', - * // Optional but strongly recommended to be provided for the best service - * // experience. - * // - * // If update_company_fields is provided, only the specified fields in - * // company are updated. Otherwise all the fields are updated. - * // - * // A field mask to specify the company fields to update. Valid values are: - * // - * // * displayName - * // * website - * // * imageUrl - * // * companySize - * // * distributorBillingCompanyId - * // * companyInfoSources - * // * careerPageLink - * // * hiringAgency - * // * hqLocation - * // * eeoText - * // * keywordSearchableCustomAttributes - * // * title (deprecated) - * // * keywordSearchableCustomFields (deprecated) + * // Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) * updateCompanyFields: 'placeholder-value', * * // Request body metadata @@ -2308,8 +2641,8 @@ export namespace jobs_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". - * @param {string=} params.updateCompanyFields Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) + * @param {string} params.name Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * @param {string=} params.updateCompanyFields Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) * @param {().Company} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2411,7 +2744,7 @@ export namespace jobs_v2 { } export interface Params$Resource$Companies$List extends StandardParameters { /** - * Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ mustHaveOpenJobs?: boolean; /** @@ -2425,11 +2758,11 @@ export namespace jobs_v2 { } export interface Params$Resource$Companies$Patch extends StandardParameters { /** - * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". */ name?: string; /** - * Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) + * Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) */ updateCompanyFields?: string; @@ -2447,7 +2780,7 @@ export namespace jobs_v2 { /** * jobs.companies.jobs.list - * @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a company. + * @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a company. * @example * // Before running the sample: * // - Enable the API at: @@ -2475,36 +2808,15 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.companies.jobs.list({ - * // Required. The resource name of the company that owns the jobs to be listed, - * // such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * // Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". * companyName: 'companies/my-companie', - * // Optional. If set to `true`, only job ID, job requisition ID and language code will be - * // returned. - * // - * // A typical use is to synchronize job repositories. - * // - * // Defaults to false. + * // Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. * idsOnly: 'placeholder-value', - * // Deprecated. Please DO NOT use this field except for small companies. - * // Suggest counting jobs page by page instead. - * // - * // Optional. - * // - * // Set to true if the total number of open jobs is to be returned. - * // - * // Defaults to false. + * // Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. * includeJobsCount: 'placeholder-value', - * // Optional. The requisition ID, also known as posting ID, assigned by the company - * // to the job. - * // - * // The maximum number of allowable characters is 225. + * // Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. * jobRequisitionId: 'placeholder-value', - * // Optional. The maximum number of jobs to be returned per page of results. - * // - * // If ids_only is set to true, 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. + * // Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. * pageSize: 'placeholder-value', * // Optional. The starting point of a query result. * pageToken: 'placeholder-value', @@ -2530,10 +2842,10 @@ export namespace jobs_v2 { * * @param {object} params Parameters for request * @param {string} params.companyName Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". - * @param {boolean=} params.idsOnly Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. - * @param {boolean=} params.includeJobsCount Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. - * @param {string=} params.jobRequisitionId Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. - * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. + * @param {boolean=} params.idsOnly Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. + * @param {boolean=} params.includeJobsCount Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. + * @param {string=} params.jobRequisitionId Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. * @param {string=} params.pageToken Optional. The starting point of a query result. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2631,19 +2943,19 @@ export namespace jobs_v2 { */ companyName?: string; /** - * Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. + * Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. */ idsOnly?: boolean; /** - * Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. + * Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. */ includeJobsCount?: boolean; /** - * Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. + * Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. */ jobRequisitionId?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. */ pageSize?: number; /** @@ -2796,7 +3108,7 @@ export namespace jobs_v2 { /** * jobs.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2970,7 +3282,7 @@ export namespace jobs_v2 { /** * jobs.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2998,13 +3310,7 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.jobs.delete({ - * // Deprecated. This field is not working anymore. - * // - * // Optional. - * // - * // If set to true, this call waits for all processing steps to complete - * // before the job is cleaned up. Otherwise, the call returns while some - * // steps are still taking place asynchronously, hence faster. + * // Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. * disableFastProcess: 'placeholder-value', * // Required. The resource name of the job to be deleted, such as "jobs/11111111". * name: 'jobs/my-job', @@ -3024,7 +3330,7 @@ export namespace jobs_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.disableFastProcess Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. + * @param {boolean=} params.disableFastProcess Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. * @param {string} params.name Required. The resource name of the job to be deleted, such as "jobs/11111111". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3107,7 +3413,7 @@ export namespace jobs_v2 { /** * jobs.jobs.deleteByFilter - * @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned. + * @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned. * @example * // Before running the sample: * // - Enable the API at: @@ -3412,7 +3718,7 @@ export namespace jobs_v2 { /** * jobs.jobs.histogram - * @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state. + * @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state. * @example * // Before running the sample: * // - Enable the API at: @@ -3587,33 +3893,11 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.jobs.list({ - * // Required. The filter string specifies the jobs to be enumerated. - * // - * // Supported operator: =, AND - * // - * // The fields eligible for filtering are: - * // - * // * `companyName` (Required) - * // * `requisitionId` (Optional) - * // - * // Sample Query: - * // - * // * companyName = "companies/123" - * // * companyName = "companies/123" AND requisitionId = "req-1" + * // Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" * filter: 'placeholder-value', - * // Optional. If set to `true`, only Job.name, Job.requisition_id and - * // Job.language_code will be returned. - * // - * // A typical use case is to synchronize job repositories. - * // - * // Defaults to false. + * // Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. * idsOnly: 'placeholder-value', - * // Optional. The maximum number of jobs to be returned per page of results. - * // - * // If ids_only is set to true, 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. + * // Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. * pageSize: 'placeholder-value', * // Optional. The starting point of a query result. * pageToken: 'placeholder-value', @@ -3637,9 +3921,9 @@ export namespace jobs_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" - * @param {boolean=} params.idsOnly Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. - * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. + * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" + * @param {boolean=} params.idsOnly Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. * @param {string=} params.pageToken Optional. The starting point of a query result. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3722,7 +4006,7 @@ export namespace jobs_v2 { /** * jobs.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -3750,11 +4034,7 @@ export namespace jobs_v2 { * * // Do the magic * const res = await jobs.jobs.patch({ - * // Required during job update. - * // - * // Resource name assigned to a job by the API, for example, "/jobs/foo". Use - * // of this field in job queries and API calls is preferred over the use of - * // requisition_id since this value is unique. + * // Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * name: 'jobs/my-job', * * // Request body metadata @@ -3822,7 +4102,7 @@ export namespace jobs_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * @param {string} params.name Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * @param {().UpdateJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3905,7 +4185,7 @@ export namespace jobs_v2 { /** * jobs.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -4066,7 +4346,7 @@ export namespace jobs_v2 { /** * jobs.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -4246,7 +4526,7 @@ export namespace jobs_v2 { } export interface Params$Resource$Jobs$Delete extends StandardParameters { /** - * Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. + * Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. */ disableFastProcess?: boolean; /** @@ -4275,15 +4555,15 @@ export namespace jobs_v2 { } export interface Params$Resource$Jobs$List extends StandardParameters { /** - * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" */ filter?: string; /** - * Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. + * Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. */ idsOnly?: boolean; /** - * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, 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. */ pageSize?: number; /** @@ -4293,7 +4573,7 @@ export namespace jobs_v2 { } export interface Params$Resource$Jobs$Patch extends StandardParameters { /** - * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -4354,24 +4634,9 @@ export namespace jobs_v2 { * const res = await jobs.complete({ * // Optional. If provided, restricts completion to the specified company. * companyName: 'placeholder-value', - * // Required. The language 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](https://tools.ietf.org/html/bcp47). - * // - * // For CompletionType.JOB_TITLE type, only open jobs with same - * // language_code are returned. - * // - * // For CompletionType.COMPANY_NAME type, - * // only companies having open jobs with same language_code are - * // returned. - * // - * // For CompletionType.COMBINED type, only open jobs with same - * // language_code or companies having open jobs with same - * // language_code are returned. + * // Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. * languageCode: 'placeholder-value', - * // Required. Completion result count. - * // The maximum allowed page size is 10. + * // Required. Completion result count. The maximum allowed page size is 10. * pageSize: 'placeholder-value', * // Required. The query used to generate suggestions. * query: 'placeholder-value', @@ -4399,7 +4664,7 @@ export namespace jobs_v2 { * * @param {object} params Parameters for request * @param {string=} params.companyName Optional. If provided, restricts completion to the specified company. - * @param {string=} params.languageCode Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. + * @param {string=} params.languageCode Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. * @param {string=} params.query Required. The query used to generate suggestions. * @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. @@ -4497,7 +4762,7 @@ export namespace jobs_v2 { */ companyName?: string; /** - * Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. + * Required. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. */ languageCode?: string; /** diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index 5295ead572..c696205d7b 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -132,24 +132,24 @@ export namespace jobs_v3 { */ export interface Schema$ApplicationInfo { /** - * Optional but at least one of uris, emails or instruction must be specified. 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. + * Optional but at least one of uris, emails or instruction must be specified. 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. */ emails?: string[] | null; /** - * Optional but at least one of uris, emails or instruction must be specified. 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. + * Optional but at least one of uris, emails or instruction must be specified. 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. */ instruction?: string | null; /** - * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ uris?: string[] | null; } /** - * Input only. Batch delete jobs request. + * Input only. Batch delete jobs request. */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string | null; } @@ -192,7 +192,7 @@ export namespace jobs_v3 { */ eventId?: string | null; /** - * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. + * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ extraInfo?: {[key: string]: string} | null; /** @@ -209,11 +209,11 @@ export namespace jobs_v3 { requestId?: string | null; } /** - * Input only. Parameters needed for commute search. + * Input only. Parameters needed for commute search. */ export interface Schema$CommuteFilter { /** - * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. + * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ allowImpreciseAddresses?: boolean | null; /** @@ -221,7 +221,7 @@ export namespace jobs_v3 { */ commuteMethod?: string | null; /** - * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. + * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ departureTime?: Schema$TimeOfDay; /** @@ -238,7 +238,7 @@ export namespace jobs_v3 { travelDuration?: string | null; } /** - * Output only. Commute details related to this job. + * Output only. Commute details related to this job. */ export interface Schema$CommuteInfo { /** @@ -267,11 +267,11 @@ export namespace jobs_v3 { */ displayName?: string | null; /** - * Optional. 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. + * Optional. 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. */ eeoText?: string | null; /** - * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. + * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ externalId?: string | null; /** @@ -279,7 +279,7 @@ export namespace jobs_v3 { */ headquartersAddress?: string | null; /** - * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean | null; /** @@ -291,7 +291,7 @@ export namespace jobs_v3 { */ keywordSearchableJobCustomAttributes?: string[] | null; /** - * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string | null; /** @@ -303,7 +303,7 @@ export namespace jobs_v3 { */ suspended?: boolean | null; /** - * Optional. 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. + * Optional. 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. */ websiteUri?: string | null; } @@ -317,7 +317,7 @@ export namespace jobs_v3 { headquartersLocation?: Schema$Location; } /** - * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -325,7 +325,7 @@ export namespace jobs_v3 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string | null; /** @@ -337,16 +337,16 @@ export namespace jobs_v3 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. + * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ type?: string | null; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string | null; } /** - * Input only. Filter on job compensation type and amount. + * Input only. Filter on job compensation type and amount. */ export interface Schema$CompensationFilter { /** @@ -367,7 +367,7 @@ export namespace jobs_v3 { units?: string[] | null; } /** - * Input only. Compensation based histogram request. + * Input only. Compensation based histogram request. */ export interface Schema$CompensationHistogramRequest { /** @@ -380,7 +380,7 @@ export namespace jobs_v3 { type?: string | null; } /** - * Output only. Compensation based histogram result. + * Output only. Compensation based histogram result. */ export interface Schema$CompensationHistogramResult { /** @@ -397,15 +397,15 @@ export namespace jobs_v3 { */ export interface Schema$CompensationInfo { /** - * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; } @@ -423,7 +423,7 @@ export namespace jobs_v3 { minCompensation?: Schema$Money; } /** - * Output only. Response of auto-complete query. + * Output only. Response of auto-complete query. */ export interface Schema$CompleteQueryResponse { /** @@ -436,7 +436,7 @@ export namespace jobs_v3 { metadata?: Schema$ResponseMetadata; } /** - * Output only. Resource that represents completion results. + * Output only. Resource that represents completion results. */ export interface Schema$CompletionResult { /** @@ -462,7 +462,7 @@ export namespace jobs_v3 { clientEvent?: Schema$ClientEvent; } /** - * Input only. The Request of the CreateCompany method. + * Input only. The Request of the CreateCompany method. */ export interface Schema$CreateCompanyRequest { /** @@ -471,7 +471,7 @@ export namespace jobs_v3 { company?: Schema$Company; } /** - * Input only. Create job request. + * Input only. Create job request. */ export interface Schema$CreateJobRequest { /** @@ -484,15 +484,15 @@ export namespace jobs_v3 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + * Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. */ filterable?: boolean | null; /** - * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ longValues?: string[] | null; /** - * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ stringValues?: string[] | null; } @@ -514,7 +514,7 @@ export namespace jobs_v3 { stringValueHistogram?: boolean | null; } /** - * Output only. Custom attribute histogram result. + * Output only. Custom attribute histogram result. */ export interface Schema$CustomAttributeHistogramResult { /** @@ -544,11 +544,359 @@ export namespace jobs_v3 { id?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Input only. Histogram facets to be specified in SearchJobsRequest. + * The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchCreateJobsResponse { + /** + * List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchDeleteJobsResponse { + /** + * List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata. + */ + export interface Schema$GoogleCloudTalentV4BatchOperationMetadata { + /** + * The time when the batch operation is created. + */ + createTime?: string | null; + /** + * The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`. + */ + endTime?: string | null; + /** + * Count of failed item(s) inside an operation. + */ + failureCount?: number | null; + /** + * The state of a long running operation. + */ + state?: string | null; + /** + * More detailed information about operation state. + */ + stateDescription?: string | null; + /** + * Count of successful item(s) inside an operation. + */ + successCount?: number | null; + /** + * Count of total item(s) inside an operation. + */ + totalCount?: number | null; + /** + * The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned. + */ + updateTime?: string | null; + } + /** + * The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchUpdateJobsResponse { + /** + * List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Job compensation details. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfo { + /** + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedBaseCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedTotalCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job. + */ + entries?: Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry[]; + } + /** + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry { + /** + * Compensation amount. + */ + amount?: Schema$Money; + /** + * Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + */ + description?: string | null; + /** + * Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 + */ + expectedUnitsPerYear?: number | null; + /** + * Compensation range. + */ + range?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED. + */ + type?: string | null; + /** + * Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + */ + unit?: string | null; + } + /** + * Compensation range. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationRange { + /** + * 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 of min_compensation. + */ + maxCompensation?: Schema$Money; + /** + * 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 of max_compensation. + */ + minCompensation?: Schema$Money; + } + /** + * Custom attribute values that are either filterable or non-filterable. + */ + export interface Schema$GoogleCloudTalentV4CustomAttribute { + /** + * If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + */ + filterable?: boolean | null; + /** + * If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false. + */ + keywordSearchable?: boolean | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. + */ + longValues?: string[] | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed. + */ + stringValues?: string[] | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudTalentV4Job { + /** + * 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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. + */ + addresses?: string[] | null; + /** + * Job application information. + */ + applicationInfo?: Schema$GoogleCloudTalentV4JobApplicationInfo; + /** + * 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". + */ + company?: string | null; + /** + * Output only. Display name of the company listing the job. + */ + companyDisplayName?: string | null; + /** + * Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee. + */ + compensationInfo?: Schema$GoogleCloudTalentV4CompensationInfo; + /** + * 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + */ + customAttributes?: { + [key: string]: Schema$GoogleCloudTalentV4CustomAttribute; + } | null; + /** + * The desired education degrees for the job, such as Bachelors, Masters. + */ + degreeTypes?: string[] | null; + /** + * The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + */ + department?: string | null; + /** + * Output only. Derived details about the job posting. + */ + derivedInfo?: Schema$GoogleCloudTalentV4JobDerivedInfo; + /** + * 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, 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. + */ + description?: string | null; + /** + * The employment type(s) of a job, for example, full time or part time. + */ + employmentTypes?: string[] | null; + /** + * 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. + */ + incentives?: string | null; + /** + * The benefits included with the job. + */ + jobBenefits?: string[] | null; + /** + * The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobEndTime?: string | null; + /** + * The experience level associated with the job, such as "Entry Level". + */ + jobLevel?: string | null; + /** + * The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobStartTime?: string | null; + /** + * 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + */ + languageCode?: string | null; + /** + * 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". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + */ + name?: string | null; + /** + * Output only. The timestamp when this job posting was created. + */ + postingCreateTime?: string | null; + /** + * 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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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. + */ + postingExpireTime?: string | null; + /** + * 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. + */ + postingPublishTime?: string | null; + /** + * The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. + */ + postingRegion?: string | null; + /** + * Output only. The timestamp when this job posting was last updated. + */ + postingUpdateTime?: string | null; + /** + * Options for job processing. + */ + processingOptions?: Schema$GoogleCloudTalentV4JobProcessingOptions; + /** + * 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. + */ + promotionValue?: number | null; + /** + * 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 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. + */ + qualifications?: string | null; + /** + * 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, language_code and requisition_id. The maximum number of allowed characters is 255. + */ + requisitionId?: string | null; + /** + * A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + */ + responsibilities?: string | null; + /** + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + */ + title?: string | null; + /** + * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. + */ + visibility?: string | null; + } + /** + * Application related details of a job posting. + */ + export interface Schema$GoogleCloudTalentV4JobApplicationInfo { + /** + * 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. + */ + emails?: string[] | null; + /** + * 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. + */ + instruction?: string | null; + /** + * Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. + */ + uris?: string[] | null; + } + /** + * Derived details about the job posting. + */ + export interface Schema$GoogleCloudTalentV4JobDerivedInfo { + /** + * Job categories derived from Job.title and Job.description. + */ + jobCategories?: string[] | null; + /** + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. + */ + locations?: Schema$GoogleCloudTalentV4Location[]; + } + /** + * Options for job processing. + */ + export interface Schema$GoogleCloudTalentV4JobProcessingOptions { + /** + * If set to `true`, the service does not attempt to resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * 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. + */ + htmlSanitization?: string | null; + } + /** + * Mutation result of a job from a batch operation. + */ + export interface Schema$GoogleCloudTalentV4JobResult { + /** + * 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. + */ + job?: Schema$GoogleCloudTalentV4Job; + /** + * The status of the job processed. This field is populated if the processing of the job fails. + */ + status?: Schema$Status; + } + /** + * A resource that represents a location with full geographic information. + */ + export interface Schema$GoogleCloudTalentV4Location { + /** + * An object representing a latitude/longitude pair. + */ + latLng?: Schema$LatLng; + /** + * The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. + */ + locationType?: string | null; + /** + * 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. + */ + postalAddress?: Schema$PostalAddress; + /** + * 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 covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. + */ + radiusMiles?: number | null; + } + /** + * Input only. Histogram facets to be specified in SearchJobsRequest. */ export interface Schema$HistogramFacets { /** @@ -565,7 +913,7 @@ export namespace jobs_v3 { simpleHistogramFacets?: string[] | null; } /** - * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -573,12 +921,12 @@ export namespace jobs_v3 { */ searchType?: string | null; /** - * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number} | null; } /** - * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. + * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** @@ -599,11 +947,11 @@ export namespace jobs_v3 { */ export interface Schema$Job { /** - * Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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. + * Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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. */ addresses?: string[] | null; /** - * Required. At least one field within ApplicationInfo must be specified. Job application information. + * Required. At least one field within ApplicationInfo must be specified. Job application information. */ applicationInfo?: Schema$ApplicationInfo; /** @@ -619,7 +967,7 @@ export namespace jobs_v3 { */ compensationInfo?: Schema$CompensationInfo; /** - * Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + * Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** @@ -627,7 +975,7 @@ export namespace jobs_v3 { */ degreeTypes?: string[] | null; /** - * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string | null; /** @@ -635,7 +983,7 @@ export namespace jobs_v3 { */ derivedInfo?: Schema$JobDerivedInfo; /** - * 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, 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. + * 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, 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. */ description?: string | null; /** @@ -643,7 +991,7 @@ export namespace jobs_v3 { */ employmentTypes?: string[] | null; /** - * Optional. 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. + * Optional. 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. */ incentives?: string | null; /** @@ -663,11 +1011,11 @@ export namespace jobs_v3 { */ jobStartTime?: string | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string | null; /** - * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string | null; /** @@ -675,7 +1023,7 @@ export namespace jobs_v3 { */ postingCreateTime?: string | null; /** - * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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. + * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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. */ postingExpireTime?: string | null; /** @@ -695,32 +1043,32 @@ export namespace jobs_v3 { */ processingOptions?: Schema$ProcessingOptions; /** - * Optional. 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. + * Optional. 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. */ promotionValue?: number | null; /** - * Optional. 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 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. + * Optional. 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 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. */ qualifications?: string | null; /** - * Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ requisitionId?: string | null; /** - * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. */ responsibilities?: string | null; /** - * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ title?: string | null; /** - * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. + * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ visibility?: string | null; } /** - * Output only. Derived details about the job posting. + * Output only. Derived details about the job posting. */ export interface Schema$JobDerivedInfo { /** @@ -728,7 +1076,7 @@ export namespace jobs_v3 { */ jobCategories?: string[] | null; /** - * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ locations?: Schema$Location[]; } @@ -746,19 +1094,19 @@ export namespace jobs_v3 { type?: string | null; } /** - * Input only. The query required to perform a search query. + * Input only. The query required to perform a search query. */ export interface Schema$JobQuery { /** - * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommuteFilter; /** - * Optional. This filter specifies the exact company display name of the jobs to search against. 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. + * Optional. This filter specifies the exact company display name of the jobs to search against. 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. */ companyDisplayNames?: string[] | null; /** - * Optional. 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. + * Optional. 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ companyNames?: string[] | null; /** @@ -766,27 +1114,27 @@ export namespace jobs_v3 { */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` + * Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ customAttributeFilter?: string | null; /** - * Optional. 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. + * Optional. 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. */ disableSpellCheck?: boolean | null; /** - * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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. */ employmentTypes?: string[] | null; /** - * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ jobCategories?: string[] | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[] | null; /** - * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** @@ -794,16 +1142,16 @@ export namespace jobs_v3 { */ publishTimeRange?: Schema$TimestampRange; /** - * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. + * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string | null; /** - * The language code of 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](https://tools.ietf.org/html/bcp47). + * The language code of 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](https://tools.ietf.org/html/bcp47). */ queryLanguageCode?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -816,7 +1164,7 @@ export namespace jobs_v3 { longitude?: number | null; } /** - * Output only. The List companies response object. + * Output only. The List companies response object. */ export interface Schema$ListCompaniesResponse { /** @@ -833,11 +1181,11 @@ export namespace jobs_v3 { nextPageToken?: string | null; } /** - * Output only. List jobs response. + * Output only. List jobs response. */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** @@ -850,7 +1198,7 @@ export namespace jobs_v3 { nextPageToken?: string | null; } /** - * Output only. A resource that represents a location with full geographic information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$Location { /** @@ -871,7 +1219,7 @@ export namespace jobs_v3 { radiusInMiles?: number | null; } /** - * Input only. Geographic region of the search. + * Input only. Geographic region of the search. */ export interface Schema$LocationFilter { /** @@ -887,20 +1235,20 @@ export namespace jobs_v3 { */ latLng?: Schema$LatLng; /** - * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string | null; /** - * Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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. + * Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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. */ telecommutePreference?: string | null; } /** - * Output only. Job entry with metadata inside SearchJobsResponse. + * Output only. Job entry with metadata inside SearchJobsResponse. */ export interface Schema$MatchingJob { /** - * Commute information which is generated based on specified CommuteFilter. + * Commute information which is generated based on specified CommuteFilter. */ commuteInfo?: Schema$CommuteInfo; /** @@ -995,7 +1343,7 @@ export namespace jobs_v3 { */ disableManualEnrollmentSelection?: boolean | null; /** - * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. */ disableOrganicSelection?: boolean | null; /** @@ -1008,7 +1356,7 @@ export namespace jobs_v3 { forcedRollouts?: {[key: string]: boolean} | null; } /** - * Input only. Use this field to specify bucketing option for the histogram search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** @@ -1021,7 +1369,7 @@ export namespace jobs_v3 { requiresMinMax?: boolean | null; } /** - * Output only. Custom numeric bucketing result. + * Output only. Custom numeric bucketing result. */ export interface Schema$NumericBucketingResult { /** @@ -1038,11 +1386,11 @@ export namespace jobs_v3 { minValue?: number | null; } /** - * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** @@ -1050,7 +1398,7 @@ export namespace jobs_v3 { */ administrativeArea?: string | null; /** - * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string | null; /** @@ -1074,7 +1422,7 @@ export namespace jobs_v3 { */ regionCode?: string | null; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number | null; /** @@ -1087,7 +1435,7 @@ export namespace jobs_v3 { sublocality?: string | null; } /** - * Input only. Options for job processing. + * Input only. Options for job processing. */ export interface Schema$ProcessingOptions { /** @@ -1095,12 +1443,12 @@ export namespace jobs_v3 { */ disableStreetAddressResolution?: boolean | null; /** - * Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string | null; } /** - * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** @@ -1108,20 +1456,20 @@ export namespace jobs_v3 { */ deviceInfo?: Schema$DeviceInfo; /** - * Required. 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 <em>Foo, Inc.</em>, 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. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. + * Required. 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. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ domain?: string | null; /** - * Required. 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. + * Required. 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ sessionId?: string | null; /** - * Required. 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. If this field is not available for some reason, send "UNKNOWN". 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. + * Required. 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. If this field is not available for some reason, send "UNKNOWN". 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. */ userId?: string | null; } /** - * Output only. Additional information returned to client, such as debugging information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** @@ -1130,19 +1478,19 @@ export namespace jobs_v3 { requestId?: string | null; } /** - * Input only. The Request body of the `SearchJobs` call. + * Input only. The Request body of the `SearchJobs` call. */ export interface Schema$SearchJobsRequest { /** - * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. + * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ disableKeywordMatch?: boolean | null; /** - * Optional. 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 if no value is specified. + * Optional. 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 if no value is specified. */ diversificationLevel?: string | null; /** - * Optional. 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. + * Optional. 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. */ enableBroadening?: boolean | null; /** @@ -1158,11 +1506,11 @@ export namespace jobs_v3 { */ jobView?: string | null; /** - * Optional. 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 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). + * Optional. 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 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). */ offset?: number | null; /** - * Optional. 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 descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's 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 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 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 descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. + * Optional. 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 descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's 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 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 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 descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. */ orderBy?: string | null; /** @@ -1178,16 +1526,16 @@ export namespace jobs_v3 { */ requestMetadata?: Schema$RequestMetadata; /** - * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. + * This field is deprecated. */ requirePreciseResultSize?: boolean | null; /** - * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. + * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. */ searchMode?: string | null; } /** - * Output only. Response for SearchJob method. + * Output only. Response for SearchJob method. */ export interface Schema$SearchJobsResponse { /** @@ -1195,7 +1543,7 @@ export namespace jobs_v3 { */ broadenedQueryJobsCount?: number | null; /** - * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size. */ estimatedTotalSize?: number | null; /** @@ -1223,12 +1571,12 @@ export namespace jobs_v3 { */ spellCorrection?: Schema$SpellingCorrection; /** - * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. + * The precise result count with limit 100,000. */ totalSize?: number | null; } /** - * Output only. Spell check result. + * Output only. Spell check result. */ export interface Schema$SpellingCorrection { /** @@ -1240,6 +1588,23 @@ export namespace jobs_v3 { */ correctedText?: string | null; } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + */ + message?: string | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ @@ -1275,7 +1640,7 @@ export namespace jobs_v3 { startTime?: string | null; } /** - * Input only. Request for updating a specified company. + * Input only. Request for updating a specified company. */ export interface Schema$UpdateCompanyRequest { /** @@ -1283,12 +1648,12 @@ export namespace jobs_v3 { */ company?: Schema$Company; /** - * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. + * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. */ updateMask?: string | null; } /** - * Input only. Update job request. + * Input only. Update job request. */ export interface Schema$UpdateJobRequest { /** @@ -1296,7 +1661,7 @@ export namespace jobs_v3 { */ job?: Schema$Job; /** - * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. + * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. */ updateMask?: string | null; } @@ -1343,63 +1708,17 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.complete({ - * // Optional. If provided, restricts completion to specified company. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * companyName: 'placeholder-value', - * // Deprecated. Use language_codes instead. - * // - * // Optional. - * // - * // The language 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](https://tools.ietf.org/html/bcp47). - * // - * // For CompletionType.JOB_TITLE type, only open jobs with the same - * // language_code are returned. - * // - * // For CompletionType.COMPANY_NAME type, - * // only companies having open jobs with the same language_code are - * // returned. - * // - * // For CompletionType.COMBINED type, only open jobs with the same - * // language_code or companies having open jobs with the same - * // language_code are returned. - * // - * // The maximum number of allowed characters is 255. + * // Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. * languageCode: 'placeholder-value', - * // Optional. 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](https://tools.ietf.org/html/bcp47). - * // - * // For CompletionType.JOB_TITLE type, only open jobs with the same - * // language_codes are returned. - * // - * // For CompletionType.COMPANY_NAME type, - * // only companies having open jobs with the same language_codes are - * // returned. - * // - * // For CompletionType.COMBINED type, only open jobs with the same - * // language_codes or companies having open jobs with the same - * // language_codes are returned. - * // - * // The maximum number of allowed characters is 255. + * // Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. * languageCodes: 'placeholder-value', - * // Required. Resource name of project the completion is performed within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * name: 'projects/my-project', - * // Required. Completion result count. - * // - * // The maximum allowed page size is 10. + * // Required. Completion result count. The maximum allowed page size is 10. * pageSize: 'placeholder-value', - * // Required. The query used to generate suggestions. - * // - * // The maximum number of allowed characters is 255. + * // Required. The query used to generate suggestions. The maximum number of allowed characters is 255. * query: 'placeholder-value', * // Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. * scope: 'placeholder-value', @@ -1424,12 +1743,12 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. - * @param {string=} params.languageCodes Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. - * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". - * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. - * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. + * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. + * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. * @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. * @param {string=} params.type Optional. The completion topic. The default is CompletionType.COMBINED. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1526,27 +1845,27 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Complete extends StandardParameters { /** - * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ companyName?: string; /** - * Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. */ languageCode?: string; /** - * Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. + * Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. */ languageCodes?: string[]; /** - * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ name?: string; /** - * Required. Completion result count. The maximum allowed page size is 10. + * Required. Completion result count. The maximum allowed page size is 10. */ pageSize?: number; /** - * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. */ query?: string; /** @@ -1763,10 +2082,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.companies.create({ - * // Required. Resource name of the project under which the company is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -1806,7 +2122,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().CreateCompanyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1921,10 +2237,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.companies.delete({ - * // Required. The resource name of the company to be deleted. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * }); * console.log(res.data); @@ -1942,7 +2255,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.name Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2053,10 +2366,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.companies.get({ - * // Required. The resource name of the company to be retrieved. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * }); * console.log(res.data); @@ -2088,7 +2398,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.name Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2199,22 +2509,13 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.companies.list({ - * // Optional. The maximum number of companies to be returned, at most 100. - * // Default is 100 if a non-positive number is provided. + * // Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * pageSize: 'placeholder-value', * // Optional. The starting indicator from which to return results. * pageToken: 'placeholder-value', - * // Required. Resource name of the project under which the company is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', - * // Optional. Set to true if the companies requested must have open jobs. - * // - * // Defaults to false. - * // - * // If true, at most page_size of companies are fetched, among which - * // only those with open jobs are returned. + * // Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * requireOpenJobs: 'placeholder-value', * }); * console.log(res.data); @@ -2238,8 +2539,8 @@ export namespace jobs_v3 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * @param {string=} params.pageToken Optional. The starting indicator from which to return results. - * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". - * @param {boolean=} params.requireOpenJobs Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {boolean=} params.requireOpenJobs Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2358,13 +2659,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.companies.patch({ - * // 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}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * * // Request body metadata @@ -2405,7 +2700,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {().UpdateCompanyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2491,7 +2786,7 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Companies$Create extends StandardParameters { /** - * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -2503,14 +2798,14 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Companies$Delete extends StandardParameters { /** - * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } export interface Params$Resource$Projects$Companies$Get extends StandardParameters { /** - * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2525,18 +2820,18 @@ export namespace jobs_v3 { */ pageToken?: string; /** - * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; /** - * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ requireOpenJobs?: boolean; } export interface Params$Resource$Projects$Companies$Patch extends StandardParameters { /** - * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; @@ -2582,10 +2877,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.batchDelete({ - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -2611,7 +2903,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().BatchDeleteJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2698,7 +2990,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2726,10 +3018,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.create({ - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -2786,7 +3075,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().CreateJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2870,7 +3159,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2898,10 +3187,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.delete({ - * // Required. The resource name of the job to be deleted. - * // - * // The format is "projects/{project_id}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". + * // Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * name: 'projects/my-project/jobs/my-job', * }); * console.log(res.data); @@ -2919,7 +3205,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * @param {string} params.name Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3030,10 +3316,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.get({ - * // Required. The resource name of the job to retrieve. - * // - * // The format is "projects/{project_id}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". + * // Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * name: 'projects/my-project/jobs/my-job', * }); * console.log(res.data); @@ -3082,7 +3365,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * @param {string} params.name Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3193,38 +3476,15 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.list({ - * // Required. The filter string specifies the jobs to be enumerated. - * // - * // Supported operator: =, AND - * // - * // The fields eligible for filtering are: - * // - * // * `companyName` (Required) - * // * `requisitionId` (Optional) - * // - * // Sample Query: - * // - * // * companyName = "projects/api-test-project/companies/123" - * // * companyName = "projects/api-test-project/companies/123" AND requisitionId - * // = "req-1" + * // Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" * filter: 'placeholder-value', - * // Optional. The desired job attributes returned for jobs in the - * // search response. Defaults to JobView.JOB_VIEW_FULL if no value is - * // specified. + * // Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. * jobView: 'placeholder-value', - * // Optional. The maximum number of jobs to be returned per page of results. - * // - * // If job_view is set to 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. + * // Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. * pageSize: 'placeholder-value', * // Optional. The starting point of a query result. * pageToken: 'placeholder-value', - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * }); * console.log(res.data); @@ -3246,11 +3506,11 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" * @param {string=} params.jobView Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. - * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. * @param {string=} params.pageToken Optional. The starting point of a query result. - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3333,7 +3593,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -3361,16 +3621,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.patch({ - * // 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}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". - * // - * // Use of this field in job queries and API calls is preferred over the use of - * // requisition_id since this value is unique. + * // 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * name: 'projects/my-project/jobs/my-job', * * // Request body metadata @@ -3428,7 +3679,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * @param {string} params.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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * @param {().UpdateJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3512,7 +3763,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -3540,10 +3791,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.search({ - * // Required. The resource name of the project to search within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -3591,7 +3839,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().SearchJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3681,7 +3929,7 @@ export namespace jobs_v3 { /** * jobs.projects.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -3709,10 +3957,7 @@ export namespace jobs_v3 { * * // Do the magic * const res = await jobs.projects.jobs.searchForAlert({ - * // Required. The resource name of the project to search within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -3760,7 +4005,7 @@ export namespace jobs_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().SearchJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3854,7 +4099,7 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Jobs$Batchdelete extends StandardParameters { /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3866,7 +4111,7 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Jobs$Create extends StandardParameters { /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3878,21 +4123,21 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Jobs$Delete extends StandardParameters { /** - * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } export interface Params$Resource$Projects$Jobs$Get extends StandardParameters { /** - * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } export interface Params$Resource$Projects$Jobs$List extends StandardParameters { /** - * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; /** @@ -3900,7 +4145,7 @@ export namespace jobs_v3 { */ jobView?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. + * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. */ pageSize?: number; /** @@ -3908,14 +4153,14 @@ export namespace jobs_v3 { */ pageToken?: string; /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; } export interface Params$Resource$Projects$Jobs$Patch extends StandardParameters { /** - * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -3927,7 +4172,7 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Jobs$Search extends StandardParameters { /** - * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3939,7 +4184,7 @@ export namespace jobs_v3 { export interface Params$Resource$Projects$Jobs$Searchforalert extends StandardParameters { /** - * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index 0efdb909f7..b4f878af58 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -132,24 +132,24 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$ApplicationInfo { /** - * Optional but at least one of uris, emails or instruction must be specified. 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. + * Optional but at least one of uris, emails or instruction must be specified. 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. */ emails?: string[] | null; /** - * Optional but at least one of uris, emails or instruction must be specified. 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. + * Optional but at least one of uris, emails or instruction must be specified. 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. */ instruction?: string | null; /** - * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. + * Optional but at least one of uris, emails or instruction must be specified. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. */ uris?: string[] | null; } /** - * Input only. Batch delete jobs request. + * Input only. Batch delete jobs request. */ export interface Schema$BatchDeleteJobsRequest { /** - * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string | null; } @@ -192,7 +192,7 @@ export namespace jobs_v3p1beta1 { */ eventId?: string | null; /** - * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. + * Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. */ extraInfo?: {[key: string]: string} | null; /** @@ -209,11 +209,11 @@ export namespace jobs_v3p1beta1 { requestId?: string | null; } /** - * Input only. Parameters needed for commute search. + * Input only. Parameters needed for commute search. */ export interface Schema$CommuteFilter { /** - * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. + * Optional. If true, jobs without "precise" addresses (street level addresses or GPS coordinates) might also be returned. For city and coarser level addresses, text matching is used. If this field is set to false or is not specified, only jobs that include precise addresses are returned by Commute Search. Note: If `allow_imprecise_addresses` is set to true, Commute Search is not able to calculate accurate commute times to jobs with city level and coarser address information. Jobs with imprecise addresses will return a `travel_duration` time of 0 regardless of distance from the job seeker. */ allowImpreciseAddresses?: boolean | null; /** @@ -221,7 +221,7 @@ export namespace jobs_v3p1beta1 { */ commuteMethod?: string | null; /** - * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. + * Optional. The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution. */ departureTime?: Schema$TimeOfDay; /** @@ -238,7 +238,7 @@ export namespace jobs_v3p1beta1 { travelDuration?: string | null; } /** - * Output only. Commute details related to this job. + * Output only. Commute details related to this job. */ export interface Schema$CommuteInfo { /** @@ -267,11 +267,11 @@ export namespace jobs_v3p1beta1 { */ displayName?: string | null; /** - * Optional. 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. + * Optional. 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. */ eeoText?: string | null; /** - * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. + * Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. */ externalId?: string | null; /** @@ -279,7 +279,7 @@ export namespace jobs_v3p1beta1 { */ headquartersAddress?: string | null; /** - * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. */ hiringAgency?: boolean | null; /** @@ -291,7 +291,7 @@ export namespace jobs_v3p1beta1 { */ keywordSearchableJobCustomAttributes?: string[] | null; /** - * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string | null; /** @@ -303,7 +303,7 @@ export namespace jobs_v3p1beta1 { */ suspended?: boolean | null; /** - * Optional. 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. + * Optional. 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. */ websiteUri?: string | null; } @@ -317,7 +317,7 @@ export namespace jobs_v3p1beta1 { headquartersLocation?: Schema$Location; } /** - * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. */ export interface Schema$CompensationEntry { /** @@ -325,7 +325,7 @@ export namespace jobs_v3p1beta1 { */ amount?: Schema$Money; /** - * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. */ description?: string | null; /** @@ -337,16 +337,16 @@ export namespace jobs_v3p1beta1 { */ range?: Schema$CompensationRange; /** - * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. + * Optional. Compensation type. Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. */ type?: string | null; /** - * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. */ unit?: string | null; } /** - * Input only. Filter on job compensation type and amount. + * Input only. Filter on job compensation type and amount. */ export interface Schema$CompensationFilter { /** @@ -367,7 +367,7 @@ export namespace jobs_v3p1beta1 { units?: string[] | null; } /** - * Input only. Compensation based histogram request. + * Input only. Compensation based histogram request. */ export interface Schema$CompensationHistogramRequest { /** @@ -380,7 +380,7 @@ export namespace jobs_v3p1beta1 { type?: string | null; } /** - * Output only. Compensation based histogram result. + * Output only. Compensation based histogram result. */ export interface Schema$CompensationHistogramResult { /** @@ -397,15 +397,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CompensationInfo { /** - * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedBaseCompensationRange?: Schema$CompensationRange; /** - * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. */ annualizedTotalCompensationRange?: Schema$CompensationRange; /** - * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. */ entries?: Schema$CompensationEntry[]; } @@ -423,7 +423,7 @@ export namespace jobs_v3p1beta1 { minCompensation?: Schema$Money; } /** - * Output only. Response of auto-complete query. + * Output only. Response of auto-complete query. */ export interface Schema$CompleteQueryResponse { /** @@ -436,7 +436,7 @@ export namespace jobs_v3p1beta1 { metadata?: Schema$ResponseMetadata; } /** - * Output only. Resource that represents completion results. + * Output only. Resource that represents completion results. */ export interface Schema$CompletionResult { /** @@ -462,7 +462,7 @@ export namespace jobs_v3p1beta1 { clientEvent?: Schema$ClientEvent; } /** - * Input only. The Request of the CreateCompany method. + * Input only. The Request of the CreateCompany method. */ export interface Schema$CreateCompanyRequest { /** @@ -471,7 +471,7 @@ export namespace jobs_v3p1beta1 { company?: Schema$Company; } /** - * Input only. Create job request. + * Input only. Create job request. */ export interface Schema$CreateJobRequest { /** @@ -484,15 +484,15 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + * Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. */ filterable?: boolean | null; /** - * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. */ longValues?: string[] | null; /** - * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. + * Optional but exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. */ stringValues?: string[] | null; } @@ -514,7 +514,7 @@ export namespace jobs_v3p1beta1 { stringValueHistogram?: boolean | null; } /** - * Output only. Custom attribute histogram result. + * Output only. Custom attribute histogram result. */ export interface Schema$CustomAttributeHistogramResult { /** @@ -531,15 +531,15 @@ export namespace jobs_v3p1beta1 { stringValueHistogramResult?: {[key: string]: number} | null; } /** - * Input only. Custom ranking information for SearchJobsRequest. + * Input only. Custom ranking information for SearchJobsRequest. */ export interface Schema$CustomRankingInfo { /** - * Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified. + * Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified. */ importanceLevel?: string | null; /** - * 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 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 < 100 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) + * 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 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 < 100 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) */ rankingExpression?: string | null; } @@ -557,11 +557,359 @@ export namespace jobs_v3p1beta1 { id?: string | null; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Input only. Histogram facets to be specified in SearchJobsRequest. + * The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchCreateJobsResponse { + /** + * List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchDeleteJobsResponse { + /** + * List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata. + */ + export interface Schema$GoogleCloudTalentV4BatchOperationMetadata { + /** + * The time when the batch operation is created. + */ + createTime?: string | null; + /** + * The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`. + */ + endTime?: string | null; + /** + * Count of failed item(s) inside an operation. + */ + failureCount?: number | null; + /** + * The state of a long running operation. + */ + state?: string | null; + /** + * More detailed information about operation state. + */ + stateDescription?: string | null; + /** + * Count of successful item(s) inside an operation. + */ + successCount?: number | null; + /** + * Count of total item(s) inside an operation. + */ + totalCount?: number | null; + /** + * The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned. + */ + updateTime?: string | null; + } + /** + * The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success. + */ + export interface Schema$GoogleCloudTalentV4BatchUpdateJobsResponse { + /** + * List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED. + */ + jobResults?: Schema$GoogleCloudTalentV4JobResult[]; + } + /** + * Job compensation details. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfo { + /** + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedBaseCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedTotalCompensationRange?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job. + */ + entries?: Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry[]; + } + /** + * A 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 or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationEntry { + /** + * Compensation amount. + */ + amount?: Schema$Money; + /** + * Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + */ + description?: string | null; + /** + * Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 + */ + expectedUnitsPerYear?: number | null; + /** + * Compensation range. + */ + range?: Schema$GoogleCloudTalentV4CompensationInfoCompensationRange; + /** + * Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED. + */ + type?: string | null; + /** + * Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + */ + unit?: string | null; + } + /** + * Compensation range. + */ + export interface Schema$GoogleCloudTalentV4CompensationInfoCompensationRange { + /** + * 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 of min_compensation. + */ + maxCompensation?: Schema$Money; + /** + * 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 of max_compensation. + */ + minCompensation?: Schema$Money; + } + /** + * Custom attribute values that are either filterable or non-filterable. + */ + export interface Schema$GoogleCloudTalentV4CustomAttribute { + /** + * If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + */ + filterable?: boolean | null; + /** + * If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false. + */ + keywordSearchable?: boolean | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported. + */ + longValues?: string[] | null; + /** + * Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed. + */ + stringValues?: string[] | null; + } + /** + * 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. + */ + export interface Schema$GoogleCloudTalentV4Job { + /** + * 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original 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. + */ + addresses?: string[] | null; + /** + * Job application information. + */ + applicationInfo?: Schema$GoogleCloudTalentV4JobApplicationInfo; + /** + * 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". + */ + company?: string | null; + /** + * Output only. Display name of the company listing the job. + */ + companyDisplayName?: string | null; + /** + * Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee. + */ + compensationInfo?: Schema$GoogleCloudTalentV4CompensationInfo; + /** + * 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + */ + customAttributes?: { + [key: string]: Schema$GoogleCloudTalentV4CustomAttribute; + } | null; + /** + * The desired education degrees for the job, such as Bachelors, Masters. + */ + degreeTypes?: string[] | null; + /** + * The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + */ + department?: string | null; + /** + * Output only. Derived details about the job posting. + */ + derivedInfo?: Schema$GoogleCloudTalentV4JobDerivedInfo; + /** + * 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, 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. + */ + description?: string | null; + /** + * The employment type(s) of a job, for example, full time or part time. + */ + employmentTypes?: string[] | null; + /** + * 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. + */ + incentives?: string | null; + /** + * The benefits included with the job. + */ + jobBenefits?: string[] | null; + /** + * The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobEndTime?: string | null; + /** + * The experience level associated with the job, such as "Entry Level". + */ + jobLevel?: string | null; + /** + * The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. + */ + jobStartTime?: string | null; + /** + * 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + */ + languageCode?: string | null; + /** + * 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". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + */ + name?: string | null; + /** + * Output only. The timestamp when this job posting was created. + */ + postingCreateTime?: string | null; + /** + * 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 API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the 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, language_code and 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 must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as 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. If the field masks include 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. + */ + postingExpireTime?: string | null; + /** + * 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. + */ + postingPublishTime?: string | null; + /** + * The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a 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 or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. + */ + postingRegion?: string | null; + /** + * Output only. The timestamp when this job posting was last updated. + */ + postingUpdateTime?: string | null; + /** + * Options for job processing. + */ + processingOptions?: Schema$GoogleCloudTalentV4JobProcessingOptions; + /** + * 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. + */ + promotionValue?: number | null; + /** + * 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 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. + */ + qualifications?: string | null; + /** + * 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, language_code and requisition_id. The maximum number of allowed characters is 255. + */ + requisitionId?: string | null; + /** + * A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + */ + responsibilities?: string | null; + /** + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + */ + title?: string | null; + /** + * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. + */ + visibility?: string | null; + } + /** + * Application related details of a job posting. + */ + export interface Schema$GoogleCloudTalentV4JobApplicationInfo { + /** + * 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. + */ + emails?: string[] | null; + /** + * 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. + */ + instruction?: string | null; + /** + * Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. + */ + uris?: string[] | null; + } + /** + * Derived details about the job posting. + */ + export interface Schema$GoogleCloudTalentV4JobDerivedInfo { + /** + * Job categories derived from Job.title and Job.description. + */ + jobCategories?: string[] | null; + /** + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. + */ + locations?: Schema$GoogleCloudTalentV4Location[]; + } + /** + * Options for job processing. + */ + export interface Schema$GoogleCloudTalentV4JobProcessingOptions { + /** + * If set to `true`, the service does not attempt to resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * 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. + */ + htmlSanitization?: string | null; + } + /** + * Mutation result of a job from a batch operation. + */ + export interface Schema$GoogleCloudTalentV4JobResult { + /** + * 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. + */ + job?: Schema$GoogleCloudTalentV4Job; + /** + * The status of the job processed. This field is populated if the processing of the job fails. + */ + status?: Schema$Status; + } + /** + * A resource that represents a location with full geographic information. + */ + export interface Schema$GoogleCloudTalentV4Location { + /** + * An object representing a latitude/longitude pair. + */ + latLng?: Schema$LatLng; + /** + * The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType.NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType.LOCALITY. + */ + locationType?: string | null; + /** + * 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. + */ + postalAddress?: Schema$PostalAddress; + /** + * 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 covers the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 6.17 miles. + */ + radiusMiles?: number | null; + } + /** + * Input only. Histogram facets to be specified in SearchJobsRequest. */ export interface Schema$HistogramFacets { /** @@ -578,20 +926,20 @@ export namespace jobs_v3p1beta1 { simpleHistogramFacets?: string[] | null; } /** - * Input Only. The histogram request. + * Input Only. The histogram request. */ export interface Schema$HistogramQuery { /** - * An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * 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_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the 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. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the 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. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric 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"]) + * An expression specifies a histogram request against matching resources (for example, jobs) for searches. Expression syntax is a aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entity, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entity within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * 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_id: histogram by [Job.distributor_company_id. * company_display_name: histogram by Job.company_display_name. * employment_type: histogram by Job.employment_types. For example, "FULL_TIME", "PART_TIME". * company_size: histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG". * publish_time_in_month: histogram by the Job.publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.publish_time in years. Must specify list of numeric buckets in spec. * degree_type: histogram by the Job.degree_type. For example, "Bachelors", "Masters". * job_level: histogram by the 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. For example, "en-US", "fr-FR". * language: histogram by the language subtag of the Job.language_code. For example, "en", "fr". * category: histogram by the JobCategory. For example, "COMPUTER_AND_IT", "HEALTHCARE". * base_compensation_unit: histogram by the 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. Values can be accessed via square bracket notations like string_custom_attribute["key1"]. * numeric_custom_attribute: histogram by numeric 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"]) */ histogramQuery?: string | null; } /** - * Output only. Histogram result that matches HistogramSpec specified in searches. + * Output only. Histogram result that matches HistogramSpec specified in searches. */ export interface Schema$HistogramQueryResult { /** - * 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 for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`. + * 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 for `bucket(0, MAX, "non-negative")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`. */ histogram?: {[key: string]: string} | null; /** @@ -600,7 +948,7 @@ export namespace jobs_v3p1beta1 { histogramQuery?: string | null; } /** - * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. */ export interface Schema$HistogramResult { /** @@ -608,12 +956,12 @@ export namespace jobs_v3p1beta1 { */ searchType?: string | null; /** - * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. */ values?: {[key: string]: number} | null; } /** - * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. + * Output only. Histogram results that match HistogramFacets specified in SearchJobsRequest. */ export interface Schema$HistogramResults { /** @@ -634,11 +982,11 @@ export namespace jobs_v3p1beta1 { */ export interface Schema$Job { /** - * Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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. + * Optional but 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_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original 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. */ addresses?: string[] | null; /** - * Required. At least one field within ApplicationInfo must be specified. Job application information. + * Required. At least one field within ApplicationInfo must be specified. Job application information. */ applicationInfo?: Schema$ApplicationInfo; /** @@ -654,7 +1002,7 @@ export namespace jobs_v3p1beta1 { */ compensationInfo?: Schema$CompensationInfo; /** - * Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + * Optional. 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*. 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 unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. */ customAttributes?: {[key: string]: Schema$CustomAttribute} | null; /** @@ -662,7 +1010,7 @@ export namespace jobs_v3p1beta1 { */ degreeTypes?: string[] | null; /** - * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. */ department?: string | null; /** @@ -670,7 +1018,7 @@ export namespace jobs_v3p1beta1 { */ derivedInfo?: Schema$JobDerivedInfo; /** - * 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, 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. + * 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, 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. */ description?: string | null; /** @@ -678,7 +1026,7 @@ export namespace jobs_v3p1beta1 { */ employmentTypes?: string[] | null; /** - * Optional. 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. + * Optional. 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. */ incentives?: string | null; /** @@ -698,11 +1046,11 @@ export namespace jobs_v3p1beta1 { */ jobStartTime?: string | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + * Optional. 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](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. */ languageCode?: string | null; /** - * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string | null; /** @@ -710,7 +1058,7 @@ export namespace jobs_v3p1beta1 { */ postingCreateTime?: string | null; /** - * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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. + * Optional but 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 deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob 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_name, language_code and 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 of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not 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 is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_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. */ postingExpireTime?: string | null; /** @@ -730,32 +1078,32 @@ export namespace jobs_v3p1beta1 { */ processingOptions?: Schema$ProcessingOptions; /** - * Optional. 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. + * Optional. 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. */ promotionValue?: number | null; /** - * Optional. 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 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. + * Optional. 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 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. */ qualifications?: string | null; /** - * Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. + * Required. The requisition ID, also referred to as the posting ID, 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 is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. */ requisitionId?: string | null; /** - * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general 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. */ responsibilities?: string | null; /** - * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. */ title?: string | null; /** - * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. + * Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. */ visibility?: string | null; } /** - * Output only. Derived details about the job posting. + * Output only. Derived details about the job posting. */ export interface Schema$JobDerivedInfo { /** @@ -763,7 +1111,7 @@ export namespace jobs_v3p1beta1 { */ jobCategories?: string[] | null; /** - * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. + * Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order. */ locations?: Schema$Location[]; } @@ -781,19 +1129,19 @@ export namespace jobs_v3p1beta1 { type?: string | null; } /** - * Input only. The query required to perform a search query. + * Input only. The query required to perform a search query. */ export interface Schema$JobQuery { /** - * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. */ commuteFilter?: Schema$CommuteFilter; /** - * Optional. This filter specifies the exact company display name of the jobs to search against. 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. + * Optional. This filter specifies the exact company display name of the jobs to search against. 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. */ companyDisplayNames?: string[] | null; /** - * Optional. 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. + * Optional. 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". At most 20 company filters are allowed. */ companyNames?: string[] | null; /** @@ -801,31 +1149,31 @@ export namespace jobs_v3p1beta1 { */ compensationFilter?: Schema$CompensationFilter; /** - * Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` + * Optional. This filter specifies a structured syntax to match against the 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 and `EMPTY([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 < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` */ customAttributeFilter?: string | null; /** - * Optional. 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. + * Optional. 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. */ disableSpellCheck?: boolean | null; /** - * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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. + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not 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. */ employmentTypes?: string[] | null; /** - * Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. + * Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. */ excludedJobs?: string[] | null; /** - * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. */ jobCategories?: string[] | null; /** - * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + * Optional. 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](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. */ languageCodes?: string[] | null; /** - * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. + * Optional. The location filter specifies geo-regions containing the jobs to search against. See 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 parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** @@ -833,16 +1181,16 @@ export namespace jobs_v3p1beta1 { */ publishTimeRange?: Schema$TimestampRange; /** - * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. + * Optional. The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255. */ query?: string | null; /** - * The language code of 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](https://tools.ietf.org/html/bcp47). + * The language code of 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](https://tools.ietf.org/html/bcp47). */ queryLanguageCode?: string | null; } /** - * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. + * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. */ export interface Schema$LatLng { /** @@ -855,7 +1203,7 @@ export namespace jobs_v3p1beta1 { longitude?: number | null; } /** - * Output only. The List companies response object. + * Output only. The List companies response object. */ export interface Schema$ListCompaniesResponse { /** @@ -872,11 +1220,11 @@ export namespace jobs_v3p1beta1 { nextPageToken?: string | null; } /** - * Output only. List jobs response. + * Output only. List jobs response. */ export interface Schema$ListJobsResponse { /** - * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. */ jobs?: Schema$Job[]; /** @@ -889,7 +1237,7 @@ export namespace jobs_v3p1beta1 { nextPageToken?: string | null; } /** - * Output only. A resource that represents a location with full geographic information. + * Output only. A resource that represents a location with full geographic information. */ export interface Schema$Location { /** @@ -910,7 +1258,7 @@ export namespace jobs_v3p1beta1 { radiusInMiles?: number | null; } /** - * Input only. Geographic region of the search. + * Input only. Geographic region of the search. */ export interface Schema$LocationFilter { /** @@ -926,20 +1274,20 @@ export namespace jobs_v3p1beta1 { */ latLng?: Schema$LatLng; /** - * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + * Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide, but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. */ regionCode?: string | null; /** - * Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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. + * Optional. 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 indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. 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. */ telecommutePreference?: string | null; } /** - * Output only. Job entry with metadata inside SearchJobsResponse. + * Output only. Job entry with metadata inside SearchJobsResponse. */ export interface Schema$MatchingJob { /** - * Commute information which is generated based on specified CommuteFilter. + * Commute information which is generated based on specified CommuteFilter. */ commuteInfo?: Schema$CommuteInfo; /** @@ -1034,7 +1382,7 @@ export namespace jobs_v3p1beta1 { */ disableManualEnrollmentSelection?: boolean | null; /** - * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. */ disableOrganicSelection?: boolean | null; /** @@ -1047,7 +1395,7 @@ export namespace jobs_v3p1beta1 { forcedRollouts?: {[key: string]: boolean} | null; } /** - * Input only. Use this field to specify bucketing option for the histogram search response. + * Input only. Use this field to specify bucketing option for the histogram search response. */ export interface Schema$NumericBucketingOption { /** @@ -1060,7 +1408,7 @@ export namespace jobs_v3p1beta1 { requiresMinMax?: boolean | null; } /** - * Output only. Custom numeric bucketing result. + * Output only. Custom numeric bucketing result. */ export interface Schema$NumericBucketingResult { /** @@ -1089,7 +1437,7 @@ export namespace jobs_v3p1beta1 { */ error?: Schema$Status; /** - * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */ metadata?: {[key: string]: any} | null; /** @@ -1097,16 +1445,16 @@ export namespace jobs_v3p1beta1 { */ name?: string | null; /** - * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } /** - * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 */ export interface Schema$PostalAddress { /** - * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). */ addressLines?: string[] | null; /** @@ -1114,7 +1462,7 @@ export namespace jobs_v3p1beta1 { */ administrativeArea?: string | null; /** - * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". */ languageCode?: string | null; /** @@ -1138,7 +1486,7 @@ export namespace jobs_v3p1beta1 { */ regionCode?: string | null; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. */ revision?: number | null; /** @@ -1151,7 +1499,7 @@ export namespace jobs_v3p1beta1 { sublocality?: string | null; } /** - * Input only. Options for job processing. + * Input only. Options for job processing. */ export interface Schema$ProcessingOptions { /** @@ -1159,12 +1507,12 @@ export namespace jobs_v3p1beta1 { */ disableStreetAddressResolution?: boolean | null; /** - * Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + * Optional. 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 is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. */ htmlSanitization?: string | null; } /** - * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. */ export interface Schema$RequestMetadata { /** @@ -1172,20 +1520,20 @@ export namespace jobs_v3p1beta1 { */ deviceInfo?: Schema$DeviceInfo; /** - * Required. 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 <em>Foo, Inc.</em>, 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. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. + * Required. 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. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. */ domain?: string | null; /** - * Required. 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. + * Required. 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. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. */ sessionId?: string | null; /** - * Required. 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. If this field is not available for some reason, send "UNKNOWN". 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. + * Required. 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. If this field is not available for some reason, send "UNKNOWN". 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. */ userId?: string | null; } /** - * Output only. Additional information returned to client, such as debugging information. + * Output only. Additional information returned to client, such as debugging information. */ export interface Schema$ResponseMetadata { /** @@ -1194,7 +1542,7 @@ export namespace jobs_v3p1beta1 { requestId?: string | null; } /** - * Input only. The Request body of the `SearchJobs` call. + * Input only. The Request body of the `SearchJobs` call. */ export interface Schema$SearchJobsRequest { /** @@ -1202,15 +1550,15 @@ export namespace jobs_v3p1beta1 { */ customRankingInfo?: Schema$CustomRankingInfo; /** - * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. + * Optional. Controls whether to disable exact keyword match on Job.job_title, Job.description, Job.company_display_name, Job.locations, 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, the query "program manager," a result is returned even if the job posting has the title "software developer," which does not fall into "program manager" ontology, but does have "program manager" appearing in its description. For queries like "cloud" that does not contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value. Please use Company.keyword_searchable_custom_fields or Company.keyword_searchable_custom_attributes if company specific globally matched custom field/attribute string values is needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false. */ disableKeywordMatch?: boolean | null; /** - * Optional. 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 if no value is specified. + * Optional. 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 if no value is specified. */ diversificationLevel?: string | null; /** - * Optional. 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. + * Optional. 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. */ enableBroadening?: boolean | null; /** @@ -1230,11 +1578,11 @@ export namespace jobs_v3p1beta1 { */ jobView?: string | null; /** - * Optional. 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 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). + * Optional. 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 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). */ offset?: number | null; /** - * Optional. 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 descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's 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 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 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 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.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance:<br> "`distance_from('Hawaii')`": Order by distance from Hawaii.<br> "`distance_from(19.89, 155.5)`": Order by distance from a coordinate.<br> "`distance_from('Hawaii'), distance_from('Puerto Rico')`": Order by multiple locations. See details below.<br> "`distance_from('Hawaii'), distance_from(19.89, 155.5)`": Order by multiple locations. See details below.<br> 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. + * Optional. 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 descending. * `"posting_update_time desc"`: By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: By job's 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 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 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 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.custom_ranking_info.ranking_expression with weight factor assigned by SearchJobsRequest.custom_ranking_info.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. */ orderBy?: string | null; /** @@ -1250,16 +1598,16 @@ export namespace jobs_v3p1beta1 { */ requestMetadata?: Schema$RequestMetadata; /** - * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. + * This field is deprecated. */ requirePreciseResultSize?: boolean | null; /** - * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. + * Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. */ searchMode?: string | null; } /** - * Output only. Response for SearchJob method. + * Output only. Response for SearchJob method. */ export interface Schema$SearchJobsResponse { /** @@ -1267,7 +1615,7 @@ export namespace jobs_v3p1beta1 { */ broadenedQueryJobsCount?: number | null; /** - * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see enable_precise_result_size. + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size. */ estimatedTotalSize?: number | null; /** @@ -1299,12 +1647,12 @@ export namespace jobs_v3p1beta1 { */ spellCorrection?: Schema$SpellingCorrection; /** - * The precise result count, which is available only if the client set enable_precise_result_size to `true`, or if the response is the last page of results. Otherwise, the value is `-1`. + * The precise result count with limit 100,000. */ totalSize?: number | null; } /** - * Output only. Spell check result. + * Output only. Spell check result. */ export interface Schema$SpellingCorrection { /** @@ -1317,7 +1665,7 @@ export namespace jobs_v3p1beta1 { correctedText?: string | null; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** @@ -1325,7 +1673,7 @@ export namespace jobs_v3p1beta1 { */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ details?: Array<{[key: string]: any}> | null; /** @@ -1368,7 +1716,7 @@ export namespace jobs_v3p1beta1 { startTime?: string | null; } /** - * Input only. Request for updating a specified company. + * Input only. Request for updating a specified company. */ export interface Schema$UpdateCompanyRequest { /** @@ -1376,12 +1724,12 @@ export namespace jobs_v3p1beta1 { */ company?: Schema$Company; /** - * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. + * Optional but strongly recommended for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. */ updateMask?: string | null; } /** - * Input only. Update job request. + * Input only. Update job request. */ export interface Schema$UpdateJobRequest { /** @@ -1389,7 +1737,7 @@ export namespace jobs_v3p1beta1 { */ job?: Schema$Job; /** - * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. + * Optional but strongly recommended to be provided for the best service experience. If update_mask is provided, only the specified fields in 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 are supported. */ updateMask?: string | null; } @@ -1438,63 +1786,17 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.complete({ - * // Optional. If provided, restricts completion to specified company. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * companyName: 'placeholder-value', - * // Deprecated. Use language_codes instead. - * // - * // Optional. - * // - * // The language 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](https://tools.ietf.org/html/bcp47). - * // - * // For CompletionType.JOB_TITLE type, only open jobs with the same - * // language_code are returned. - * // - * // For CompletionType.COMPANY_NAME type, - * // only companies having open jobs with the same language_code are - * // returned. - * // - * // For CompletionType.COMBINED type, only open jobs with the same - * // language_code or companies having open jobs with the same - * // language_code are returned. - * // - * // The maximum number of allowed characters is 255. + * // Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. * languageCode: 'placeholder-value', - * // Optional. 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](https://tools.ietf.org/html/bcp47). - * // - * // For CompletionType.JOB_TITLE type, only open jobs with the same - * // language_codes are returned. - * // - * // For CompletionType.COMPANY_NAME type, - * // only companies having open jobs with the same language_codes are - * // returned. - * // - * // For CompletionType.COMBINED type, only open jobs with the same - * // language_codes or companies having open jobs with the same - * // language_codes are returned. - * // - * // The maximum number of allowed characters is 255. + * // Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. * languageCodes: 'placeholder-value', - * // Required. Resource name of project the completion is performed within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * name: 'projects/my-project', - * // Required. Completion result count. - * // - * // The maximum allowed page size is 10. + * // Required. Completion result count. The maximum allowed page size is 10. * pageSize: 'placeholder-value', - * // Required. The query used to generate suggestions. - * // - * // The maximum number of allowed characters is 255. + * // Required. The query used to generate suggestions. The maximum number of allowed characters is 255. * query: 'placeholder-value', * // Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. * scope: 'placeholder-value', @@ -1519,12 +1821,12 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. - * @param {string=} params.languageCodes Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. - * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". - * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. - * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. + * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. + * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. * @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. * @param {string=} params.type Optional. The completion topic. The default is CompletionType.COMBINED. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1621,27 +1923,27 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Complete extends StandardParameters { /** - * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ companyName?: string; /** - * Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * Deprecated. Use language_codes instead. Optional. The language 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. */ languageCode?: string; /** - * Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. + * Optional. 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](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. */ languageCodes?: string[]; /** - * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ name?: string; /** - * Required. Completion result count. The maximum allowed page size is 10. + * Required. Completion result count. The maximum allowed page size is 10. */ pageSize?: number; /** - * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. */ query?: string; /** @@ -1858,10 +2160,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.companies.create({ - * // Required. Resource name of the project under which the company is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -1901,7 +2200,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().CreateCompanyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2016,10 +2315,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.companies.delete({ - * // Required. The resource name of the company to be deleted. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * }); * console.log(res.data); @@ -2037,7 +2333,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.name Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2148,10 +2444,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.companies.get({ - * // Required. The resource name of the company to be retrieved. - * // - * // The format is "projects/{project_id}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * }); * console.log(res.data); @@ -2183,7 +2476,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.name Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2294,22 +2587,13 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.companies.list({ - * // Optional. The maximum number of companies to be returned, at most 100. - * // Default is 100 if a non-positive number is provided. + * // Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * pageSize: 'placeholder-value', * // Optional. The starting indicator from which to return results. * pageToken: 'placeholder-value', - * // Required. Resource name of the project under which the company is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', - * // Optional. Set to true if the companies requested must have open jobs. - * // - * // Defaults to false. - * // - * // If true, at most page_size of companies are fetched, among which - * // only those with open jobs are returned. + * // Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * requireOpenJobs: 'placeholder-value', * }); * console.log(res.data); @@ -2333,8 +2617,8 @@ export namespace jobs_v3p1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. * @param {string=} params.pageToken Optional. The starting indicator from which to return results. - * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". - * @param {boolean=} params.requireOpenJobs Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * @param {string} params.parent Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {boolean=} params.requireOpenJobs Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2453,13 +2737,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.companies.patch({ - * // 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}/companies/{company_id}", for example, - * // "projects/api-test-project/companies/foo". + * // 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * name: 'projects/my-project/companies/my-companie', * * // Request body metadata @@ -2500,7 +2778,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * @param {string} params.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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". * @param {().UpdateCompanyRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2586,7 +2864,7 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Companies$Create extends StandardParameters { /** - * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -2598,14 +2876,14 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Companies$Delete extends StandardParameters { /** - * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be deleted. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } export interface Params$Resource$Projects$Companies$Get extends StandardParameters { /** - * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; } @@ -2620,18 +2898,18 @@ export namespace jobs_v3p1beta1 { */ pageToken?: string; /** - * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. Resource name of the project under which the company is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; /** - * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. */ requireOpenJobs?: boolean; } export interface Params$Resource$Projects$Companies$Patch extends StandardParameters { /** - * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". + * 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}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". */ name?: string; @@ -2677,10 +2955,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.batchDelete({ - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -2706,7 +2981,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().BatchDeleteJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2793,7 +3068,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.create - * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2821,10 +3096,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.create({ - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -2881,7 +3153,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().CreateJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2968,7 +3240,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.delete - * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -2996,10 +3268,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.delete({ - * // Required. The resource name of the job to be deleted. - * // - * // The format is "projects/{project_id}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". + * // Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * name: 'projects/my-project/jobs/my-job', * }); * console.log(res.data); @@ -3017,7 +3286,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * @param {string} params.name Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3128,10 +3397,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.get({ - * // Required. The resource name of the job to retrieve. - * // - * // The format is "projects/{project_id}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". + * // Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * name: 'projects/my-project/jobs/my-job', * }); * console.log(res.data); @@ -3180,7 +3446,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * @param {string} params.name Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3291,38 +3557,15 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.list({ - * // Required. The filter string specifies the jobs to be enumerated. - * // - * // Supported operator: =, AND - * // - * // The fields eligible for filtering are: - * // - * // * `companyName` (Required) - * // * `requisitionId` (Optional) - * // - * // Sample Query: - * // - * // * companyName = "projects/api-test-project/companies/123" - * // * companyName = "projects/api-test-project/companies/123" AND requisitionId - * // = "req-1" + * // Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" * filter: 'placeholder-value', - * // Optional. The desired job attributes returned for jobs in the - * // search response. Defaults to JobView.JOB_VIEW_FULL if no value is - * // specified. + * // Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. * jobView: 'placeholder-value', - * // Optional. The maximum number of jobs to be returned per page of results. - * // - * // If job_view is set to 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. + * // Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. * pageSize: 'placeholder-value', * // Optional. The starting point of a query result. * pageToken: 'placeholder-value', - * // Required. The resource name of the project under which the job is created. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * }); * console.log(res.data); @@ -3344,11 +3587,11 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" * @param {string=} params.jobView Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified. - * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. * @param {string=} params.pageToken Optional. The starting point of a query result. - * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3434,7 +3677,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.patch - * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. * @example * // Before running the sample: * // - Enable the API at: @@ -3462,16 +3705,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.patch({ - * // 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}/jobs/{job_id}", - * // for example, "projects/api-test-project/jobs/1234". - * // - * // Use of this field in job queries and API calls is preferred over the use of - * // requisition_id since this value is unique. + * // 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * name: 'projects/my-project/jobs/my-job', * * // Request body metadata @@ -3529,7 +3763,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * @param {string} params.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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. * @param {().UpdateJobRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3613,7 +3847,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.search - * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -3641,10 +3875,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.search({ - * // Required. The resource name of the project to search within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -3695,7 +3926,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().SearchJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3785,7 +4016,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.jobs.searchForAlert - * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. * @example * // Before running the sample: * // - Enable the API at: @@ -3813,10 +4044,7 @@ export namespace jobs_v3p1beta1 { * * // Do the magic * const res = await jobs.projects.jobs.searchForAlert({ - * // Required. The resource name of the project to search within. - * // - * // The format is "projects/{project_id}", for example, - * // "projects/api-test-project". + * // Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * parent: 'projects/my-project', * * // Request body metadata @@ -3867,7 +4095,7 @@ export namespace jobs_v3p1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * @param {string} params.parent Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {().SearchJobsRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3961,7 +4189,7 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Jobs$Batchdelete extends StandardParameters { /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3973,7 +4201,7 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Jobs$Create extends StandardParameters { /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -3985,21 +4213,21 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Jobs$Delete extends StandardParameters { /** - * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to be deleted. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } export interface Params$Resource$Projects$Jobs$Get extends StandardParameters { /** - * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". + * Required. The resource name of the job to retrieve. The format is "projects/{project_id}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". */ name?: string; } export interface Params$Resource$Projects$Jobs$List extends StandardParameters { /** - * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "projects/api-test-project/companies/123" * companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1" */ filter?: string; /** @@ -4007,7 +4235,7 @@ export namespace jobs_v3p1beta1 { */ jobView?: string; /** - * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. + * Optional. The maximum number of jobs to be returned per page of results. If job_view is set to 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. */ pageSize?: number; /** @@ -4015,14 +4243,14 @@ export namespace jobs_v3p1beta1 { */ pageToken?: string; /** - * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project under which the job is created. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; } export interface Params$Resource$Projects$Jobs$Patch extends StandardParameters { /** - * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * 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}/jobs/{job_id}", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. */ name?: string; @@ -4034,7 +4262,7 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Jobs$Search extends StandardParameters { /** - * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -4046,7 +4274,7 @@ export namespace jobs_v3p1beta1 { export interface Params$Resource$Projects$Jobs$Searchforalert extends StandardParameters { /** - * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". + * Required. The resource name of the project to search within. The format is "projects/{project_id}", for example, "projects/api-test-project". */ parent?: string; @@ -4064,7 +4292,7 @@ export namespace jobs_v3p1beta1 { /** * jobs.projects.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * // Before running the sample: * // - Enable the API at: