Interface GetTimeOffResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,Buildable,ConnectSchedulingResponse.Builder,CopyableBuilder<GetTimeOffResponse.Builder,,GetTimeOffResponse> SdkBuilder<GetTimeOffResponse.Builder,,GetTimeOffResponse> SdkPojo,SdkResponse.Builder
- Enclosing class:
GetTimeOffResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe timestamp when the time off request was created.default GetTimeOffResponse.BuildercreatedBy(Consumer<ActorInfo.Builder> createdBy) The identity that created the request.The identity that created the request.description(String description) The description of the time off request.The end of the time off window, exclusive, as sent toCreateTimeOff.shiftActivityId(String shiftActivityId) The identifier of the shift activity for the time off request.The start of the time off window, inclusive, as sent toCreateTimeOff.The status of the time off request.status(TimeOffStatus status) The status of the time off request.The identifier of the time off request.The timestamp when the time off request was last modified.default GetTimeOffResponse.BuilderupdatedBy(Consumer<ActorInfo.Builder> updatedBy) The identity that made the most recentApproveTimeOff,RejectTimeOff, orCancelTimeOffcall on the request, or took the same action in the Connect Customer admin website.The identity that made the most recentApproveTimeOff,RejectTimeOff, orCancelTimeOffcall on the request, or took the same action in the Connect Customer admin website.The identifier of the user the time off is for.validationResults(Collection<TimeOffValidationResult> validationResults) Warnings or failures produced while processing the time off request.validationResults(Consumer<TimeOffValidationResult.Builder>... validationResults) Warnings or failures produced while processing the time off request.validationResults(TimeOffValidationResult... validationResults) Warnings or failures produced while processing the time off request.Methods inherited from interface software.amazon.awssdk.services.connectscheduling.model.ConnectSchedulingResponse.Builder
build, responseMetadata, responseMetadataMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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 toCreateTimeOff.- 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 toCreateTimeOff.- 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 requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
- 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 requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
-
- 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 requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
- 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 requestPENDING, so anAPPROVEDrequest can becomePENDINGand then endAPPROVEDorREJECTED. -
AWAITING_APPROVAL: the request is waiting for anApproveTimeOfforRejectTimeOffcall.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
description
The description of the time off request.
CreateTimeOffsets it, andCancelTimeOffreplaces or removes it. An edit in the Connect Customer admin website can also change it.GetTimeOffdoesn't return descriptions sent withApproveTimeOfforRejectTimeOff.- Parameters:
description- The description of the time off request.CreateTimeOffsets it, andCancelTimeOffreplaces or removes it. An edit in the Connect Customer admin website can also change it.GetTimeOffdoesn't return descriptions sent withApproveTimeOfforRejectTimeOff.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 theTimeOffValidationResult.Builderavoiding the need to create one manually viaTimeOffValidationResult.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovalidationResults(List<TimeOffValidationResult>).- Parameters:
validationResults- a consumer that will call methods onTimeOffValidationResult.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The identity that created the request. Immutable for the life of the request.
This is a convenience method that creates an instance of theActorInfo.Builderavoiding the need to create one manually viaActorInfo.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocreatedBy(ActorInfo).- Parameters:
createdBy- a consumer that will call methods onActorInfo.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The identity that made the most recent
ApproveTimeOff,RejectTimeOff, orCancelTimeOffcall 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 anAUTOMATICrequest.UpdatedAtalso changes when aPENDINGrequest changes to another status and for other edits, which don't setUpdatedBy.- Parameters:
updatedBy- The identity that made the most recentApproveTimeOff,RejectTimeOff, orCancelTimeOffcall 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 anAUTOMATICrequest.UpdatedAtalso changes when aPENDINGrequest changes to another status and for other edits, which don't setUpdatedBy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedBy
The identity that made the most recent
This is a convenience method that creates an instance of theApproveTimeOff,RejectTimeOff, orCancelTimeOffcall 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 anAUTOMATICrequest.UpdatedAtalso changes when aPENDINGrequest changes to another status and for other edits, which don't setUpdatedBy.ActorInfo.Builderavoiding the need to create one manually viaActorInfo.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toupdatedBy(ActorInfo).- Parameters:
updatedBy- a consumer that will call methods onActorInfo.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-