Class DocumentationPart
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentationPart.Builder,
DocumentationPart>
A documentation part for a targeted API entity.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentationPart.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The DocumentationPart identifier, generated by API Gateway when theDocumentationPart
is created.location()
The location of the API entity to which the documentation applies.final String
A content map of API-specific key-value pairs describing the targeted API entity.static Class
<? extends DocumentationPart.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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:
- 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
.
-
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 interfaceToCopyableBuilder<DocumentationPart.Builder,
DocumentationPart> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-