public static interface DocumentationPart.Builder extends CopyableBuilder<DocumentationPart.Builder,DocumentationPart>
Modifier and Type | Method and Description |
---|---|
DocumentationPart.Builder |
id(String id)
The DocumentationPart identifier, generated by Amazon API Gateway when the
DocumentationPart is created. |
default DocumentationPart.Builder |
location(Consumer<DocumentationPartLocation.Builder> location)
The location of the API entity to which the documentation applies.
|
DocumentationPart.Builder |
location(DocumentationPartLocation location)
The location of the API entity to which the documentation applies.
|
DocumentationPart.Builder |
properties(String properties)
A content map of API-specific key-value pairs describing the targeted API entity.
|
copy
apply, build
DocumentationPart.Builder id(String id)
The DocumentationPart identifier, generated by Amazon API Gateway when the
DocumentationPart
is created.
id
- The DocumentationPart identifier, generated by Amazon API Gateway when the
DocumentationPart
is created.DocumentationPart.Builder location(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.
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.default DocumentationPart.Builder location(Consumer<DocumentationPartLocation.Builder> 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.
This is a convenience that creates an instance of theDocumentationPartLocation.Builder
avoiding the
need to create one manually via DocumentationPartLocation.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to location(DocumentationPartLocation)
.location
- a consumer that will call methods on DocumentationPartLocation.Builder
location(DocumentationPartLocation)
DocumentationPart.Builder properties(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
.
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
.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.