Class RestApi
- java.lang.Object
-
- com.amazonaws.services.apigateway.model.RestApi
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class RestApi extends Object implements Serializable, Cloneable
Represents a REST API.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RestApi()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RestApi
clone()
boolean
equals(Object obj)
Date
getCreatedDate()
The date when the API was created, in ISO 8601 format.String
getDescription()
The API's description.String
getId()
The API's identifier.String
getName()
The API's name.List<String>
getWarnings()
int
hashCode()
void
setCreatedDate(Date createdDate)
The date when the API was created, in ISO 8601 format.void
setDescription(String description)
The API's description.void
setId(String id)
The API's identifier.void
setName(String name)
The API's name.void
setWarnings(Collection<String> warnings)
String
toString()
Returns a string representation of this object; useful for testing and debugging.RestApi
withCreatedDate(Date createdDate)
The date when the API was created, in ISO 8601 format.RestApi
withDescription(String description)
The API's description.RestApi
withId(String id)
The API's identifier.RestApi
withName(String name)
The API's name.RestApi
withWarnings(String... warnings)
NOTE: This method appends the values to the existing list (if any).RestApi
withWarnings(Collection<String> warnings)
-
-
-
Method Detail
-
setId
public void setId(String id)
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
- Parameters:
id
- The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
-
getId
public String getId()
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
- Returns:
- The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
-
withId
public RestApi withId(String id)
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
- Parameters:
id
- The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
public void setName(String name)
The API's name.
- Parameters:
name
- The API's name.
-
getName
public String getName()
The API's name.
- Returns:
- The API's name.
-
withName
public RestApi withName(String name)
The API's name.
- Parameters:
name
- The API's name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
The API's description.
- Parameters:
description
- The API's description.
-
getDescription
public String getDescription()
The API's description.
- Returns:
- The API's description.
-
withDescription
public RestApi withDescription(String description)
The API's description.
- Parameters:
description
- The API's description.- 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 was created, in ISO 8601 format.
- Parameters:
createdDate
- The date when the API was created, in ISO 8601 format.
-
getCreatedDate
public Date getCreatedDate()
The date when the API was created, in ISO 8601 format.
- Returns:
- The date when the API was created, in ISO 8601 format.
-
withCreatedDate
public RestApi withCreatedDate(Date createdDate)
The date when the API was created, in ISO 8601 format.
- Parameters:
createdDate
- The date when the API was created, in ISO 8601 format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWarnings
public void setWarnings(Collection<String> warnings)
- Parameters:
warnings
-
-
withWarnings
public RestApi withWarnings(String... warnings)
NOTE: This method appends the values to the existing list (if any). Use
setWarnings(java.util.Collection)
orwithWarnings(java.util.Collection)
if you want to override the existing values.- Parameters:
warnings
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withWarnings
public RestApi withWarnings(Collection<String> warnings)
- Parameters:
warnings
-- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-