@Generated(value="software.amazon.awssdk:codegen") public class DocumentationVersion extends Object implements StructuredPojo, ToCopyableBuilder<DocumentationVersion.Builder,DocumentationVersion>
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 |
DocumentationVersion.Builder |
Modifier and Type | Method and Description |
---|---|
static DocumentationVersion.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) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends DocumentationVersion.Builder> |
serializableBuilderClass() |
DocumentationVersion.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 DocumentationVersion.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentationVersion.Builder,DocumentationVersion>
public static DocumentationVersion.Builder builder()
public static Class<? extends DocumentationVersion.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.