@Generated(value="software.amazon.awssdk:codegen") public final class DocumentationPart extends Object implements SdkPojo, Serializable, 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI 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) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
id()
The DocumentationPart identifier, generated by 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.
|
List<SdkField<?>> |
sdkFields() |
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()
Returns a string representation of this object.
|
copy
public final String id()
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart
is
created.
DocumentationPart
is created.public final 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 final 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 OpenAPI-compliant
documentation-related fields from the x-amazon-apigateway-documentation
.
"{ \"description\": \"The API does ...\" }"
. Only OpenAPI-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 final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()