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:

SdkPojo, ToCopyableBuilder<ImportDocumentationPartsResponse.Builder,ImportDocumentationPartsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final 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., OpenAPI) file are imported into 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIds() Returns true if the Ids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasWarnings() Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	ids() A list of the returned documentation part identifiers.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportDocumentationPartsResponse.Builder>	serializableBuilderClass()
ImportDocumentationPartsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	warnings() A list of warning messages reported during import of documentation parts.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

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

sdkHttpResponse

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

hasIds

public final boolean hasIds()

Returns true if the Ids property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ids

public final 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.

You can use hasIds() to see if a value was sent in this field.

Returns:

A list of the returned documentation part identifiers.

hasWarnings

public final boolean hasWarnings()

Returns true if the Warnings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

warnings

public final 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.

You can use hasWarnings() to see if a value was sent in this field.

Returns:

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

toBuilder

public ImportDocumentationPartsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportDocumentationPartsResponse.Builder,ImportDocumentationPartsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ImportDocumentationPartsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo