GetDocumentationVersionResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.model.GetDocumentationVersionResult

All Implemented Interfaces:

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

GetDocumentationVersionResult()

Constructors
Constructor and Description
`GetDocumentationVersionResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetDocumentationVersionResult`	`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`	`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.
`GetDocumentationVersionResult`	`withCreatedDate(Date createdDate)` The date when the API documentation snapshot is created.
`GetDocumentationVersionResult`	`withDescription(String description)` The description of the API documentation snapshot.
`GetDocumentationVersionResult`	`withVersion(String version)` The version identifier of the API documentation snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetDocumentationVersionResult
```
public GetDocumentationVersionResult()
```
- 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 GetDocumentationVersionResult 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 GetDocumentationVersionResult 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 GetDocumentationVersionResult 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 GetDocumentationVersionResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetDocumentationVersionResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetDocumentationVersionResult

Method Detail

setVersion

getVersion

withVersion

setCreatedDate

getCreatedDate

withCreatedDate

setDescription

getDescription

withDescription

toString

equals

hashCode

clone