com.amazonaws.services.apigateway.model.GetModelResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-api-gateway Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* Represents the data structure of a method's request or response payload.
*
*
*
* A request model defines the data structure of the client-supplied request payload. A response model defines the data
* structure of the response payload returned by the back end. Although not required, models are useful for mapping
* payloads between the front end and back end.
*
*
* A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping
* template.
*
*
*/
public class GetModelResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The identifier for the model resource.
*
*/
private String id;
/**
*
* The name of the model.
*
*/
private String name;
/**
*
* The description of the model.
*
*/
private String description;
/**
*
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include
* "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as
* the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your
* API's SDK generated by API Gateway to fail.
*
*/
private String schema;
/**
*
* The content-type for the model.
*
*/
private String contentType;
/**
*
* The identifier for the model resource.
*
*
* @param id
* The identifier for the model resource.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The identifier for the model resource.
*
*
* @return The identifier for the model resource.
*/
public String getId() {
return this.id;
}
/**
*
* The identifier for the model resource.
*
*
* @param id
* The identifier for the model resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetModelResult withId(String id) {
setId(id);
return this;
}
/**
*
* The name of the model.
*
*
* @param name
* The name of the model.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the model.
*
*
* @return The name of the model.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the model.
*
*
* @param name
* The name of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetModelResult withName(String name) {
setName(name);
return this;
}
/**
*
* The description of the model.
*
*
* @param description
* The description of the model.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the model.
*
*
* @return The description of the model.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the model.
*
*
* @param description
* The description of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetModelResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include
* "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as
* the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your
* API's SDK generated by API Gateway to fail.
*
*
* @param schema
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not
* include "\*/" characters in the description of any properties because such "\*/" characters may be
* interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the
* installation of your API's SDK generated by API Gateway to fail.
*/
public void setSchema(String schema) {
this.schema = schema;
}
/**
*
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include
* "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as
* the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your
* API's SDK generated by API Gateway to fail.
*
*
* @return The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not
* include "\*/" characters in the description of any properties because such "\*/" characters may
* be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing
* the installation of your API's SDK generated by API Gateway to fail.
*/
public String getSchema() {
return this.schema;
}
/**
*
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include
* "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as
* the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your
* API's SDK generated by API Gateway to fail.
*
*
* @param schema
* The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not
* include "\*/" characters in the description of any properties because such "\*/" characters may be
* interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the
* installation of your API's SDK generated by API Gateway to fail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetModelResult withSchema(String schema) {
setSchema(schema);
return this;
}
/**
*
* The content-type for the model.
*
*
* @param contentType
* The content-type for the model.
*/
public void setContentType(String contentType) {
this.contentType = contentType;
}
/**
*
* The content-type for the model.
*
*
* @return The content-type for the model.
*/
public String getContentType() {
return this.contentType;
}
/**
*
* The content-type for the model.
*
*
* @param contentType
* The content-type for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetModelResult withContentType(String contentType) {
setContentType(contentType);
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 (getId() != null)
sb.append("Id: " + getId() + ",");
if (getName() != null)
sb.append("Name: " + getName() + ",");
if (getDescription() != null)
sb.append("Description: " + getDescription() + ",");
if (getSchema() != null)
sb.append("Schema: " + getSchema() + ",");
if (getContentType() != null)
sb.append("ContentType: " + getContentType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetModelResult == false)
return false;
GetModelResult other = (GetModelResult) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getSchema() == null ^ this.getSchema() == null)
return false;
if (other.getSchema() != null && other.getSchema().equals(this.getSchema()) == false)
return false;
if (other.getContentType() == null ^ this.getContentType() == null)
return false;
if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getSchema() == null) ? 0 : getSchema().hashCode());
hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode());
return hashCode;
}
@Override
public GetModelResult clone() {
try {
return (GetModelResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}