@Generated(value="software.amazon.awssdk:codegen") public final class CreateDocumentationPartResponse extends ApiGatewayResponse implements ToCopyableBuilder<CreateDocumentationPartResponse.Builder,CreateDocumentationPartResponse>
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 |
CreateDocumentationPartResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateDocumentationPartResponse.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)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
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 CreateDocumentationPartResponse.Builder> |
serializableBuilderClass() |
CreateDocumentationPartResponse.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.
|
responseMetadatasdkHttpResponsecopypublic 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 CreateDocumentationPartResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateDocumentationPartResponse.Builder,CreateDocumentationPartResponse>toBuilder in class AwsResponsepublic static CreateDocumentationPartResponse.Builder builder()
public static Class<? extends CreateDocumentationPartResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will
again be available.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.