Class ApproveTimeOffRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ApproveTimeOffRequest.Builder,ApproveTimeOffRequest>
The request for ApproveTimeOff.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringA description recorded with the approval.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 extendsSdkRequest.final inthashCode()final StringThe identifier of the Connect Customer instance.final RuleFailureActionControls what happens when a configured rule fails.final StringControls what happens when a configured rule fails.static Class<? extends ApproveTimeOffRequest.Builder> final StringThe unique identifier of the time off request to approve.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 StringuserId()The identifier of the user who the time off request belongs to.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceId
The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
userId
The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
- Returns:
- The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.
-
timeOffId
The unique identifier of the time off request to approve. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException.- Returns:
- The unique identifier of the time off request to approve. If the time off request doesn't belong to
UserId, the operation returnsResourceNotFoundException.
-
description
A description recorded with the approval.
GetTimeOffdoesn't return it.- Returns:
- A description recorded with the approval.
GetTimeOffdoesn't return it.
-
ruleFailureAction
Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand leaves the requestREJECTED.OVERRIDErecords aWARNINGand approves the request, like the Override time off rules option in the Connect Customer admin website.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST.If the service returns an enum value that is not available in the current SDK version,
ruleFailureActionwill returnRuleFailureAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromruleFailureActionAsString().- Returns:
- Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand leaves the requestREJECTED.OVERRIDErecords aWARNINGand approves the request, like the Override time off rules option in the Connect Customer admin website.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST. - See Also:
-
ruleFailureActionAsString
Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand leaves the requestREJECTED.OVERRIDErecords aWARNINGand approves the request, like the Override time off rules option in the Connect Customer admin website.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST.If the service returns an enum value that is not available in the current SDK version,
ruleFailureActionwill returnRuleFailureAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromruleFailureActionAsString().- Returns:
- Controls what happens when a configured rule fails.
REJECT, the default, records anERRORand leaves the requestREJECTED.OVERRIDErecords aWARNINGand approves the request, like the Override time off rules option in the Connect Customer admin website.OVERRIDEnever waivesCONFLICTING_TIME_OFF_REQUEST. - See Also:
-
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<ApproveTimeOffRequest.Builder,ApproveTimeOffRequest> - Specified by:
toBuilderin classConnectSchedulingRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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.
-