@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.
| 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) |
<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 CreateDocumentationPartResponse.Builder> |
serializableBuilderClass() |
CreateDocumentationPartResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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 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 of
x-amazon-apigateway-documentation.
"{ \"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 of
x-amazon-apigateway-documentation.public CreateDocumentationPartResponse.Builder toBuilder()
toBuilder 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)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.