@Generated(value="software.amazon.awssdk:codegen") public class DocumentationPart extends Object implements StructuredPojo, 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentationPart.Builder |
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 Amazon API Gateway when the
DocumentationPart
is created. |
DocumentationPartLocation |
location()
The location of the API entity to which the documentation applies.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
properties()
A content map of API-specific key-value pairs describing the targeted API entity.
|
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() |
copy
public String id()
The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart
is created.
DocumentationPart
is created.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.
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 x-amazon-apigateway-documentation
.
"{ \"description\": \"The API does ...\" }"
. Only Swagger-compliant
documentation-related fields from the x-amazon-apigateway-documentation
.public DocumentationPart.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentationPart.Builder,DocumentationPart>
public static DocumentationPart.Builder builder()
public static Class<? extends DocumentationPart.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.