Google Cloud Talent Solution V4 Client - Class ListCompaniesRequest (1.2.1)

Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class ListCompaniesRequest.

List companies for which the client has ACL visibility.

Generated from protobuf message google.cloud.talent.v4.ListCompaniesRequest

Namespace

Google \ Cloud \ Talent \ V4

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

↳ page_token string

The starting indicator from which to return results.

↳ page_size int

The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

↳ require_open_jobs bool

Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

getParent

Required. Resource name of the tenant under which the company is created.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Returns
TypeDescription
string

setParent

Required. Resource name of the tenant under which the company is created.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageToken

The starting indicator from which to return results.

Returns
TypeDescription
string

setPageToken

The starting indicator from which to return results.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of companies to be returned, at most 100.

Default is 100 if a non-positive number is provided.

Returns
TypeDescription
int

setPageSize

The maximum number of companies to be returned, at most 100.

Default is 100 if a non-positive number is provided.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRequireOpenJobs

Set to true if the companies requested must have open jobs.

Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

Returns
TypeDescription
bool

setRequireOpenJobs

Set to true if the companies requested must have open jobs.

Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. Resource name of the tenant under which the company is created.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". Please see Google\Cloud\Talent\V4\CompanyServiceClient::tenantName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Talent\V4\ListCompaniesRequest