Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class ListJobsRequest.
List jobs request.
Generated from protobuf message google.cloud.talent.v4.ListJobsRequest
Namespace
Google \ Cloud \ Talent \ V4
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the tenant under which the job is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
↳ filter
string
Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * * companyName * * requisitionId * * status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. At least one of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown. Sample Query: * * companyName = "projects/foo/tenants/bar/companies/baz" * * companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1" * * companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED" * * requisitionId = "req-1" * * requisitionId = "req-1" AND status = "EXPIRED"
↳ page_token
string
The starting point of a query result.
↳ page_size
int
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.
↳ job_view
int
The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.
getParent
Required. The resource name of the tenant under which the job is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example,
"projects/foo/tenants/bar".
Returns
Type
Description
string
setParent
Required. The resource name of the tenant under which the job is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example,
"projects/foo/tenants/bar".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
The fields eligible for filtering are:
companyName
requisitionId
status Available values: OPEN, EXPIRED, ALL. Defaults to
OPEN if no value is specified.
At least one of companyName and requisitionId must present or an
INVALID_ARGUMENT error is thrown.
Sample Query:
companyName = "projects/foo/tenants/bar/companies/baz" AND
requisitionId = "req-1"
companyName = "projects/foo/tenants/bar/companies/baz" AND
status = "EXPIRED"
requisitionId = "req-1"
requisitionId = "req-1" AND status = "EXPIRED"
Returns
Type
Description
string
setFilter
Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
The fields eligible for filtering are:
companyName
requisitionId
status Available values: OPEN, EXPIRED, ALL. Defaults to
OPEN if no value is specified.
At least one of companyName and requisitionId must present or an
INVALID_ARGUMENT error is thrown.
Sample Query:
companyName = "projects/foo/tenants/bar/companies/baz" AND
requisitionId = "req-1"
companyName = "projects/foo/tenants/bar/companies/baz" AND
status = "EXPIRED"
requisitionId = "req-1"
requisitionId = "req-1" AND status = "EXPIRED"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageToken
The starting point of a query result.
Returns
Type
Description
string
setPageToken
The starting point of a query result.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
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.
Returns
Type
Description
int
setPageSize
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getJobView
The desired job attributes returned for jobs in the
search response. Defaults to
JobView.JOB_VIEW_FULL if no
value is specified.
Returns
Type
Description
int
Enum of type JobView.
setJobView
The desired job attributes returned for jobs in the
search response. Defaults to
JobView.JOB_VIEW_FULL if no
value is specified.
Parameter
Name
Description
var
int
Enum of type JobView.
Returns
Type
Description
$this
static::build
Parameters
Name
Description
parent
string
Required. The resource name of the tenant under which the job is created.
The format is "projects/{project_id}/tenants/{tenant_id}". For example,
"projects/foo/tenants/bar". Please see
JobServiceClient::tenantName() for help formatting this field.
filter
string
Required. The filter string specifies the jobs to be enumerated.
Supported operator: =, AND
The fields eligible for filtering are:
companyName
requisitionId
status Available values: OPEN, EXPIRED, ALL. Defaults to
OPEN if no value is specified.
At least one of companyName and requisitionId must present or an
INVALID_ARGUMENT error is thrown.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Talent Solution V4 Client - Class ListJobsRequest (2.1.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.3 (latest)](/php/docs/reference/cloud-talent/latest/V4.ListJobsRequest)\n- [2.1.2](/php/docs/reference/cloud-talent/2.1.2/V4.ListJobsRequest)\n- [2.0.2](/php/docs/reference/cloud-talent/2.0.2/V4.ListJobsRequest)\n- [1.3.5](/php/docs/reference/cloud-talent/1.3.5/V4.ListJobsRequest)\n- [1.2.2](/php/docs/reference/cloud-talent/1.2.2/V4.ListJobsRequest)\n- [1.1.1](/php/docs/reference/cloud-talent/1.1.1/V4.ListJobsRequest)\n- [1.0.5](/php/docs/reference/cloud-talent/1.0.5/V4.ListJobsRequest) \nReference documentation and code samples for the Google Cloud Talent Solution V4 Client class ListJobsRequest.\n\nList jobs request.\n\nGenerated from protobuf message `google.cloud.talent.v4.ListJobsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Talent \\\\ V4\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the tenant under which the job is created.\n\nThe format is \"projects/{project_id}/tenants/{tenant_id}\". For example,\n\"projects/foo/tenants/bar\".\n\n### setParent\n\nRequired. The resource name of the tenant under which the job is created.\n\nThe format is \"projects/{project_id}/tenants/{tenant_id}\". For example,\n\"projects/foo/tenants/bar\".\n\n### getFilter\n\nRequired. The filter string specifies the jobs to be enumerated.\n\nSupported operator: =, AND\nThe fields eligible for filtering are:\n\n- `companyName`\n- `requisitionId`\n- `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. At least one of `companyName` and `requisitionId` must present or an INVALID_ARGUMENT error is thrown. Sample Query:\n- companyName = \"projects/foo/tenants/bar/companies/baz\"\n- companyName = \"projects/foo/tenants/bar/companies/baz\" AND requisitionId = \"req-1\"\n- companyName = \"projects/foo/tenants/bar/companies/baz\" AND status = \"EXPIRED\"\n- requisitionId = \"req-1\"\n- requisitionId = \"req-1\" AND status = \"EXPIRED\"\n\n### setFilter\n\nRequired. The filter string specifies the jobs to be enumerated.\n\nSupported operator: =, AND\nThe fields eligible for filtering are:\n\n- `companyName`\n- `requisitionId`\n- `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. At least one of `companyName` and `requisitionId` must present or an INVALID_ARGUMENT error is thrown. Sample Query:\n- companyName = \"projects/foo/tenants/bar/companies/baz\"\n- companyName = \"projects/foo/tenants/bar/companies/baz\" AND requisitionId = \"req-1\"\n- companyName = \"projects/foo/tenants/bar/companies/baz\" AND status = \"EXPIRED\"\n- requisitionId = \"req-1\"\n- requisitionId = \"req-1\" AND status = \"EXPIRED\"\n\n### getPageToken\n\nThe starting point of a query result.\n\n### setPageToken\n\nThe starting point of a query result.\n\n### getPageSize\n\nThe maximum number of jobs to be returned per page of results.\n\nIf [job_view](/php/docs/reference/cloud-talent/latest/V4.ListJobsRequest#_Google_Cloud_Talent_V4_ListJobsRequest__getJobView__) is set to\n[JobView.JOB_VIEW_ID_ONLY](/php/docs/reference/cloud-talent/latest/V4.JobView#_Google_Cloud_Talent_V4_JobView__JOB_VIEW_ID_ONLY),\nthe maximum allowed page size is 1000. Otherwise, the maximum allowed page\nsize is 100.\nDefault is 100 if empty or a number \\\u003c 1 is specified.\n\n### setPageSize\n\nThe maximum number of jobs to be returned per page of results.\n\nIf [job_view](/php/docs/reference/cloud-talent/latest/V4.ListJobsRequest#_Google_Cloud_Talent_V4_ListJobsRequest__getJobView__) is set to\n[JobView.JOB_VIEW_ID_ONLY](/php/docs/reference/cloud-talent/latest/V4.JobView#_Google_Cloud_Talent_V4_JobView__JOB_VIEW_ID_ONLY),\nthe maximum allowed page size is 1000. Otherwise, the maximum allowed page\nsize is 100.\nDefault is 100 if empty or a number \\\u003c 1 is specified.\n\n### getJobView\n\nThe desired job attributes returned for jobs in the\nsearch response. Defaults to\n[JobView.JOB_VIEW_FULL](/php/docs/reference/cloud-talent/latest/V4.JobView#_Google_Cloud_Talent_V4_JobView__JOB_VIEW_FULL) if no\nvalue is specified.\n\n### setJobView\n\nThe desired job attributes returned for jobs in the\nsearch response. Defaults to\n[JobView.JOB_VIEW_FULL](/php/docs/reference/cloud-talent/latest/V4.JobView#_Google_Cloud_Talent_V4_JobView__JOB_VIEW_FULL) if no\nvalue is specified.\n\n### static::build"]]