Interface GetTimeOffResponse.Builder

  • Method Details

    • timeOffId

      GetTimeOffResponse.Builder timeOffId(String timeOffId)

      The identifier of the time off request.

      Parameters:
      timeOffId - The identifier of the time off request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • userId

      The identifier of the user the time off is for.

      Parameters:
      userId - The identifier of the user the time off is for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • shiftActivityId

      GetTimeOffResponse.Builder shiftActivityId(String shiftActivityId)

      The identifier of the shift activity for the time off request.

      Parameters:
      shiftActivityId - The identifier of the shift activity for the time off request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startAt

      The start of the time off window, inclusive, as sent to CreateTimeOff.

      Parameters:
      startAt - The start of the time off window, inclusive, as sent to CreateTimeOff.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endAt

      The end of the time off window, exclusive, as sent to CreateTimeOff.

      Parameters:
      endAt - The end of the time off window, exclusive, as sent to CreateTimeOff.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the time off request.

      • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

      • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

      Parameters:
      status - The status of the time off request.

      • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

      • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the time off request.

      • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

      • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

      Parameters:
      status - The status of the time off request.

      • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

      • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • description

      GetTimeOffResponse.Builder description(String description)

      The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.

      Parameters:
      description - The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • validationResults

      GetTimeOffResponse.Builder validationResults(Collection<TimeOffValidationResult> validationResults)

      Warnings or failures produced while processing the time off request.

      Parameters:
      validationResults - Warnings or failures produced while processing the time off request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • validationResults

      GetTimeOffResponse.Builder validationResults(TimeOffValidationResult... validationResults)

      Warnings or failures produced while processing the time off request.

      Parameters:
      validationResults - Warnings or failures produced while processing the time off request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • validationResults

      GetTimeOffResponse.Builder validationResults(Consumer<TimeOffValidationResult.Builder>... validationResults)

      Warnings or failures produced while processing the time off request.

      This is a convenience method that creates an instance of the TimeOffValidationResult.Builder avoiding the need to create one manually via TimeOffValidationResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationResults(List<TimeOffValidationResult>).

      Parameters:
      validationResults - a consumer that will call methods on TimeOffValidationResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdBy

      GetTimeOffResponse.Builder createdBy(ActorInfo createdBy)

      The identity that created the request. Immutable for the life of the request.

      Parameters:
      createdBy - The identity that created the request. Immutable for the life of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdBy

      default GetTimeOffResponse.Builder createdBy(Consumer<ActorInfo.Builder> createdBy)

      The identity that created the request. Immutable for the life of the request.

      This is a convenience method that creates an instance of the ActorInfo.Builder avoiding the need to create one manually via ActorInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdBy(ActorInfo).

      Parameters:
      createdBy - a consumer that will call methods on ActorInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdAt

      GetTimeOffResponse.Builder createdAt(Instant createdAt)

      The timestamp when the time off request was created.

      Parameters:
      createdAt - The timestamp when the time off request was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedBy

      GetTimeOffResponse.Builder updatedBy(ActorInfo updatedBy)

      The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.

      Parameters:
      updatedBy - The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedBy

      default GetTimeOffResponse.Builder updatedBy(Consumer<ActorInfo.Builder> updatedBy)

      The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.

      This is a convenience method that creates an instance of the ActorInfo.Builder avoiding the need to create one manually via ActorInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updatedBy(ActorInfo).

      Parameters:
      updatedBy - a consumer that will call methods on ActorInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • updatedAt

      GetTimeOffResponse.Builder updatedAt(Instant updatedAt)

      The timestamp when the time off request was last modified.

      Parameters:
      updatedAt - The timestamp when the time off request was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.