software.amazon.awssdk.services.apigateway.model

Class CreateModelRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateModelRequest.Builder,CreateModelRequest>

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

Request to add a new Model to an existing RestApi resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateModelRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateModelRequest.Builder	builder()
String	contentType() [Required] The content-type for the model.
String	description() The description of the model.
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()
String	name() [Required] The name of the model.
String	restApiId() [Required] The RestApi identifier under which the Model will be created.
String	schema() The schema for the model.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateModelRequest.Builder>	serializableBuilderClass()
CreateModelRequest.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()

[Required] The RestApi identifier under which the Model will be created.

Returns:

[Required] The RestApi identifier under which the Model will be created.

name

public String name()

[Required] The name of the model. Must be alphanumeric.

Returns:

[Required] The name of the model. Must be alphanumeric.

description

public String description()

The description of the model.

Returns:

The description of the model.

schema

public String schema()

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

Returns:

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

contentType

public String contentType()

[Required] The content-type for the model.

Returns:

[Required] The content-type for the model.

toBuilder

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

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static CreateModelRequest.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.