Class: Google::Cloud::Talent::V4::CompensationInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/talent/v4/common.rb

Overview

Job compensation details.

Defined Under Namespace

Modules: CompensationType, CompensationUnit Classes: CompensationEntry, CompensationRange

Instance Attribute Summary collapse

Instance Attribute Details

#annualized_base_compensation_range ⇒ ::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange (readonly)

Returns Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year.

See CompensationEntry for explanation on compensation annualization.

Returns:



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 332

class CompensationInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range}.
  # - and its
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}
  # is set or can be derived. Its annualized range is determined as
  # ({::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range})
  # times
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationType]
  #     Compensation type.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationType::COMPENSATION_TYPE_UNSPECIFIED CompensationType.COMPENSATION_TYPE_UNSPECIFIED}.
  # @!attribute [rw] unit
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit]
  #     Frequency of the specified amount.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}.
  # @!attribute [rw] amount
  #   @return [::Google::Type::Money]
  #     Compensation amount.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange]
  #     Compensation range.
  # @!attribute [rw] description
  #   @return [::String]
  #     Compensation description.  For example, could
  #     indicate equity terms or provide additional context to an estimated
  #     bonus.
  # @!attribute [rw] expected_units_per_year
  #   @return [::Google::Protobuf::DoubleValue]
  #     Expected number of units paid each year. If not specified, when
  #     {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types} is
  #     FULLTIME, a default value is inferred based on
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#unit unit}.
  #     Default values:
  #     - HOURLY: 2080
  #     - DAILY: 260
  #     - WEEKLY: 52
  #     - MONTHLY: 12
  #     - ANNUAL: 1
  class CompensationEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compensation range.
  # @!attribute [rw] max_compensation
  #   @return [::Google::Type::Money]
  #     The maximum amount of compensation. If left empty, the value is set
  #     to a maximal compensation value and the currency code is set to
  #     match the {::Google::Type::Money#currency_code currency code} of
  #     min_compensation.
  # @!attribute [rw] min_compensation
  #   @return [::Google::Type::Money]
  #     The minimum amount of compensation. If left empty, the value is set
  #     to zero and the currency code is set to match the
  #     {::Google::Type::Money#currency_code currency code} of max_compensation.
  class CompensationRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of compensation.
  #
  # For compensation amounts specified in non-monetary amounts,
  # describe the compensation scheme in the
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}.
  #
  # For example, tipping format is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "expect 15-20% tips based on customer bill.") and an estimate
  # of the tips provided in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}
  # ($10 per hour).
  #
  # For example, equity is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and
  # value estimated in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}.
  # If no value estimate is possible, units are
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}
  # and then further clarified in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # field.
  module CompensationType
    # Default value.
    COMPENSATION_TYPE_UNSPECIFIED = 0

    # Base compensation: Refers to the fixed amount of money paid to an
    # employee by an employer in return for work performed. Base compensation
    # does not include benefits, bonuses or any other potential compensation
    # from an employer.
    BASE = 1

    # Bonus.
    BONUS = 2

    # Signing bonus.
    SIGNING_BONUS = 3

    # Equity.
    EQUITY = 4

    # Profit sharing.
    PROFIT_SHARING = 5

    # Commission.
    COMMISSIONS = 6

    # Tips.
    TIPS = 7

    # Other compensation type.
    OTHER_COMPENSATION_TYPE = 8
  end

  # Pay frequency.
  module CompensationUnit
    # Default value.
    COMPENSATION_UNIT_UNSPECIFIED = 0

    # Hourly.
    HOURLY = 1

    # Daily.
    DAILY = 2

    # Weekly
    WEEKLY = 3

    # Monthly.
    MONTHLY = 4

    # Yearly.
    YEARLY = 5

    # One time.
    ONE_TIME = 6

    # Other compensation units.
    OTHER_COMPENSATION_UNIT = 7
  end
end

#annualized_total_compensation_range ⇒ ::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange (readonly)

Returns Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year.

See CompensationEntry for explanation on compensation annualization.

Returns:



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 332

class CompensationInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range}.
  # - and its
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}
  # is set or can be derived. Its annualized range is determined as
  # ({::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range})
  # times
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationType]
  #     Compensation type.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationType::COMPENSATION_TYPE_UNSPECIFIED CompensationType.COMPENSATION_TYPE_UNSPECIFIED}.
  # @!attribute [rw] unit
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit]
  #     Frequency of the specified amount.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}.
  # @!attribute [rw] amount
  #   @return [::Google::Type::Money]
  #     Compensation amount.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange]
  #     Compensation range.
  # @!attribute [rw] description
  #   @return [::String]
  #     Compensation description.  For example, could
  #     indicate equity terms or provide additional context to an estimated
  #     bonus.
  # @!attribute [rw] expected_units_per_year
  #   @return [::Google::Protobuf::DoubleValue]
  #     Expected number of units paid each year. If not specified, when
  #     {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types} is
  #     FULLTIME, a default value is inferred based on
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#unit unit}.
  #     Default values:
  #     - HOURLY: 2080
  #     - DAILY: 260
  #     - WEEKLY: 52
  #     - MONTHLY: 12
  #     - ANNUAL: 1
  class CompensationEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compensation range.
  # @!attribute [rw] max_compensation
  #   @return [::Google::Type::Money]
  #     The maximum amount of compensation. If left empty, the value is set
  #     to a maximal compensation value and the currency code is set to
  #     match the {::Google::Type::Money#currency_code currency code} of
  #     min_compensation.
  # @!attribute [rw] min_compensation
  #   @return [::Google::Type::Money]
  #     The minimum amount of compensation. If left empty, the value is set
  #     to zero and the currency code is set to match the
  #     {::Google::Type::Money#currency_code currency code} of max_compensation.
  class CompensationRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of compensation.
  #
  # For compensation amounts specified in non-monetary amounts,
  # describe the compensation scheme in the
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}.
  #
  # For example, tipping format is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "expect 15-20% tips based on customer bill.") and an estimate
  # of the tips provided in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}
  # ($10 per hour).
  #
  # For example, equity is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and
  # value estimated in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}.
  # If no value estimate is possible, units are
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}
  # and then further clarified in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # field.
  module CompensationType
    # Default value.
    COMPENSATION_TYPE_UNSPECIFIED = 0

    # Base compensation: Refers to the fixed amount of money paid to an
    # employee by an employer in return for work performed. Base compensation
    # does not include benefits, bonuses or any other potential compensation
    # from an employer.
    BASE = 1

    # Bonus.
    BONUS = 2

    # Signing bonus.
    SIGNING_BONUS = 3

    # Equity.
    EQUITY = 4

    # Profit sharing.
    PROFIT_SHARING = 5

    # Commission.
    COMMISSIONS = 6

    # Tips.
    TIPS = 7

    # Other compensation type.
    OTHER_COMPENSATION_TYPE = 8
  end

  # Pay frequency.
  module CompensationUnit
    # Default value.
    COMPENSATION_UNIT_UNSPECIFIED = 0

    # Hourly.
    HOURLY = 1

    # Daily.
    DAILY = 2

    # Weekly
    WEEKLY = 3

    # Monthly.
    MONTHLY = 4

    # Yearly.
    YEARLY = 5

    # One time.
    ONE_TIME = 6

    # Other compensation units.
    OTHER_COMPENSATION_UNIT = 7
  end
end

#entries ⇒ ::Array<::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry>

Returns Job compensation information.

At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as base compensation entry for the job.

Returns:



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'proto_docs/google/cloud/talent/v4/common.rb', line 332

class CompensationInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range}.
  # - and its
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}
  # is set or can be derived. Its annualized range is determined as
  # ({::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range range})
  # times
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#expected_units_per_year expected_units_per_year}.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationType]
  #     Compensation type.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationType::COMPENSATION_TYPE_UNSPECIFIED CompensationType.COMPENSATION_TYPE_UNSPECIFIED}.
  # @!attribute [rw] unit
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit]
  #     Frequency of the specified amount.
  #
  #     Default is
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}.
  # @!attribute [rw] amount
  #   @return [::Google::Type::Money]
  #     Compensation amount.
  # @!attribute [rw] range
  #   @return [::Google::Cloud::Talent::V4::CompensationInfo::CompensationRange]
  #     Compensation range.
  # @!attribute [rw] description
  #   @return [::String]
  #     Compensation description.  For example, could
  #     indicate equity terms or provide additional context to an estimated
  #     bonus.
  # @!attribute [rw] expected_units_per_year
  #   @return [::Google::Protobuf::DoubleValue]
  #     Expected number of units paid each year. If not specified, when
  #     {::Google::Cloud::Talent::V4::Job#employment_types Job.employment_types} is
  #     FULLTIME, a default value is inferred based on
  #     {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#unit unit}.
  #     Default values:
  #     - HOURLY: 2080
  #     - DAILY: 260
  #     - WEEKLY: 52
  #     - MONTHLY: 12
  #     - ANNUAL: 1
  class CompensationEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Compensation range.
  # @!attribute [rw] max_compensation
  #   @return [::Google::Type::Money]
  #     The maximum amount of compensation. If left empty, the value is set
  #     to a maximal compensation value and the currency code is set to
  #     match the {::Google::Type::Money#currency_code currency code} of
  #     min_compensation.
  # @!attribute [rw] min_compensation
  #   @return [::Google::Type::Money]
  #     The minimum amount of compensation. If left empty, the value is set
  #     to zero and the currency code is set to match the
  #     {::Google::Type::Money#currency_code currency code} of max_compensation.
  class CompensationRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of compensation.
  #
  # For compensation amounts specified in non-monetary amounts,
  # describe the compensation scheme in the
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}.
  #
  # For example, tipping format is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "expect 15-20% tips based on customer bill.") and an estimate
  # of the tips provided in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}
  # ($10 per hour).
  #
  # For example, equity is described in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and
  # value estimated in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#amount CompensationEntry.amount}
  # or
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#range CompensationEntry.range}.
  # If no value estimate is possible, units are
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationUnit::COMPENSATION_UNIT_UNSPECIFIED CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED}
  # and then further clarified in
  # {::Google::Cloud::Talent::V4::CompensationInfo::CompensationEntry#description CompensationEntry.description}
  # field.
  module CompensationType
    # Default value.
    COMPENSATION_TYPE_UNSPECIFIED = 0

    # Base compensation: Refers to the fixed amount of money paid to an
    # employee by an employer in return for work performed. Base compensation
    # does not include benefits, bonuses or any other potential compensation
    # from an employer.
    BASE = 1

    # Bonus.
    BONUS = 2

    # Signing bonus.
    SIGNING_BONUS = 3

    # Equity.
    EQUITY = 4

    # Profit sharing.
    PROFIT_SHARING = 5

    # Commission.
    COMMISSIONS = 6

    # Tips.
    TIPS = 7

    # Other compensation type.
    OTHER_COMPENSATION_TYPE = 8
  end

  # Pay frequency.
  module CompensationUnit
    # Default value.
    COMPENSATION_UNIT_UNSPECIFIED = 0

    # Hourly.
    HOURLY = 1

    # Daily.
    DAILY = 2

    # Weekly
    WEEKLY = 3

    # Monthly.
    MONTHLY = 4

    # Yearly.
    YEARLY = 5

    # One time.
    ONE_TIME = 6

    # Other compensation units.
    OTHER_COMPENSATION_UNIT = 7
  end
end