Class GetTimeOffResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetTimeOffResponse.Builder,GetTimeOffResponse>
The response for GetTimeOff.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic GetTimeOffResponse.Builderbuilder()final InstantThe timestamp when the time off request was created.final ActorInfoThe identity that created the request.final StringThe description of the time off request.final InstantendAt()The end of the time off window, exclusive, as sent toCreateTimeOff.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the ValidationResults property.static Class<? extends GetTimeOffResponse.Builder> final StringThe identifier of the shift activity for the time off request.final InstantstartAt()The start of the time off window, inclusive, as sent toCreateTimeOff.final TimeOffStatusstatus()The status of the time off request.final StringThe status of the time off request.final StringThe identifier of the time off request.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InstantThe timestamp when the time off request was last modified.final ActorInfoThe identity that made the most recentApproveTimeOff,RejectTimeOff, orCancelTimeOffcall on the request, or took the same action in the Connect Customer admin website.final StringuserId()The identifier of the user the time off is for.final List<TimeOffValidationResult> Warnings or failures produced while processing the time off request.Methods inherited from class software.amazon.awssdk.services.connectscheduling.model.ConnectSchedulingResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
timeOffId
The identifier of the time off request.
- Returns:
- The identifier of the time off request.
-
userId
The identifier of the user the time off is for.
- Returns:
- The identifier of the user the time off is for.
-
shiftActivityId
The identifier of the shift activity for the time off request.
- Returns:
- The identifier of the shift activity for the time off request.
-
startAt
The start of the time off window, inclusive, as sent to
CreateTimeOff.- Returns:
- The start of the time off window, inclusive, as sent to
CreateTimeOff.
-
endAt
The end of the time off window, exclusive, as sent to
CreateTimeOff.- Returns:
- The end of the time off window, exclusive, as sent to
CreateTimeOff.
-
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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnTimeOffStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
-
-
statusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnTimeOffStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- 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.- Returns:
- 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.
-
hasValidationResults
public final boolean hasValidationResults()For responses, this returns true if the service returned a value for the ValidationResults property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
validationResults
Warnings or failures produced while processing the time off request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasValidationResults()method.- Returns:
- Warnings or failures produced while processing the time off request.
-
createdBy
The identity that created the request. Immutable for the life of the request.
- Returns:
- The identity that created the request. Immutable for the life of the request.
-
createdAt
The timestamp when the time off request was created.
- Returns:
- The timestamp when the time off request was created.
-
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.- Returns:
- 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.
-
updatedAt
The timestamp when the time off request was last modified.
- Returns:
- The timestamp when the time off request was last modified.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetTimeOffResponse.Builder,GetTimeOffResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-