Class SearchProfilesRequest (0.6.3)

The request body of the SearchProfiles call. .. attribute:: parent

Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

Search query to execute. See ProfileQuery for more details.

The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a [nextPageToken][google.cloud.talent.v4beta 1.SearchProfilesResponse.next_page_token] field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query. For example, "enginee" is corrected to "engineer".

When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).

An id that uniquely identifies the result set of a [SearchProf iles][google.cloud.talent.v4beta1.ProfileService.SearchProfile s] call. The id should be retrieved from the [SearchProfilesRe sponse][google.cloud.talent.v4beta1.SearchProfilesResponse] message returned from a previous invocation of [SearchProfiles ][google.cloud.talent.v4beta1.ProfileService.SearchProfiles]. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the [p rofile_query][google.cloud.talent.v4beta1.SearchProfilesReque st.profile_query]. A new [result_set_id][google.cloud.talen t.v4beta1.SearchProfilesRequest.result_set_id] is returned as a handle to access this result set. If this field is set, the service will ignore the resource and [profile_query][goog le.cloud.talent.v4beta1.SearchProfilesRequest.profile_query] values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of [p age_token][google.cloud.talent.v4beta1.SearchProfilesRequest. page_token] or [offset][google.cloud.talent.v4beta1.SearchPro filesRequest.offset] must be set. A typical use case is to invoke [SearchProfilesRequest][google.cloud.talent.v4beta1.Sea rchProfilesRequest] without this field, then use the resulting [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRe quest.result_set_id] in [SearchProfilesResponse][google.clou d.talent.v4beta1.SearchProfilesResponse] to page through the results.