Class: Google::Apis::JobsV4::CompensationEntry

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v4/classes.rb,
generated/google/apis/jobs_v4/representations.rb,
generated/google/apis/jobs_v4/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

Constructor Details

#initialize(**args) ⇒ CompensationEntry

Returns a new instance of CompensationEntry.



576
577
578
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 576

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

Instance Attribute Details

#amount ⇒ Google::Apis::JobsV4::Money

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

Returns:



544
545
546
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 544

def amount
  @amount
end

#description ⇒ String

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

Returns:

  • (String) 


550
551
552
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 550

def description
  @description
end

#expected_units_per_year ⇒ Float

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) 


558
559
560
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 558

def expected_units_per_year
  @expected_units_per_year
end

#range ⇒ Google::Apis::JobsV4::CompensationRange

Compensation range. Corresponds to the JSON property range

Returns:



563
564
565
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 563

def range
  @range
end

#type ⇒ String

Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED. Corresponds to the JSON property type

Returns:

  • (String) 


568
569
570
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 568

def type
  @type
end

#unit ⇒ String

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

Returns:

  • (String) 


574
575
576
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 574

def unit
  @unit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



581
582
583
584
585
586
587
588
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 581

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