Class GetTimeOffResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTimeOffResponse.Builder,GetTimeOffResponse>

@Generated("software.amazon.awssdk:codegen") public final class GetTimeOffResponse extends ConnectSchedulingResponse implements ToCopyableBuilder<GetTimeOffResponse.Builder,GetTimeOffResponse>

The response for GetTimeOff.

  • Method Details

    • timeOffId

      public final String timeOffId()

      The identifier of the time off request.

      Returns:
      The identifier of the time off request.
    • userId

      public final String userId()

      The identifier of the user the time off is for.

      Returns:
      The identifier of the user the time off is for.
    • shiftActivityId

      public final String 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

      public final Instant 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

      public final Instant 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

      public final TimeOffStatus 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.

      If the service returns an enum value that is not available in the current SDK version, status will return TimeOffStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 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.

      See Also:
    • statusAsString

      public final String 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 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.

      If the service returns an enum value that is not available in the current SDK version, status will return TimeOffStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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 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.

      See Also:
    • description

      public final 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.

      Returns:
      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.
    • 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 the isEmpty() 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

      public final List<TimeOffValidationResult> 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

      public final ActorInfo 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

      public final Instant createdAt()

      The timestamp when the time off request was created.

      Returns:
      The timestamp when the time off request was created.
    • updatedBy

      public final 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.

      Returns:
      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.
    • updatedAt

      public final Instant updatedAt()

      The timestamp when the time off request was last modified.

      Returns:
      The timestamp when the time off request was last modified.
    • toBuilder

      public GetTimeOffResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetTimeOffResponse.Builder,GetTimeOffResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static GetTimeOffResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends GetTimeOffResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.