Package software.amazon.awssdk.services.apigateway.model

Class DocumentationVersion

java.lang.Object

software.amazon.awssdk.services.apigateway.model.DocumentationVersion

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DocumentationVersion.Builder,DocumentationVersion>

@Generated("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.

Documenting an API, DocumentationPart, DocumentationVersions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentationVersion.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentationVersion.Builder	builder()
Date	createdDate()	The date when the API documentation snapshot is created.
String	description()	The description of the API documentation snapshot.
boolean	equals(Object obj)
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

version

public String version()

The version identifier of the API documentation snapshot.

Returns:

The version identifier of the API documentation snapshot.

createdDate

public Date createdDate()

The date when the API documentation snapshot is created.

Returns:

The date when the API documentation snapshot is created.

description

public String description()

The description of the API documentation snapshot.

Returns:

The description of the API documentation snapshot.

toBuilder

public DocumentationVersion.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentationVersion.Builder,DocumentationVersion>

Returns:

a builder for type T

builder

public static DocumentationVersion.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentationVersion.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.