Google Cloud Talent Solution V4beta1 Client - Class SearchJobsResponse (1.1.1)

Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 Client class SearchJobsResponse.

Response for SearchJob method.

Generated from protobuf message google.cloud.talent.v4beta1.SearchJobsResponse

Namespace

Google \ Cloud \ Talent \ V4beta1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ matching_jobs array<Google\Cloud\Talent\V4beta1\SearchJobsResponse\MatchingJob>

The Job entities that match the specified SearchJobsRequest.

↳ histogram_query_results array<Google\Cloud\Talent\V4beta1\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<Google\Cloud\Talent\V4beta1\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.

↳ estimated_total_size int

An estimation of the number of jobs that match the specified query. This number isn't guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size.

↳ total_size int

The precise result count with limit 100,000.

↳ metadata Google\Cloud\Talent\V4beta1\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 Google\Cloud\Talent\V4beta1\SpellingCorrection

The spell checking result, and correction.

getMatchingJobs

The Job entities that match the specified SearchJobsRequest.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMatchingJobs

The Job entities that match the specified SearchJobsRequest.

Parameter
NameDescription
var array<Google\Cloud\Talent\V4beta1\SearchJobsResponse\MatchingJob>
Returns
TypeDescription
$this

getHistogramQueryResults

The histogram results that match with specified SearchJobsRequest.histogram_queries.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setHistogramQueryResults

The histogram results that match with specified SearchJobsRequest.histogram_queries.

Parameter
NameDescription
var array<Google\Cloud\Talent\V4beta1\HistogramQueryResult>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Talent\V4beta1\Location>
Returns
TypeDescription
$this

getEstimatedTotalSize

An estimation of the number of jobs that match the specified query.

This number isn't guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size.

Returns
TypeDescription
int

setEstimatedTotalSize

An estimation of the number of jobs that match the specified query.

This number isn't guaranteed to be accurate. For accurate results, see SearchJobsResponse.total_size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTotalSize

The precise result count with limit 100,000.

Returns
TypeDescription
int

setTotalSize

The precise result count with limit 100,000.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMetadata

Additional information for the API invocation, such as the request tracking id.

Returns
TypeDescription
Google\Cloud\Talent\V4beta1\ResponseMetadata|null

hasMetadata

clearMetadata

setMetadata

Additional information for the API invocation, such as the request tracking id.

Parameter
NameDescription
var Google\Cloud\Talent\V4beta1\ResponseMetadata
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getSpellCorrection

The spell checking result, and correction.

Returns
TypeDescription
Google\Cloud\Talent\V4beta1\SpellingCorrection|null

hasSpellCorrection

clearSpellCorrection

setSpellCorrection

The spell checking result, and correction.

Parameter
NameDescription
var Google\Cloud\Talent\V4beta1\SpellingCorrection
Returns
TypeDescription
$this