Google Cloud Talent Solution V4beta1 Client - Class Company (1.3.5)

Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 Client class Company.

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Generated from protobuf message google.cloud.talent.v4beta1.Company

Namespace

Google \ Cloud \ Talent \ V4beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".
↳ display_name string

Required. The display name of the company, for example, "Google LLC".
↳ external_id string

Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.
↳ size int

The employer's company size.
↳ headquarters_address string

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.
↳ hiring_agency bool

Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
↳ eeo_text string

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.
↳ website_uri string

The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255.
↳ career_site_uri string

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".
↳ image_uri string

A URI that hosts the employer's company logo.
↳ keyword_searchable_job_custom_attributes array

This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.
↳ derived_info Google\Cloud\Talent\V4beta1\Company\DerivedInfo

Output only. Derived details about the company.
↳ suspended bool

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

getName

Required during company update.

The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Returns
Type Description
string

setName

Required during company update.

The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used. For example, "projects/foo/companies/bar".

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The display name of the company, for example, "Google LLC".

Returns
Type Description
string

setDisplayName

Required. The display name of the company, for example, "Google LLC".

Parameter
Name Description
var string
Returns
Type Description
$this

getExternalId

Required. Client side company identifier, used to uniquely identify the company.

The maximum number of allowed characters is 255.

Returns
Type Description
string

setExternalId

Required. Client side company identifier, used to uniquely identify the company.

The maximum number of allowed characters is 255.

Parameter
Name Description
var string
Returns
Type Description
$this

getSize

The employer's company size.

Returns
Type Description
int

setSize

The employer's company size.

Parameter
Name Description
var int
Returns
Type Description
$this

getHeadquartersAddress

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

Returns
Type Description
string

setHeadquartersAddress

The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.

Parameter
Name Description
var string
Returns
Type Description
$this

getHiringAgency

Set to true if it is the hiring agency that post jobs for other employers.

Defaults to false if not provided.

Returns
Type Description
bool

setHiringAgency

Set to true if it is the hiring agency that post jobs for other employers.

Defaults to false if not provided.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEeoText

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles.

The maximum number of allowed characters is 500.

Returns
Type Description
string

setEeoText

Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles.

The maximum number of allowed characters is 500.

Parameter
Name Description
var string
Returns
Type Description
$this

getWebsiteUri

The URI representing the company's primary web site or home page, for example, "https://www.google.com".

The maximum number of allowed characters is 255.

Returns
Type Description
string

setWebsiteUri

The URI representing the company's primary web site or home page, for example, "https://www.google.com".

The maximum number of allowed characters is 255.

Parameter
Name Description
var string
Returns
Type Description
$this

getCareerSiteUri

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

Returns
Type Description
string

setCareerSiteUri

The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com".

Parameter
Name Description
var string
Returns
Type Description
$this

getImageUri

A URI that hosts the employer's company logo.

Returns
Type Description
string

setImageUri

A URI that hosts the employer's company logo.

Parameter
Name Description
var string
Returns
Type Description
$this

getKeywordSearchableJobCustomAttributes

This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward.

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setKeywordSearchableJobCustomAttributes

This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward.

A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword searches. Jobs with string_values under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDerivedInfo

Output only. Derived details about the company.

Returns
Type Description
Google\Cloud\Talent\V4beta1\Company\DerivedInfo|null

hasDerivedInfo

clearDerivedInfo

setDerivedInfo

Output only. Derived details about the company.

Parameter
Name Description
var Google\Cloud\Talent\V4beta1\Company\DerivedInfo
Returns
Type Description
$this

getSuspended

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

Returns
Type Description
bool

setSuspended

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.

Parameter
Name Description
var bool
Returns
Type Description
$this