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:

SdkPojo, 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 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetGatewayResponsesRequest.Builder>	serializableBuilderClass()
GetGatewayResponsesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

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

restApiId

public final String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

position

public final 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 final Integer limit()

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

Returns:

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

toBuilder

public GetGatewayResponsesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetGatewayResponsesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo