Api (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigatewayv2.model.Api

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Api
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents an API.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Api()

Constructors
Constructor and Description
`Api()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Api`	`addTagsEntry(String key, String value)`
`Api`	`clearTagsEntries()` Removes all the entries added into Tags.
`Api`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiEndpoint()` The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
`String`	`getApiId()` The API ID.
`String`	`getApiKeySelectionExpression()` An API key selection expression.
`Date`	`getCreatedDate()` The timestamp when the API was created.
`String`	`getDescription()` The description of the API.
`Boolean`	`getDisableSchemaValidation()` Avoid validating models when creating a deployment.
`String`	`getName()` The name of the API.
`String`	`getProtocolType()` The API protocol: Currently only WEBSOCKET is supported.
`String`	`getRouteSelectionExpression()` The route selection expression for the API.
`Map<String,String>`	`getTags()` The key-value map of strings.
`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()`
`Boolean`	`isDisableSchemaValidation()` Avoid validating models when creating a deployment.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiEndpoint(String apiEndpoint)` The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
`void`	`setApiId(String apiId)` The API ID.
`void`	`setApiKeySelectionExpression(String apiKeySelectionExpression)` An API key selection expression.
`void`	`setCreatedDate(Date createdDate)` The timestamp when the API was created.
`void`	`setDescription(String description)` The description of the API.
`void`	`setDisableSchemaValidation(Boolean disableSchemaValidation)` Avoid validating models when creating a deployment.
`void`	`setName(String name)` The name of the API.
`void`	`setProtocolType(String protocolType)` The API protocol: Currently only WEBSOCKET is supported.
`void`	`setRouteSelectionExpression(String routeSelectionExpression)` The route selection expression for the API.
`void`	`setTags(Map<String,String> tags)` The key-value map of strings.
`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.
`Api`	`withApiEndpoint(String apiEndpoint)` The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
`Api`	`withApiId(String apiId)` The API ID.
`Api`	`withApiKeySelectionExpression(String apiKeySelectionExpression)` An API key selection expression.
`Api`	`withCreatedDate(Date createdDate)` The timestamp when the API was created.
`Api`	`withDescription(String description)` The description of the API.
`Api`	`withDisableSchemaValidation(Boolean disableSchemaValidation)` Avoid validating models when creating a deployment.
`Api`	`withName(String name)` The name of the API.
`Api`	`withProtocolType(ProtocolType protocolType)` The API protocol: Currently only WEBSOCKET is supported.
`Api`	`withProtocolType(String protocolType)` The API protocol: Currently only WEBSOCKET is supported.
`Api`	`withRouteSelectionExpression(String routeSelectionExpression)` The route selection expression for the API.
`Api`	`withTags(Map<String,String> tags)` The key-value map of strings.
`Api`	`withVersion(String version)` A version identifier for the API.
`Api`	`withWarnings(Collection<String> warnings)` The warning messages reported when failonwarnings is turned on during API import.
`Api`	`withWarnings(String... warnings)` The warning messages reported when failonwarnings is turned on during API import.

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

- Constructor Detail
  - Api
```
public Api()
```
- Method Detail
  - setApiEndpoint
```
public void setApiEndpoint(String apiEndpoint)
```
    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    
    Parameters:
    
    apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
  - getApiEndpoint
```
public String getApiEndpoint()
```
    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    
    Returns:
    
    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
  - withApiEndpoint
```
public Api withApiEndpoint(String apiEndpoint)
```
    The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    
    Parameters:
    
    apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiId
```
public void setApiId(String apiId)
```
    The API ID.
    
    Parameters:
    
    apiId - The API ID.
  - getApiId
```
public String getApiId()
```
    The API ID.
    
    Returns:
    
    The API ID.
  - withApiId
```
public Api withApiId(String apiId)
```
    The API ID.
    
    Parameters:
    
    apiId - The API ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiKeySelectionExpression
```
public void setApiKeySelectionExpression(String apiKeySelectionExpression)
```
    An API key selection expression. See API Key Selection Expressions.
    
    Parameters:
    
    apiKeySelectionExpression - An API key selection expression. See API Key Selection Expressions.
  - getApiKeySelectionExpression
```
public String getApiKeySelectionExpression()
```
    An API key selection expression. See API Key Selection Expressions.
    
    Returns:
    
    An API key selection expression. See API Key Selection Expressions.
  - withApiKeySelectionExpression
```
public Api withApiKeySelectionExpression(String apiKeySelectionExpression)
```
    An API key selection expression. See API Key Selection Expressions.
    
    Parameters:
    
    apiKeySelectionExpression - An API key selection expression. See API Key Selection Expressions.
    
    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 Api 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.
  - setDescription
```
public void setDescription(String description)
```
    The description of the API.
    
    Parameters:
    
    description - The description of the API.
  - getDescription
```
public String getDescription()
```
    The description of the API.
    
    Returns:
    
    The description of the API.
  - withDescription
```
public Api withDescription(String description)
```
    The description of the API.
    
    Parameters:
    
    description - The description of the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisableSchemaValidation
```
public void setDisableSchemaValidation(Boolean disableSchemaValidation)
```
    Avoid validating models when creating a deployment.
    
    Parameters:
    
    disableSchemaValidation - Avoid validating models when creating a deployment.
  - getDisableSchemaValidation
```
public Boolean getDisableSchemaValidation()
```
    Avoid validating models when creating a deployment.
    
    Returns:
    
    Avoid validating models when creating a deployment.
  - withDisableSchemaValidation
```
public Api withDisableSchemaValidation(Boolean disableSchemaValidation)
```
    Avoid validating models when creating a deployment.
    
    Parameters:
    
    disableSchemaValidation - Avoid validating models when creating a deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisableSchemaValidation
```
public Boolean isDisableSchemaValidation()
```
    Avoid validating models when creating a deployment.
    
    Returns:
    
    Avoid validating models when creating a deployment.
  - setName
```
public void setName(String name)
```
    The name of the API.
    
    Parameters:
    
    name - The name of the API.
  - getName
```
public String getName()
```
    The name of the API.
    
    Returns:
    
    The name of the API.
  - withName
```
public Api withName(String name)
```
    The name of the API.
    
    Parameters:
    
    name - The name of the API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocolType
```
public void setProtocolType(String protocolType)
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    Parameters:
    
    protocolType - The API protocol: Currently only WEBSOCKET is supported.
    
    See Also:
    
    ProtocolType
  - getProtocolType
```
public String getProtocolType()
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    Returns:
    
    The API protocol: Currently only WEBSOCKET is supported.
    
    See Also:
    
    ProtocolType
  - withProtocolType
```
public Api withProtocolType(String protocolType)
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    Parameters:
    
    protocolType - The API protocol: Currently only WEBSOCKET is supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolType
  - withProtocolType
```
public Api withProtocolType(ProtocolType protocolType)
```
    The API protocol: Currently only WEBSOCKET is supported.
    
    Parameters:
    
    protocolType - The API protocol: Currently only WEBSOCKET is supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProtocolType
  - setRouteSelectionExpression
```
public void setRouteSelectionExpression(String routeSelectionExpression)
```
    The route selection expression for the API.
    
    Parameters:
    
    routeSelectionExpression - The route selection expression for the API.
  - getRouteSelectionExpression
```
public String getRouteSelectionExpression()
```
    The route selection expression for the API.
    
    Returns:
    
    The route selection expression for the API.
  - withRouteSelectionExpression
```
public Api withRouteSelectionExpression(String routeSelectionExpression)
```
    The route selection expression for the API.
    
    Parameters:
    
    routeSelectionExpression - The route selection expression for the API.
    
    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 Api 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 Api 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 Api 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.
  - getTags
```
public Map<String,String> getTags()
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
    
    Returns:
    
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
  - withTags
```
public Api withTags(Map<String,String> tags)
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
    
    Parameters:
    
    tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Api addTagsEntry(String key,
                        String value)
```
  - clearTagsEntries
```
public Api clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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 Api 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.

Did this page help you?

Class Api

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Api

Method Detail

setApiEndpoint

getApiEndpoint

withApiEndpoint

setApiId

getApiId

withApiId

setApiKeySelectionExpression

getApiKeySelectionExpression

withApiKeySelectionExpression

setCreatedDate

getCreatedDate

withCreatedDate

setDescription

getDescription

withDescription

setDisableSchemaValidation

getDisableSchemaValidation

withDisableSchemaValidation

isDisableSchemaValidation

setName

getName

withName

setProtocolType

getProtocolType

withProtocolType

withProtocolType

setRouteSelectionExpression

getRouteSelectionExpression

withRouteSelectionExpression

setVersion

getVersion

withVersion

getWarnings

setWarnings

withWarnings

withWarnings

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall