PutRestApiResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutRestApiResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents a REST API.

Create an API

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutRestApiResult()

Constructors
Constructor and Description
`PutRestApiResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutRestApiResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getBinaryMediaTypes()` The list of binary media types supported by the RestApi.
`Date`	`getCreatedDate()` The timestamp when the API was created.
`String`	`getDescription()` The API's description.
`EndpointConfiguration`	`getEndpointConfiguration()` The endpoint configuration of this RestApi showing the endpoint types of the API.
`String`	`getId()` The API's identifier.
`String`	`getName()` The API's name.
`String`	`getVersion()` A version identifier for the API.
`List<String>`	`getWarnings()` The warning messages reported when `failonwarnings` is turned on during API import.
`int`	`hashCode()`
`void`	`setBinaryMediaTypes(Collection<String> binaryMediaTypes)` The list of binary media types supported by the RestApi.
`void`	`setCreatedDate(Date createdDate)` The timestamp when the API was created.
`void`	`setDescription(String description)` The API's description.
`void`	`setEndpointConfiguration(EndpointConfiguration endpointConfiguration)` The endpoint configuration of this RestApi showing the endpoint types of the API.
`void`	`setId(String id)` The API's identifier.
`void`	`setName(String name)` The API's name.
`void`	`setVersion(String version)` A version identifier for the API.
`void`	`setWarnings(Collection<String> warnings)` The warning messages reported when `failonwarnings` is turned on during API import.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutRestApiResult`	`withBinaryMediaTypes(Collection<String> binaryMediaTypes)` The list of binary media types supported by the RestApi.
`PutRestApiResult`	`withBinaryMediaTypes(String... binaryMediaTypes)` The list of binary media types supported by the RestApi.
`PutRestApiResult`	`withCreatedDate(Date createdDate)` The timestamp when the API was created.
`PutRestApiResult`	`withDescription(String description)` The API's description.
`PutRestApiResult`	`withEndpointConfiguration(EndpointConfiguration endpointConfiguration)` The endpoint configuration of this RestApi showing the endpoint types of the API.
`PutRestApiResult`	`withId(String id)` The API's identifier.
`PutRestApiResult`	`withName(String name)` The API's name.
`PutRestApiResult`	`withVersion(String version)` A version identifier for the API.
`PutRestApiResult`	`withWarnings(Collection<String> warnings)` The warning messages reported when `failonwarnings` is turned on during API import.
`PutRestApiResult`	`withWarnings(String... warnings)` The warning messages reported when `failonwarnings` is turned on during API import.

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
  - PutRestApiResult
```
public PutRestApiResult()
```
- 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 PutRestApiResult 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 PutRestApiResult 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 PutRestApiResult 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 timestamp when the API was created.
    
    Parameters:
    
    createdDate - The timestamp when the API was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the API was created.
    
    Returns:
    
    The timestamp when the API was created.
  - withCreatedDate
```
public PutRestApiResult withCreatedDate(Date createdDate)
```
    The timestamp when the API was created.
    
    Parameters:
    
    createdDate - The timestamp when the API was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    A version identifier for the API.
    
    Parameters:
    
    version - A version identifier for the API.
  - getVersion
```
public String getVersion()
```
    A version identifier for the API.
    
    Returns:
    
    A version identifier for the API.
  - withVersion
```
public PutRestApiResult withVersion(String version)
```
    A version identifier for the API.
    
    Parameters:
    
    version - A version identifier for the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWarnings
```
public List<String> getWarnings()
```
    The warning messages reported when failonwarnings is turned on during API import.
    
    Returns:
    
    The warning messages reported when failonwarnings is turned on during API import.
  - setWarnings
```
public void setWarnings(Collection<String> warnings)
```
    The warning messages reported when failonwarnings is turned on during API import.
    
    Parameters:
    
    warnings - The warning messages reported when failonwarnings is turned on during API import.
  - withWarnings
```
public PutRestApiResult withWarnings(String... warnings)
```
    The warning messages reported when failonwarnings is turned on during API import.
    
    NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    warnings - The warning messages reported when failonwarnings is turned on during API import.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWarnings
```
public PutRestApiResult withWarnings(Collection<String> warnings)
```
    The warning messages reported when failonwarnings is turned on during API import.
    
    Parameters:
    
    warnings - The warning messages reported when failonwarnings is turned on during API import.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBinaryMediaTypes
```
public List<String> getBinaryMediaTypes()
```
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    Returns:
    
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
  - setBinaryMediaTypes
```
public void setBinaryMediaTypes(Collection<String> binaryMediaTypes)
```
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    Parameters:
    
    binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
  - withBinaryMediaTypes
```
public PutRestApiResult withBinaryMediaTypes(String... binaryMediaTypes)
```
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    NOTE: This method appends the values to the existing list (if any). Use setBinaryMediaTypes(java.util.Collection) or withBinaryMediaTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBinaryMediaTypes
```
public PutRestApiResult withBinaryMediaTypes(Collection<String> binaryMediaTypes)
```
    The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    Parameters:
    
    binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointConfiguration
```
public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
```
    The endpoint configuration of this RestApi showing the endpoint types of the API.
    
    Parameters:
    
    endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
  - getEndpointConfiguration
```
public EndpointConfiguration getEndpointConfiguration()
```
    The endpoint configuration of this RestApi showing the endpoint types of the API.
    
    Returns:
    
    The endpoint configuration of this RestApi showing the endpoint types of the API.
  - withEndpointConfiguration
```
public PutRestApiResult withEndpointConfiguration(EndpointConfiguration endpointConfiguration)
```
    The endpoint configuration of this RestApi showing the endpoint types of the API.
    
    Parameters:
    
    endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
    
    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 PutRestApiResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class PutRestApiResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

PutRestApiResult

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setCreatedDate

getCreatedDate

withCreatedDate

setVersion

getVersion

withVersion

getWarnings

setWarnings

withWarnings

withWarnings

getBinaryMediaTypes

setBinaryMediaTypes

withBinaryMediaTypes

withBinaryMediaTypes

setEndpointConfiguration

getEndpointConfiguration

withEndpointConfiguration

toString

equals

hashCode

clone