software.amazon.awssdk.services.apigateway.model

Class PutGatewayResponseResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.PutGatewayResponseResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutGatewayResponseResponse.Builder,PutGatewayResponseResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutGatewayResponseResponse
extends ApiGatewayResponse
implements 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

Nested Classes

Modifier and Type	Class and Description
static interface	PutGatewayResponseResponse.Builder

Method Summary

Modifier and Type	Method and Description
static PutGatewayResponseResponse.Builder	builder()
Boolean	defaultResponse() A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResponseParameters() For responses, this returns true if the service returned a value for the ResponseParameters property.
boolean	hasResponseTemplates() For responses, this returns true if the service returned a value for the ResponseTemplates property.
Map<String,String>	responseParameters() Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Map<String,String>	responseTemplates() Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
GatewayResponseType	responseType() The response type of the associated GatewayResponse.
String	responseTypeAsString() The response type of the associated GatewayResponse.
List<SdkField<?>>	sdkFields()
static Class<? extends PutGatewayResponseResponse.Builder>	serializableBuilderClass()
String	statusCode() The HTTP status code for this GatewayResponse.
PutGatewayResponseResponse.Builder	toBuilder()
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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

responseType

public final GatewayResponseType 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 return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().

Returns:

The response type of the associated GatewayResponse.

See Also:

GatewayResponseType

responseTypeAsString

public final String 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 return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().

Returns:

The response type of the associated GatewayResponse.

See Also:

GatewayResponseType

statusCode

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

responseParameters

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

responseTemplates

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

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

public PutGatewayResponseResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutGatewayResponseResponse.Builder,PutGatewayResponseResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static PutGatewayResponseResponse.Builder builder()

serializableBuilderClass

public static Class<? extends PutGatewayResponseResponse.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo