Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 Client class ListCompaniesRequest.
List companies for which the client has ACL visibility.
Generated from protobuf message google.cloud.talent.v4beta1.ListCompaniesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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/tenant/bar". If tenant id is unspecified, the default tenant will be used, for example, "projects/foo". |
↳ 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/tenant/bar". If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".
| Returns | |
|---|---|
| Type | Description |
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/tenant/bar". If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The starting indicator from which to return results.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The starting indicator from which to return results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of companies to be returned, at most 100.
Default is 100 if a non-positive number is provided.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of companies to be returned, at most 100.
Default is 100 if a non-positive number is provided.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |