Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class SearchJobsResponse.
Response for SearchJob method.
Generated from protobuf message google.cloud.talent.v4.SearchJobsResponse
Namespace
Google \ Cloud \ Talent \ V4Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ matching_jobs |
array<SearchJobsResponse\MatchingJob>
The Job entities that match the specified SearchJobsRequest. |
↳ histogram_query_results |
array<HistogramQueryResult>
The histogram results that match with specified SearchJobsRequest.histogram_queries. |
↳ next_page_token |
string
The token that specifies the starting position of the next page of results. This field is empty if there are no more results. |
↳ location_filters |
array<Location>
The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED. |
↳ total_size |
int
Number of jobs that match the specified query. Note: This size is precise only if the total is less than 100,000. |
↳ metadata |
ResponseMetadata
Additional information for the API invocation, such as the request tracking id. |
↳ broadened_query_jobs_count |
int
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. |
↳ spell_correction |
SpellingCorrection
The spell checking result, and correction. |
getMatchingJobs
The Job entities that match the specified SearchJobsRequest.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMatchingJobs
The Job entities that match the specified SearchJobsRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SearchJobsResponse\MatchingJob>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHistogramQueryResults
The histogram results that match with specified SearchJobsRequest.histogram_queries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setHistogramQueryResults
The histogram results that match with specified SearchJobsRequest.histogram_queries.
| Parameter | |
|---|---|
| Name | Description |
var |
array<HistogramQueryResult>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextPageToken
The token that specifies the starting position of the next page of results.
This field is empty if there are no more results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNextPageToken
The token that specifies the starting position of the next page of results.
This field is empty if there are no more results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationFilters
The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setLocationFilters
The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Location>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTotalSize
Number of jobs that match the specified query.
Note: This size is precise only if the total is less than 100,000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTotalSize
Number of jobs that match the specified query.
Note: This size is precise only if the total is less than 100,000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadata
Additional information for the API invocation, such as the request tracking id.
| Returns | |
|---|---|
| Type | Description |
ResponseMetadata|null |
|
hasMetadata
clearMetadata
setMetadata
Additional information for the API invocation, such as the request tracking id.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBroadenedQueryJobsCount
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setBroadenedQueryJobsCount
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpellCorrection
The spell checking result, and correction.
| Returns | |
|---|---|
| Type | Description |
SpellingCorrection|null |
|
hasSpellCorrection
clearSpellCorrection
setSpellCorrection
The spell checking result, and correction.
| Parameter | |
|---|---|
| Name | Description |
var |
SpellingCorrection
|
| Returns | |
|---|---|
| Type | Description |
$this |
|