Class PutGatewayResponseResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutGatewayResponseResponse.Builder,
PutGatewayResponseResponse>
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true
) or not (false
).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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResponseParameters property.final boolean
For responses, this returns true if the service returned a value for the ResponseTemplates property.Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.Response templates of the GatewayResponse as a string-to-string map of key-value pairs.final GatewayResponseType
The response type of the associated GatewayResponse.final String
The response type of the associated GatewayResponse.static Class
<? extends PutGatewayResponseResponse.Builder> final String
The HTTP status code for this GatewayResponse.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 class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
responseType
The response type of the associated GatewayResponse.
If the service returns an enum value that is not available in the current SDK version,
responseType
will returnGatewayResponseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseTypeAsString()
.- Returns:
- The response type of the associated GatewayResponse.
- See Also:
-
responseTypeAsString
The response type of the associated GatewayResponse.
If the service returns an enum value that is not available in the current SDK version,
responseType
will returnGatewayResponseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseTypeAsString()
.- Returns:
- The response type of the associated GatewayResponse.
- See Also:
-
statusCode
The HTTP status code for this GatewayResponse.
- Returns:
- The HTTP status code for this GatewayResponse.
-
hasResponseParameters
public final boolean hasResponseParameters()For responses, this returns true if the service returned a value for the ResponseParameters 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. -
responseParameters
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
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
hasResponseParameters()
method.- Returns:
- Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
-
hasResponseTemplates
public final boolean hasResponseTemplates()For responses, this returns true if the service returned a value for the ResponseTemplates 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. -
responseTemplates
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
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
hasResponseTemplates()
method.- Returns:
- Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
-
defaultResponse
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.- Returns:
- A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true
) or not (false
). A default gateway response is one generated by API Gateway without any customization by an API developer.
-
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<PutGatewayResponseResponse.Builder,
PutGatewayResponseResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used 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:
getValueForField
in 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
-