Class ApiResult
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ApiResult.Builder,
ApiResult>
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
-
In the
returnControlInvocationResults
of the Retrieve request
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The action group that the API operation belongs to.final String
apiPath()
The path to the API operation.static ApiResult.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResponseBody property.final String
The HTTP method for the API operation.final Integer
http status code from API execution response (for example: 200, 400, 500).final Map
<String, ContentBody> The response body from the API operation.final ResponseState
Controls the final response state returned to end user when API/Function execution failed.final String
Controls the final response state returned to end user when API/Function execution failed.static Class
<? extends ApiResult.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
actionGroup
The action group that the API operation belongs to.
- Returns:
- The action group that the API operation belongs to.
-
apiPath
The path to the API operation.
- Returns:
- The path to the API operation.
-
httpMethod
The HTTP method for the API operation.
- Returns:
- The HTTP method for the API operation.
-
httpStatusCode
http status code from API execution response (for example: 200, 400, 500).
- Returns:
- http status code from API execution response (for example: 200, 400, 500).
-
hasResponseBody
public final boolean hasResponseBody()For responses, this returns true if the service returned a value for the ResponseBody 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. -
responseBody
The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
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
hasResponseBody()
method.- Returns:
- The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.
-
responseState
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
If the service returns an enum value that is not available in the current SDK version,
responseState
will returnResponseState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseStateAsString()
.- Returns:
- Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
- See Also:
-
responseStateAsString
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
If the service returns an enum value that is not available in the current SDK version,
responseState
will returnResponseState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseStateAsString()
.- Returns:
- Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
- See Also:
-
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 interfaceToCopyableBuilder<ApiResult.Builder,
ApiResult> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
-
sdkFields
-