@Generated(value="software.amazon.awssdk:codegen") public class PutGatewayResponseRequest extends APIGatewayRequest implements ToCopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Modifier and Type | Class and Description |
---|---|
static interface |
PutGatewayResponseRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutGatewayResponseRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Map<String,String> |
responseParameters() |
Map<String,String> |
responseTemplates() |
GatewayResponseType |
responseType() |
String |
responseTypeString() |
String |
restApiId()
The string identifier of the associated RestApi.
|
static Class<? extends PutGatewayResponseRequest.Builder> |
serializableBuilderClass() |
String |
statusCode()
The HTTP status code of the GatewayResponse.
|
PutGatewayResponseRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String restApiId()
The string identifier of the associated RestApi.
public GatewayResponseType responseType()
The response type of the associated GatewayResponse. Valid values are
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 responseTypeString()
.
GatewayResponseType
public String responseTypeString()
The response type of the associated GatewayResponse. Valid values are
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 responseTypeString()
.
GatewayResponseType
public String statusCode()
public 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.
public 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.
public PutGatewayResponseRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
toBuilder
in class APIGatewayRequest
public static PutGatewayResponseRequest.Builder builder()
public static Class<? extends PutGatewayResponseRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.