Class: Google::Apis::JobsV3::CompensationEntry

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CompensationEntry

Returns a new instance of CompensationEntry



450
451
452
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 450

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#amount ⇒ Google::Apis::JobsV3::Money

Represents an amount of money with its currency type. Corresponds to the JSON property amount

Returns:



408
409
410
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 408

def amount
  @amount
end

#description ⇒ String

Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. Corresponds to the JSON property description

Returns:

  • (String) 


416
417
418
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 416

def description
  @description
end

#expected_units_per_year ⇒ Float

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 Corresponds to the JSON property expectedUnitsPerYear

Returns:

  • (Float) 


429
430
431
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 429

def expected_units_per_year
  @expected_units_per_year
end

#range ⇒ Google::Apis::JobsV3::CompensationRange

Compensation range. Corresponds to the JSON property range

Returns:



434
435
436
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 434

def range
  @range
end

#type ⇒ String

Optional. Compensation type. Default is CompensationUnit.OTHER_COMPENSATION_TYPE. Corresponds to the JSON property type

Returns:

  • (String) 


441
442
443
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 441

def type
  @type
end

#unit ⇒ String

Optional. Frequency of the specified amount. Default is CompensationUnit.OTHER_COMPENSATION_UNIT. Corresponds to the JSON property unit

Returns:

  • (String) 


448
449
450
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 448

def unit
  @unit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



455
456
457
458
459
460
461
462
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 455

def update!(**args)
  @amount = args[:amount] if args.key?(:amount)
  @description = args[:description] if args.key?(:description)
  @expected_units_per_year = args[:expected_units_per_year] if args.key?(:expected_units_per_year)
  @range = args[:range] if args.key?(:range)
  @type = args[:type] if args.key?(:type)
  @unit = args[:unit] if args.key?(:unit)
end