software.amazon.awssdk.services.apigateway.model

Class GetGatewayResponsesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest

All Implemented Interfaces:

ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetGatewayResponsesRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetGatewayResponsesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetGatewayResponsesRequest.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()
Integer	limit() The maximum number of returned results per page.
String	position() The current pagination position in the paged result set.
String	restApiId() The string identifier of the associated RestApi.
static Class<? extends GetGatewayResponsesRequest.Builder>	serializableBuilderClass()
GetGatewayResponsesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

position

public String position()

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

Returns:

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

limit

public Integer limit()

The maximum number of returned results per page. The GatewayResponses collection does not support pagination and the limit does not apply here.

Returns:

The maximum number of returned results per page. The GatewayResponses collection does not support pagination and the limit does not apply here.

toBuilder

public GetGatewayResponsesRequest.Builder 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 interface ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static GetGatewayResponsesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetGatewayResponsesRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

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