Google Cloud Talent Solution V4beta1 Client - Class CompensationEntry (1.3.3)

Reference documentation and code samples for the Google Cloud Talent Solution V4beta1 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.v4beta1.CompensationInfo.CompensationEntry

Namespace

Google \ Cloud \ Talent \ V4beta1 \ CompensationInfo

Methods

__construct

Constructor.

Parameters
Name Description
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\V4beta1\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
Type Description
int

setType

Compensation type.

Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.

Parameter
Name Description
var int
Returns
Type Description
$this

getUnit

Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Returns
Type Description
int

setUnit

Frequency of the specified amount.

Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Parameter
Name Description
var int
Returns
Type Description
$this

getAmount

Compensation amount.

Returns
Type Description
Google\Type\Money|null

hasAmount

setAmount

Compensation amount.

Parameter
Name Description
var Google\Type\Money
Returns
Type Description
$this

getRange

Compensation range.

Returns
Type Description
Google\Cloud\Talent\V4beta1\CompensationInfo\CompensationRange|null

hasRange

setRange

Compensation range.

Parameter
Name Description
var Google\Cloud\Talent\V4beta1\CompensationInfo\CompensationRange
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Type Description
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
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$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
Name Description
var float|null
Returns
Type Description
$this

getCompensationAmount

Returns
Type Description
string