software.amazon.awssdk.services.apigateway.model

Class ImportDocumentationPartsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.APIGatewayResponse

software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsResponse

All Implemented Interfaces:

ToCopyableBuilder<ImportDocumentationPartsResponse.Builder,ImportDocumentationPartsResponse>

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

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway

Documenting an API, documentationpart:import, DocumentationPart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportDocumentationPartsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ImportDocumentationPartsResponse.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 SdkResponse.
int	hashCode()
List<String>	ids() A list of the returned documentation part identifiers.
static Class<? extends ImportDocumentationPartsResponse.Builder>	serializableBuilderClass()
ImportDocumentationPartsResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<String>	warnings() A list of warning messages reported during import of documentation parts.

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

ids

public List<String> ids()

A list of the returned documentation part identifiers.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of the returned documentation part identifiers.

warnings

public List<String> warnings()

A list of warning messages reported during import of documentation parts.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of warning messages reported during import of documentation parts.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ImportDocumentationPartsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ImportDocumentationPartsResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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