Package software.amazon.awssdk.services.apigateway.model

Class GetDocumentationPartResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.apigateway.model.GetDocumentationPartResponse

All Implemented Interfaces:

ToCopyableBuilder<GetDocumentationPartResponse.Builder,GetDocumentationPartResponse>

@Generated("software.amazon.awssdk:codegen")
public class GetDocumentationPartResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<GetDocumentationPartResponse.Builder,GetDocumentationPartResponse>

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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API, DocumentationParts

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDocumentationPartResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetDocumentationPartResponse.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	id()	The DocumentationPart identifier, generated by Amazon 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.
static Class<? extends GetDocumentationPartResponse.Builder>	serializableBuilderClass()
GetDocumentationPartResponse.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.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

id

public String id()

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

Returns:

The DocumentationPart identifier, generated by Amazon 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 Swagger-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 Swagger 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 Swagger-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 Swagger extension of x-amazon-apigateway-documentation.

toBuilder

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

Returns:

a builder for type T

builder

public static GetDocumentationPartResponse.Builder builder()

serializableBuilderClass

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