Interface DocumentationPart.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DocumentationPart.Builder,
,DocumentationPart> SdkBuilder<DocumentationPart.Builder,
,DocumentationPart> SdkPojo
- Enclosing class:
DocumentationPart
-
Method Summary
Modifier and TypeMethodDescriptionThe DocumentationPart identifier, generated by API Gateway when theDocumentationPart
is created.default DocumentationPart.Builder
location
(Consumer<DocumentationPartLocation.Builder> location) The location of the API entity to which the documentation applies.location
(DocumentationPartLocation location) The location of the API entity to which the documentation applies.properties
(String properties) A content map of API-specific key-value pairs describing the targeted API entity.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
id
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart
is created.- Parameters:
id
- The DocumentationPart identifier, generated by API Gateway when theDocumentationPart
is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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 method that creates an instance of theDocumentationPartLocation.Builder
avoiding the need to create one manually viaDocumentationPartLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocation(DocumentationPartLocation)
.- Parameters:
location
- a consumer that will call methods onDocumentationPartLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 ofx-amazon-apigateway-documentation
.- Parameters:
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 ofx-amazon-apigateway-documentation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-