All Implemented Interfaces:


public final class EmploymentData.Builder

A builder for EmploymentData.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final EmploymentData.Builder`	`id(String id)`	A stable Finch `id` (UUID v4) for an individual in the company.
`final EmploymentData.Builder`	`id(JsonField<String> id)`	Sets Builder.id to an arbitrary JSON value.
`final EmploymentData.Builder`	`classCode(String classCode)`	Worker's compensation classification code for this employee
`final EmploymentData.Builder`	`classCode(Optional<String> classCode)`	Alias for calling Builder.classCode with `classCode.orElse(null)`.
`final EmploymentData.Builder`	`classCode(JsonField<String> classCode)`	Sets Builder.classCode to an arbitrary JSON value.
`final EmploymentData.Builder`	`customFields(List<EmploymentData.CustomField> customFields)`	Custom fields for the individual.
`final EmploymentData.Builder`	`customFields(Optional<List<EmploymentData.CustomField>> customFields)`	Alias for calling Builder.customFields with `customFields.orElse(null)`.
`final EmploymentData.Builder`	`customFields(JsonField<List<EmploymentData.CustomField>> customFields)`	Sets Builder.customFields to an arbitrary JSON value.
`final EmploymentData.Builder`	`addCustomField(EmploymentData.CustomField customField)`	Adds a single CustomField to customFields.
`final EmploymentData.Builder`	`department(EmploymentData.Department department)`	The department object.
`final EmploymentData.Builder`	`department(Optional<EmploymentData.Department> department)`	Alias for calling Builder.department with `department.orElse(null)`.
`final EmploymentData.Builder`	`department(JsonField<EmploymentData.Department> department)`	Sets Builder.department to an arbitrary JSON value.
`final EmploymentData.Builder`	`employment(EmploymentData.Employment employment)`	The employment object.
`final EmploymentData.Builder`	`employment(Optional<EmploymentData.Employment> employment)`	Alias for calling Builder.employment with `employment.orElse(null)`.
`final EmploymentData.Builder`	`employment(JsonField<EmploymentData.Employment> employment)`	Sets Builder.employment to an arbitrary JSON value.
`final EmploymentData.Builder`	`employmentStatus(EmploymentData.EmploymentStatus employmentStatus)`	The detailed employment status of the individual.
`final EmploymentData.Builder`	`employmentStatus(Optional<EmploymentData.EmploymentStatus> employmentStatus)`	Alias for calling Builder.employmentStatus with `employmentStatus.orElse(null)`.
`final EmploymentData.Builder`	`employmentStatus(JsonField<EmploymentData.EmploymentStatus> employmentStatus)`	Sets Builder.employmentStatus to an arbitrary JSON value.
`final EmploymentData.Builder`	`endDate(String endDate)`
`final EmploymentData.Builder`	`endDate(Optional<String> endDate)`	Alias for calling Builder.endDate with `endDate.orElse(null)`.
`final EmploymentData.Builder`	`endDate(JsonField<String> endDate)`	Sets Builder.endDate to an arbitrary JSON value.
`final EmploymentData.Builder`	`firstName(String firstName)`	The legal first name of the individual.
`final EmploymentData.Builder`	`firstName(Optional<String> firstName)`	Alias for calling Builder.firstName with `firstName.orElse(null)`.
`final EmploymentData.Builder`	`firstName(JsonField<String> firstName)`	Sets Builder.firstName to an arbitrary JSON value.
`final EmploymentData.Builder`	`income(Income income)`	The employee's income as reported by the provider.
`final EmploymentData.Builder`	`income(Optional<Income> income)`	Alias for calling Builder.income with `income.orElse(null)`.
`final EmploymentData.Builder`	`income(JsonField<Income> income)`	Sets Builder.income to an arbitrary JSON value.
`final EmploymentData.Builder`	`incomeHistory(List<Income> incomeHistory)`	The array of income history.
`final EmploymentData.Builder`	`incomeHistory(Optional<List<Income>> incomeHistory)`	Alias for calling Builder.incomeHistory with `incomeHistory.orElse(null)`.
`final EmploymentData.Builder`	`incomeHistory(JsonField<List<Income>> incomeHistory)`	Sets Builder.incomeHistory to an arbitrary JSON value.
`final EmploymentData.Builder`	`addIncomeHistory(Income incomeHistory)`	Adds a single Income to Builder.incomeHistory.
`final EmploymentData.Builder`	`isActive(Boolean isActive)`	`true` if the individual an an active employee or contractor at the company.
`final EmploymentData.Builder`	`isActive(Boolean isActive)`	Alias for Builder.isActive.
`final EmploymentData.Builder`	`isActive(Optional<Boolean> isActive)`	Alias for calling Builder.isActive with `isActive.orElse(null)`.
`final EmploymentData.Builder`	`isActive(JsonField<Boolean> isActive)`	Sets Builder.isActive to an arbitrary JSON value.
`final EmploymentData.Builder`	`lastName(String lastName)`	The legal last name of the individual.
`final EmploymentData.Builder`	`lastName(Optional<String> lastName)`	Alias for calling Builder.lastName with `lastName.orElse(null)`.
`final EmploymentData.Builder`	`lastName(JsonField<String> lastName)`	Sets Builder.lastName to an arbitrary JSON value.
`final EmploymentData.Builder`	`latestRehireDate(String latestRehireDate)`
`final EmploymentData.Builder`	`latestRehireDate(Optional<String> latestRehireDate)`	Alias for calling Builder.latestRehireDate with `latestRehireDate.orElse(null)`.
`final EmploymentData.Builder`	`latestRehireDate(JsonField<String> latestRehireDate)`	Sets Builder.latestRehireDate to an arbitrary JSON value.
`final EmploymentData.Builder`	`location(Location location)`
`final EmploymentData.Builder`	`location(Optional<Location> location)`	Alias for calling Builder.location with `location.orElse(null)`.
`final EmploymentData.Builder`	`location(JsonField<Location> location)`	Sets Builder.location to an arbitrary JSON value.
`final EmploymentData.Builder`	`manager(EmploymentData.Manager manager)`	The manager object representing the manager of the individual within the org.
`final EmploymentData.Builder`	`manager(Optional<EmploymentData.Manager> manager)`	Alias for calling Builder.manager with `manager.orElse(null)`.
`final EmploymentData.Builder`	`manager(JsonField<EmploymentData.Manager> manager)`	Sets Builder.manager to an arbitrary JSON value.
`final EmploymentData.Builder`	`middleName(String middleName)`	The legal middle name of the individual.
`final EmploymentData.Builder`	`middleName(Optional<String> middleName)`	Alias for calling Builder.middleName with `middleName.orElse(null)`.
`final EmploymentData.Builder`	`middleName(JsonField<String> middleName)`	Sets Builder.middleName to an arbitrary JSON value.
`final EmploymentData.Builder`	`sourceId(String sourceId)`	The source system's unique employment identifier for this individual
`final EmploymentData.Builder`	`sourceId(Optional<String> sourceId)`	Alias for calling Builder.sourceId with `sourceId.orElse(null)`.
`final EmploymentData.Builder`	`sourceId(JsonField<String> sourceId)`	Sets Builder.sourceId to an arbitrary JSON value.
`final EmploymentData.Builder`	`startDate(String startDate)`
`final EmploymentData.Builder`	`startDate(Optional<String> startDate)`	Alias for calling Builder.startDate with `startDate.orElse(null)`.
`final EmploymentData.Builder`	`startDate(JsonField<String> startDate)`	Sets Builder.startDate to an arbitrary JSON value.
`final EmploymentData.Builder`	`title(String title)`	The current title of the individual.
`final EmploymentData.Builder`	`title(Optional<String> title)`	Alias for calling Builder.title with `title.orElse(null)`.
`final EmploymentData.Builder`	`title(JsonField<String> title)`	Sets Builder.title to an arbitrary JSON value.
`final EmploymentData.Builder`	`workId(String workId)`	This field is deprecated in favour of `source_id`
`final EmploymentData.Builder`	`workId(Optional<String> workId)`	Alias for calling Builder.workId with `workId.orElse(null)`.
`final EmploymentData.Builder`	`workId(JsonField<String> workId)`	Sets Builder.workId to an arbitrary JSON value.
`final EmploymentData.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final EmploymentData.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final EmploymentData.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final EmploymentData.Builder`	`removeAdditionalProperty(String key)`
`final EmploymentData.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final EmploymentData`	`build()`	Returns an immutable instance of EmploymentData.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final EmploymentData.Builder id(String id)
```
    A stable Finch id (UUID v4) for an individual in the company.
  - id
```
 final EmploymentData.Builder id(JsonField<String> id)
```
    Sets Builder.id to an arbitrary JSON value.
    You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - classCode
```
 final EmploymentData.Builder classCode(String classCode)
```
    Worker's compensation classification code for this employee
  - classCode
```
 final EmploymentData.Builder classCode(Optional<String> classCode)
```
    Alias for calling Builder.classCode with classCode.orElse(null).
  - classCode
```
 final EmploymentData.Builder classCode(JsonField<String> classCode)
```
    Sets Builder.classCode to an arbitrary JSON value.
    You should usually call Builder.classCode with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - customFields
```
 final EmploymentData.Builder customFields(List<EmploymentData.CustomField> customFields)
```
    Custom fields for the individual. These are fields which are defined by the employer in the system.
  - customFields
```
 final EmploymentData.Builder customFields(Optional<List<EmploymentData.CustomField>> customFields)
```
    Alias for calling Builder.customFields with customFields.orElse(null).
  - customFields
```
 final EmploymentData.Builder customFields(JsonField<List<EmploymentData.CustomField>> customFields)
```
    Sets Builder.customFields to an arbitrary JSON value.
    You should usually call Builder.customFields with a well-typed List<CustomField> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addCustomField
```
 final EmploymentData.Builder addCustomField(EmploymentData.CustomField customField)
```
    Adds a single CustomField to customFields.
  - department
```
 final EmploymentData.Builder department(EmploymentData.Department department)
```
    The department object.
  - department
```
 final EmploymentData.Builder department(Optional<EmploymentData.Department> department)
```
    Alias for calling Builder.department with department.orElse(null).
  - department
```
 final EmploymentData.Builder department(JsonField<EmploymentData.Department> department)
```
    Sets Builder.department to an arbitrary JSON value.
    You should usually call Builder.department with a well-typed Department value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - employment
```
 final EmploymentData.Builder employment(EmploymentData.Employment employment)
```
    The employment object.
  - employment
```
 final EmploymentData.Builder employment(Optional<EmploymentData.Employment> employment)
```
    Alias for calling Builder.employment with employment.orElse(null).
  - employment
```
 final EmploymentData.Builder employment(JsonField<EmploymentData.Employment> employment)
```
    Sets Builder.employment to an arbitrary JSON value.
    You should usually call Builder.employment with a well-typed Employment value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - employmentStatus
```
 final EmploymentData.Builder employmentStatus(EmploymentData.EmploymentStatus employmentStatus)
```
    The detailed employment status of the individual. Available options: active, deceased, leave, onboarding, prehire, retired, terminated.
  - employmentStatus
```
 final EmploymentData.Builder employmentStatus(Optional<EmploymentData.EmploymentStatus> employmentStatus)
```
    Alias for calling Builder.employmentStatus with employmentStatus.orElse(null).
  - employmentStatus
```
 final EmploymentData.Builder employmentStatus(JsonField<EmploymentData.EmploymentStatus> employmentStatus)
```
    Sets Builder.employmentStatus to an arbitrary JSON value.
    You should usually call Builder.employmentStatus with a well-typed EmploymentStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - endDate
```
 final EmploymentData.Builder endDate(String endDate)
```
  - endDate
```
 final EmploymentData.Builder endDate(Optional<String> endDate)
```
    Alias for calling Builder.endDate with endDate.orElse(null).
  - endDate
```
 final EmploymentData.Builder endDate(JsonField<String> endDate)
```
    Sets Builder.endDate to an arbitrary JSON value.
    You should usually call Builder.endDate with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - firstName
```
 final EmploymentData.Builder firstName(String firstName)
```
    The legal first name of the individual.
  - firstName
```
 final EmploymentData.Builder firstName(Optional<String> firstName)
```
    Alias for calling Builder.firstName with firstName.orElse(null).
  - firstName
```
 final EmploymentData.Builder firstName(JsonField<String> firstName)
```
    Sets Builder.firstName to an arbitrary JSON value.
    You should usually call Builder.firstName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - income
```
 final EmploymentData.Builder income(Income income)
```
    The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
  - income
```
 final EmploymentData.Builder income(Optional<Income> income)
```
    Alias for calling Builder.income with income.orElse(null).
  - income
```
 final EmploymentData.Builder income(JsonField<Income> income)
```
    Sets Builder.income to an arbitrary JSON value.
    You should usually call Builder.income with a well-typed Income value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - incomeHistory
```
 final EmploymentData.Builder incomeHistory(List<Income> incomeHistory)
```
    The array of income history.
  - incomeHistory
```
 final EmploymentData.Builder incomeHistory(Optional<List<Income>> incomeHistory)
```
    Alias for calling Builder.incomeHistory with incomeHistory.orElse(null).
  - incomeHistory
```
 final EmploymentData.Builder incomeHistory(JsonField<List<Income>> incomeHistory)
```
    Sets Builder.incomeHistory to an arbitrary JSON value.
    You should usually call Builder.incomeHistory with a well-typed List<Income?> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addIncomeHistory
```
 final EmploymentData.Builder addIncomeHistory(Income incomeHistory)
```
    Adds a single Income to Builder.incomeHistory.
  - isActive
```
 final EmploymentData.Builder isActive(Boolean isActive)
```
    true if the individual an an active employee or contractor at the company.
  - isActive
```
 final EmploymentData.Builder isActive(Boolean isActive)
```
    Alias for Builder.isActive.
    This unboxed primitive overload exists for backwards compatibility.
  - isActive
```
 final EmploymentData.Builder isActive(Optional<Boolean> isActive)
```
    Alias for calling Builder.isActive with isActive.orElse(null).
  - isActive
```
 final EmploymentData.Builder isActive(JsonField<Boolean> isActive)
```
    Sets Builder.isActive to an arbitrary JSON value.
    You should usually call Builder.isActive with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - lastName
```
 final EmploymentData.Builder lastName(String lastName)
```
    The legal last name of the individual.
  - lastName
```
 final EmploymentData.Builder lastName(Optional<String> lastName)
```
    Alias for calling Builder.lastName with lastName.orElse(null).
  - lastName
```
 final EmploymentData.Builder lastName(JsonField<String> lastName)
```
    Sets Builder.lastName to an arbitrary JSON value.
    You should usually call Builder.lastName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - latestRehireDate
```
 final EmploymentData.Builder latestRehireDate(String latestRehireDate)
```
  - latestRehireDate
```
 final EmploymentData.Builder latestRehireDate(Optional<String> latestRehireDate)
```
    Alias for calling Builder.latestRehireDate with latestRehireDate.orElse(null).
  - latestRehireDate
```
 final EmploymentData.Builder latestRehireDate(JsonField<String> latestRehireDate)
```
    Sets Builder.latestRehireDate to an arbitrary JSON value.
    You should usually call Builder.latestRehireDate with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - location
```
 final EmploymentData.Builder location(Location location)
```
  - location
```
 final EmploymentData.Builder location(Optional<Location> location)
```
    Alias for calling Builder.location with location.orElse(null).
  - location
```
 final EmploymentData.Builder location(JsonField<Location> location)
```
    Sets Builder.location to an arbitrary JSON value.
    You should usually call Builder.location with a well-typed Location value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - manager
```
 final EmploymentData.Builder manager(EmploymentData.Manager manager)
```
    The manager object representing the manager of the individual within the org.
  - manager
```
 final EmploymentData.Builder manager(Optional<EmploymentData.Manager> manager)
```
    Alias for calling Builder.manager with manager.orElse(null).
  - manager
```
 final EmploymentData.Builder manager(JsonField<EmploymentData.Manager> manager)
```
    Sets Builder.manager to an arbitrary JSON value.
    You should usually call Builder.manager with a well-typed Manager value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - middleName
```
 final EmploymentData.Builder middleName(String middleName)
```
    The legal middle name of the individual.
  - middleName
```
 final EmploymentData.Builder middleName(Optional<String> middleName)
```
    Alias for calling Builder.middleName with middleName.orElse(null).
  - middleName
```
 final EmploymentData.Builder middleName(JsonField<String> middleName)
```
    Sets Builder.middleName to an arbitrary JSON value.
    You should usually call Builder.middleName with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - sourceId
```
 final EmploymentData.Builder sourceId(String sourceId)
```
    The source system's unique employment identifier for this individual
  - sourceId
```
 final EmploymentData.Builder sourceId(Optional<String> sourceId)
```
    Alias for calling Builder.sourceId with sourceId.orElse(null).
  - sourceId
```
 final EmploymentData.Builder sourceId(JsonField<String> sourceId)
```
    Sets Builder.sourceId to an arbitrary JSON value.
    You should usually call Builder.sourceId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - startDate
```
 final EmploymentData.Builder startDate(String startDate)
```
  - startDate
```
 final EmploymentData.Builder startDate(Optional<String> startDate)
```
    Alias for calling Builder.startDate with startDate.orElse(null).
  - startDate
```
 final EmploymentData.Builder startDate(JsonField<String> startDate)
```
    Sets Builder.startDate to an arbitrary JSON value.
    You should usually call Builder.startDate with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - title
```
 final EmploymentData.Builder title(String title)
```
    The current title of the individual.
  - title
```
 final EmploymentData.Builder title(Optional<String> title)
```
    Alias for calling Builder.title with title.orElse(null).
  - title
```
 final EmploymentData.Builder title(JsonField<String> title)
```
    Sets Builder.title to an arbitrary JSON value.
    You should usually call Builder.title with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - workId
```
@Deprecated(message = "deprecated") final EmploymentData.Builder workId(String workId)
```
    This field is deprecated in favour of source_id
  - workId
```
@Deprecated(message = "deprecated") final EmploymentData.Builder workId(Optional<String> workId)
```
    Alias for calling Builder.workId with workId.orElse(null).
  - workId
```
@Deprecated(message = "deprecated") final EmploymentData.Builder workId(JsonField<String> workId)
```
    Sets Builder.workId to an arbitrary JSON value.
    You should usually call Builder.workId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - additionalProperties
```
 final EmploymentData.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final EmploymentData.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final EmploymentData.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final EmploymentData.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final EmploymentData.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final EmploymentData build()
```
    Returns an immutable instance of EmploymentData.
    Further updates to this Builder will not mutate the returned instance.

Class EmploymentData.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

id

classCode

classCode

classCode

customFields

customFields

customFields

addCustomField

department

department

department

employment

employment

employment

employmentStatus

employmentStatus

employmentStatus

endDate

endDate

endDate

firstName

firstName

firstName

income

income

income

incomeHistory

incomeHistory

incomeHistory

addIncomeHistory

isActive

isActive

isActive

isActive

lastName

lastName

lastName

latestRehireDate

latestRehireDate

latestRehireDate

location

location

location

manager

manager

manager

middleName

middleName

middleName

sourceId

sourceId

sourceId

startDate

startDate

startDate

title

title

title

workId

workId

workId

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build