GoogleApi.Jobs.V2.Model.CompensationEntry (google_api_jobs v0.16.2) View Source

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

  • it contains valid amount or range.
  • and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.

Attributes

  • amount (type: GoogleApi.Jobs.V2.Model.Money.t, default: nil) - Optional. Compensation amount.

  • description (type: String.t, default: nil) - Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.

  • expectedUnitsPerYear (type: float(), default: nil) - Optional. 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
  • range (type: GoogleApi.Jobs.V2.Model.CompensationRange.t, default: nil) - Optional. Compensation range.

  • type (type: String.t, default: nil) - Required. Compensation type.

  • unit (type: String.t, default: nil) - Optional. Frequency of the specified amount.

    Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Jobs.V2.Model.CompensationEntry{
  amount: GoogleApi.Jobs.V2.Model.Money.t(),
  description: String.t(),
  expectedUnitsPerYear: float(),
  range: GoogleApi.Jobs.V2.Model.CompensationRange.t(),
  type: String.t(),
  unit: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.