software.amazon.awssdk.services.apigateway.model

Class GetModelRequest

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.GetModelRequest

All Implemented Interfaces:

ToCopyableBuilder<GetModelRequest.Builder,GetModelRequest>

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

Request to list information about a model in an existing RestApi resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetModelRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetModelRequest.Builder	builder()
boolean	equals(Object obj)
Boolean	flatten() A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
<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()
String	modelName() The name of the model as an identifier.
String	restApiId() The RestApi identifier under which the Model exists.
static Class<? extends GetModelRequest.Builder>	serializableBuilderClass()
GetModelRequest.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

requestOverrideConfig

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 RestApi identifier under which the Model exists.

Returns:

The RestApi identifier under which the Model exists.

modelName

public String modelName()

The name of the model as an identifier.

Returns:

The name of the model as an identifier.

flatten

public Boolean flatten()

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

Returns:

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

toBuilder

public GetModelRequest.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<GetModelRequest.Builder,GetModelRequest>

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static GetModelRequest.Builder builder()

serializableBuilderClass

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