AwsApiGatewayRestApiDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsApiGatewayRestApiDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsApiGatewayRestApiDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a REST API in version 1 of Amazon API Gateway.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsApiGatewayRestApiDetails()

Constructors
Constructor and Description
`AwsApiGatewayRestApiDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsApiGatewayRestApiDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiKeySource()` The source of the API key for metering requests according to a usage plan.
`List<String>`	`getBinaryMediaTypes()` The list of binary media types supported by the REST API.
`String`	`getCreatedDate()` Indicates when the API was created.
`String`	`getDescription()` A description of the REST API.
`AwsApiGatewayEndpointConfiguration`	`getEndpointConfiguration()` The endpoint configuration of the REST API.
`String`	`getId()` The identifier of the REST API.
`Integer`	`getMinimumCompressionSize()` The minimum size in bytes of a payload before compression is enabled.
`String`	`getName()` The name of the REST API.
`String`	`getVersion()` The version identifier for the REST API.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiKeySource(String apiKeySource)` The source of the API key for metering requests according to a usage plan.
`void`	`setBinaryMediaTypes(Collection<String> binaryMediaTypes)` The list of binary media types supported by the REST API.
`void`	`setCreatedDate(String createdDate)` Indicates when the API was created.
`void`	`setDescription(String description)` A description of the REST API.
`void`	`setEndpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)` The endpoint configuration of the REST API.
`void`	`setId(String id)` The identifier of the REST API.
`void`	`setMinimumCompressionSize(Integer minimumCompressionSize)` The minimum size in bytes of a payload before compression is enabled.
`void`	`setName(String name)` The name of the REST API.
`void`	`setVersion(String version)` The version identifier for the REST API.
`String`	`toString()` Returns a string representation of this object.
`AwsApiGatewayRestApiDetails`	`withApiKeySource(String apiKeySource)` The source of the API key for metering requests according to a usage plan.
`AwsApiGatewayRestApiDetails`	`withBinaryMediaTypes(Collection<String> binaryMediaTypes)` The list of binary media types supported by the REST API.
`AwsApiGatewayRestApiDetails`	`withBinaryMediaTypes(String... binaryMediaTypes)` The list of binary media types supported by the REST API.
`AwsApiGatewayRestApiDetails`	`withCreatedDate(String createdDate)` Indicates when the API was created.
`AwsApiGatewayRestApiDetails`	`withDescription(String description)` A description of the REST API.
`AwsApiGatewayRestApiDetails`	`withEndpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)` The endpoint configuration of the REST API.
`AwsApiGatewayRestApiDetails`	`withId(String id)` The identifier of the REST API.
`AwsApiGatewayRestApiDetails`	`withMinimumCompressionSize(Integer minimumCompressionSize)` The minimum size in bytes of a payload before compression is enabled.
`AwsApiGatewayRestApiDetails`	`withName(String name)` The name of the REST API.
`AwsApiGatewayRestApiDetails`	`withVersion(String version)` The version identifier for the REST API.

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

- Constructor Detail
  - AwsApiGatewayRestApiDetails
```
public AwsApiGatewayRestApiDetails()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the REST API.
    
    Parameters:
    
    id - The identifier of the REST API.
  - getId
```
public String getId()
```
    The identifier of the REST API.
    
    Returns:
    
    The identifier of the REST API.
  - withId
```
public AwsApiGatewayRestApiDetails withId(String id)
```
    The identifier of the REST API.
    
    Parameters:
    
    id - The identifier of the REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the REST API.
    
    Parameters:
    
    name - The name of the REST API.
  - getName
```
public String getName()
```
    The name of the REST API.
    
    Returns:
    
    The name of the REST API.
  - withName
```
public AwsApiGatewayRestApiDetails withName(String name)
```
    The name of the REST API.
    
    Parameters:
    
    name - The name of the REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the REST API.
    
    Parameters:
    
    description - A description of the REST API.
  - getDescription
```
public String getDescription()
```
    A description of the REST API.
    
    Returns:
    
    A description of the REST API.
  - withDescription
```
public AwsApiGatewayRestApiDetails withDescription(String description)
```
    A description of the REST API.
    
    Parameters:
    
    description - A description of the REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(String createdDate)
```
    Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Parameters:
    createdDate - Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
  - getCreatedDate
```
public String getCreatedDate()
```
    Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Returns:
    Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
  - withCreatedDate
```
public AwsApiGatewayRestApiDetails withCreatedDate(String createdDate)
```
    Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    - YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    - YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    - YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    - YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Parameters:
    createdDate - Indicates when the API was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version identifier for the REST API.
    
    Parameters:
    
    version - The version identifier for the REST API.
  - getVersion
```
public String getVersion()
```
    The version identifier for the REST API.
    
    Returns:
    
    The version identifier for the REST API.
  - withVersion
```
public AwsApiGatewayRestApiDetails withVersion(String version)
```
    The version identifier for the REST API.
    
    Parameters:
    
    version - The version identifier for the REST API.
    
    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 REST API.
    
    Returns:
    
    The list of binary media types supported by the REST API.
  - setBinaryMediaTypes
```
public void setBinaryMediaTypes(Collection<String> binaryMediaTypes)
```
    The list of binary media types supported by the REST API.
    
    Parameters:
    
    binaryMediaTypes - The list of binary media types supported by the REST API.
  - withBinaryMediaTypes
```
public AwsApiGatewayRestApiDetails withBinaryMediaTypes(String... binaryMediaTypes)
```
    The list of binary media types supported by the REST API.
    
    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 REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBinaryMediaTypes
```
public AwsApiGatewayRestApiDetails withBinaryMediaTypes(Collection<String> binaryMediaTypes)
```
    The list of binary media types supported by the REST API.
    
    Parameters:
    
    binaryMediaTypes - The list of binary media types supported by the REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinimumCompressionSize
```
public void setMinimumCompressionSize(Integer minimumCompressionSize)
```
    The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
    
    Parameters:
    
    minimumCompressionSize - The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
  - getMinimumCompressionSize
```
public Integer getMinimumCompressionSize()
```
    The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
    
    Returns:
    
    The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
  - withMinimumCompressionSize
```
public AwsApiGatewayRestApiDetails withMinimumCompressionSize(Integer minimumCompressionSize)
```
    The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
    
    Parameters:
    
    minimumCompressionSize - The minimum size in bytes of a payload before compression is enabled.
    
    If null, then compression is disabled.
    
    If 0, then all payloads are compressed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiKeySource
```
public void setApiKeySource(String apiKeySource)
```
    The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
    
    Parameters:
    
    apiKeySource - The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
  - getApiKeySource
```
public String getApiKeySource()
```
    The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
    
    Returns:
    
    The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
  - withApiKeySource
```
public AwsApiGatewayRestApiDetails withApiKeySource(String apiKeySource)
```
    The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
    
    Parameters:
    
    apiKeySource - The source of the API key for metering requests according to a usage plan.
    
    HEADER indicates whether to read the API key from the X-API-Key header of a request.
    
    AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointConfiguration
```
public void setEndpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)
```
    The endpoint configuration of the REST API.
    
    Parameters:
    
    endpointConfiguration - The endpoint configuration of the REST API.
  - getEndpointConfiguration
```
public AwsApiGatewayEndpointConfiguration getEndpointConfiguration()
```
    The endpoint configuration of the REST API.
    
    Returns:
    
    The endpoint configuration of the REST API.
  - withEndpointConfiguration
```
public AwsApiGatewayRestApiDetails withEndpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)
```
    The endpoint configuration of the REST API.
    
    Parameters:
    
    endpointConfiguration - The endpoint configuration of the REST 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 AwsApiGatewayRestApiDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.795

Class AwsApiGatewayRestApiDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsApiGatewayRestApiDetails

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setCreatedDate

getCreatedDate

withCreatedDate

setVersion

getVersion

withVersion

getBinaryMediaTypes

setBinaryMediaTypes

withBinaryMediaTypes

withBinaryMediaTypes

setMinimumCompressionSize

getMinimumCompressionSize

withMinimumCompressionSize

setApiKeySource

getApiKeySource

withApiKeySource

setEndpointConfiguration

getEndpointConfiguration

withEndpointConfiguration

toString

equals

hashCode

clone

marshall