/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.apigateway.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
* <p>
* A snapshot of the documentation of an API.
* </p>
* <div class="remarks">
* <p>
* 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.
* </p>
* </div> <div class="seeAlso"> <a
* href="http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html">Documenting an
* API</a>, <a>DocumentationPart</a>, <a>DocumentationVersions</a> </div>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetDocumentationVersionResult extends com.amazonaws.AmazonWebServiceResult<com.amazonaws.ResponseMetadata> implements Serializable, Cloneable {
/**
* <p>
* The version identifier of the API documentation snapshot.
* </p>
*/
private String version;
/**
* <p>
* The date when the API documentation snapshot is created.
* </p>
*/
private java.util.Date createdDate;
/**
* <p>
* The description of the API documentation snapshot.
* </p>
*/
private String description;
/**
* <p>
* The version identifier of the API documentation snapshot.
* </p>
*
* @param version
* The version identifier of the API documentation snapshot.
*/
public void setVersion(String version) {
this.version = version;
}
/**
* <p>
* The version identifier of the API documentation snapshot.
* </p>
*
* @return The version identifier of the API documentation snapshot.
*/
public String getVersion() {
return this.version;
}
/**
* <p>
* The version identifier of the API documentation snapshot.
* </p>
*
* @param version
* The version identifier of the API documentation snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentationVersionResult withVersion(String version) {
setVersion(version);
return this;
}
/**
* <p>
* The date when the API documentation snapshot is created.
* </p>
*
* @param createdDate
* The date when the API documentation snapshot is created.
*/
public void setCreatedDate(java.util.Date createdDate) {
this.createdDate = createdDate;
}
/**
* <p>
* The date when the API documentation snapshot is created.
* </p>
*
* @return The date when the API documentation snapshot is created.
*/
public java.util.Date getCreatedDate() {
return this.createdDate;
}
/**
* <p>
* The date when the API documentation snapshot is created.
* </p>
*
* @param createdDate
* The date when the API documentation snapshot is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentationVersionResult withCreatedDate(java.util.Date createdDate) {
setCreatedDate(createdDate);
return this;
}
/**
* <p>
* The description of the API documentation snapshot.
* </p>
*
* @param description
* The description of the API documentation snapshot.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* <p>
* The description of the API documentation snapshot.
* </p>
*
* @return The description of the API documentation snapshot.
*/
public String getDescription() {
return this.description;
}
/**
* <p>
* The description of the API documentation snapshot.
* </p>
*
* @param description
* The description of the API documentation snapshot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDocumentationVersionResult withDescription(String description) {
setDescription(description);
return this;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getVersion() != null)
sb.append("Version: ").append(getVersion()).append(",");
if (getCreatedDate() != null)
sb.append("CreatedDate: ").append(getCreatedDate()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDocumentationVersionResult == false)
return false;
GetDocumentationVersionResult other = (GetDocumentationVersionResult) obj;
if (other.getVersion() == null ^ this.getVersion() == null)
return false;
if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == false)
return false;
if (other.getCreatedDate() == null ^ this.getCreatedDate() == null)
return false;
if (other.getCreatedDate() != null && other.getCreatedDate().equals(this.getCreatedDate()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode());
hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
return hashCode;
}
@Override
public GetDocumentationVersionResult clone() {
try {
return (GetDocumentationVersionResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}