DocumentationVersion (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.DocumentationVersion

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentationVersion
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentationVersion()

Constructors
Constructor and Description
`DocumentationVersion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentationVersion`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedDate()` The date when the API documentation snapshot is created.
`String`	`getDescription()` The description of the API documentation snapshot.
`String`	`getVersion()` The version identifier of the API documentation snapshot.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedDate(Date createdDate)` The date when the API documentation snapshot is created.
`void`	`setDescription(String description)` The description of the API documentation snapshot.
`void`	`setVersion(String version)` The version identifier of the API documentation snapshot.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentationVersion`	`withCreatedDate(Date createdDate)` The date when the API documentation snapshot is created.
`DocumentationVersion`	`withDescription(String description)` The description of the API documentation snapshot.
`DocumentationVersion`	`withVersion(String version)` The version identifier of the API documentation snapshot.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentationVersion
```
public DocumentationVersion()
```
- Method Detail
  - setVersion
```
public void setVersion(String version)
```
    The version identifier of the API documentation snapshot.
    
    Parameters:
    
    version - The version identifier of the API documentation snapshot.
  - getVersion
```
public String getVersion()
```
    The version identifier of the API documentation snapshot.
    
    Returns:
    
    The version identifier of the API documentation snapshot.
  - withVersion
```
public DocumentationVersion withVersion(String version)
```
    The version identifier of the API documentation snapshot.
    
    Parameters:
    
    version - The version identifier of the API documentation snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date when the API documentation snapshot is created.
    
    Parameters:
    
    createdDate - The date when the API documentation snapshot is created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date when the API documentation snapshot is created.
    
    Returns:
    
    The date when the API documentation snapshot is created.
  - withCreatedDate
```
public DocumentationVersion withCreatedDate(Date createdDate)
```
    The date when the API documentation snapshot is created.
    
    Parameters:
    
    createdDate - The date when the API documentation snapshot is created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the API documentation snapshot.
    
    Parameters:
    
    description - The description of the API documentation snapshot.
  - getDescription
```
public String getDescription()
```
    The description of the API documentation snapshot.
    
    Returns:
    
    The description of the API documentation snapshot.
  - withDescription
```
public DocumentationVersion withDescription(String description)
```
    The description of the API documentation snapshot.
    
    Parameters:
    
    description - The description of the API documentation snapshot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentationVersion clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class DocumentationVersion

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentationVersion

Method Detail

setVersion

getVersion

withVersion

setCreatedDate

getCreatedDate

withCreatedDate

setDescription

getDescription

withDescription

toString

equals

hashCode

clone

marshall