software.amazon.awssdk.services.apigateway.model

Class DocumentationPart

java.lang.Object

software.amazon.awssdk.services.apigateway.model.DocumentationPart

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentationPart
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

Documenting an API, DocumentationParts

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentationPart.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentationPart.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
DocumentationPartLocation	location() The location of the API entity to which the documentation applies.
String	properties() A content map of API-specific key-value pairs describing the targeted API entity.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentationPart.Builder>	serializableBuilderClass()
DocumentationPart.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public String id()

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

Returns:

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location

public DocumentationPartLocation location()

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

Returns:

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties

public String properties()

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

Returns:

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

toBuilder

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

Returns:

a builder for type T

builder

public static DocumentationPart.Builder builder()

serializableBuilderClass

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

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.