Google Cloud Talent Solution V4 Client - Class CompensationEntry (1.2.2)

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

A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type.

Annualization: One compensation entry can be annualized if

Generated from protobuf message google.cloud.talent.v4.CompensationInfo.CompensationEntry

Namespace

Google \ Cloud \ Talent \ V4 \ CompensationInfo

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ type int

Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.

↳ unit int

Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

↳ amount Google\Type\Money

Compensation amount.

↳ range Google\Cloud\Talent\V4\CompensationInfo\CompensationRange

Compensation range.

↳ description string

Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

↳ expected_units_per_year Google\Protobuf\DoubleValue

Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1

getType

Compensation type.

Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.

Returns
TypeDescription
int

setType

Compensation type.

Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUnit

Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Returns
TypeDescription
int

setUnit

Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAmount

Compensation amount.

Returns
TypeDescription
Google\Type\Money|null

hasAmount

setAmount

Compensation amount.

Parameter
NameDescription
var Google\Type\Money
Returns
TypeDescription
$this

getRange

Compensation range.

Returns
TypeDescription
Google\Cloud\Talent\V4\CompensationInfo\CompensationRange|null

hasRange

setRange

Compensation range.

Parameter
NameDescription
var Google\Cloud\Talent\V4\CompensationInfo\CompensationRange
Returns
TypeDescription
$this

getDescription

Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

Returns
TypeDescription
string

setDescription

Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getExpectedUnitsPerYear

Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit.

Default values:

  • HOURLY: 2080
  • DAILY: 260
  • WEEKLY: 52
  • MONTHLY: 12
  • ANNUAL: 1
Returns
TypeDescription
Google\Protobuf\DoubleValue|null

hasExpectedUnitsPerYear

clearExpectedUnitsPerYear

getExpectedUnitsPerYearValue

Returns the unboxed value from getExpectedUnitsPerYear()

Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values:

  • HOURLY: 2080
  • DAILY: 260
  • WEEKLY: 52
  • MONTHLY: 12
  • ANNUAL: 1
Returns
TypeDescription
float|null

setExpectedUnitsPerYear

Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit.

Default values:

  • HOURLY: 2080
  • DAILY: 260
  • WEEKLY: 52
  • MONTHLY: 12
  • ANNUAL: 1
Parameter
NameDescription
var Google\Protobuf\DoubleValue
Returns
TypeDescription
$this

setExpectedUnitsPerYearValue

Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.

Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values:

  • HOURLY: 2080
  • DAILY: 260
  • WEEKLY: 52
  • MONTHLY: 12
  • ANNUAL: 1
Parameter
NameDescription
var float|null
Returns
TypeDescription
$this

getCompensationAmount

Returns
TypeDescription
string