Google Cloud Talent Solution V4 Client - Class ListJobsRequest (2.0.2)

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"
  • 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"
  • 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

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
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.

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"
Returns
Type Description
ListJobsRequest