@Generated(value="software.amazon.awssdk:codegen") public class CreateDocumentationVersionResponse extends APIGatewayResponse implements ToCopyableBuilder<CreateDocumentationVersionResponse.Builder,CreateDocumentationVersionResponse>
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDocumentationVersionResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateDocumentationVersionResponse.Builder |
builder() |
Instant |
createdDate()
The date when the API documentation snapshot is created.
|
String |
description()
The description of the API documentation snapshot.
|
boolean |
equals(Object obj) |
<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() |
static Class<? extends CreateDocumentationVersionResponse.Builder> |
serializableBuilderClass() |
CreateDocumentationVersionResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
version()
The version identifier of the API documentation snapshot.
|
copy
public String version()
The version identifier of the API documentation snapshot.
public Instant createdDate()
The date when the API documentation snapshot is created.
public String description()
The description of the API documentation snapshot.
public CreateDocumentationVersionResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDocumentationVersionResponse.Builder,CreateDocumentationVersionResponse>
toBuilder
in class AwsResponse
public static CreateDocumentationVersionResponse.Builder builder()
public static Class<? extends CreateDocumentationVersionResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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 SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.