@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Api extends Object implements Serializable, Cloneable, StructuredPojo
Represents an API.
Constructor and Description |
---|
Api() |
Modifier and Type | Method and Description |
---|---|
Api |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
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.
|
Boolean |
getApiGatewayManaged()
Specifies whether an API is managed by API Gateway.
|
String |
getApiId()
The API ID.
|
String |
getApiKeySelectionExpression()
An API key selection expression.
|
Cors |
getCorsConfiguration()
A CORS configuration.
|
Date |
getCreatedDate()
The timestamp when the API was created.
|
String |
getDescription()
The description of the API.
|
Boolean |
getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
Boolean |
getDisableSchemaValidation()
Avoid validating models when creating a deployment.
|
List<String> |
getImportInfo()
The validation information during API import.
|
String |
getName()
The name of the API.
|
String |
getProtocolType()
The API protocol.
|
String |
getRouteSelectionExpression()
The route selection expression for the API.
|
Map<String,String> |
getTags()
A collection of tags associated with the API.
|
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 |
isApiGatewayManaged()
Specifies whether an API is managed by API Gateway.
|
Boolean |
isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
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 |
setApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an API is managed by API Gateway.
|
void |
setApiId(String apiId)
The API ID.
|
void |
setApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression.
|
void |
setCorsConfiguration(Cors corsConfiguration)
A CORS configuration.
|
void |
setCreatedDate(Date createdDate)
The timestamp when the API was created.
|
void |
setDescription(String description)
The description of the API.
|
void |
setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
void |
setDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment.
|
void |
setImportInfo(Collection<String> importInfo)
The validation information during API import.
|
void |
setName(String name)
The name of the API.
|
void |
setProtocolType(String protocolType)
The API protocol.
|
void |
setRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API.
|
void |
setTags(Map<String,String> tags)
A collection of tags associated with the API.
|
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 |
withApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an API is managed by API Gateway.
|
Api |
withApiId(String apiId)
The API ID.
|
Api |
withApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression.
|
Api |
withCorsConfiguration(Cors corsConfiguration)
A CORS configuration.
|
Api |
withCreatedDate(Date createdDate)
The timestamp when the API was created.
|
Api |
withDescription(String description)
The description of the API.
|
Api |
withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
Api |
withDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment.
|
Api |
withImportInfo(Collection<String> importInfo)
The validation information during API import.
|
Api |
withImportInfo(String... importInfo)
The validation information during API import.
|
Api |
withName(String name)
The name of the API.
|
Api |
withProtocolType(ProtocolType protocolType)
The API protocol.
|
Api |
withProtocolType(String protocolType)
The API protocol.
|
Api |
withRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API.
|
Api |
withTags(Map<String,String> tags)
A collection of tags associated with the API.
|
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.
|
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.
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.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.
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.
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.public void setApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
Gateway. A managed API can be deleted only through the tooling or service that created it.public Boolean getApiGatewayManaged()
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
public Api withApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API
Gateway. A managed API can be deleted only through the tooling or service that created it.public Boolean isApiGatewayManaged()
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
public void setApiId(String apiId)
The API ID.
apiId
- The API ID.public String getApiId()
The API ID.
public Api withApiId(String apiId)
The API ID.
apiId
- The API ID.public void setApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.public String getApiKeySelectionExpression()
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
public Api withApiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.public void setCorsConfiguration(Cors corsConfiguration)
A CORS configuration. Supported only for HTTP APIs.
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.public Cors getCorsConfiguration()
A CORS configuration. Supported only for HTTP APIs.
public Api withCorsConfiguration(Cors corsConfiguration)
A CORS configuration. Supported only for HTTP APIs.
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.public void setCreatedDate(Date createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.public Date getCreatedDate()
The timestamp when the API was created.
public Api withCreatedDate(Date createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.public void setDescription(String description)
The description of the API.
description
- The description of the API.public String getDescription()
The description of the API.
public Api withDescription(String description)
The description of the API.
description
- The description of the API.public void setDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.public Boolean getDisableSchemaValidation()
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
public Api withDisableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.public Boolean isDisableSchemaValidation()
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
public void setDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
To require that clients use a custom domain name to invoke your API, disable the default endpoint.public Boolean getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
public Api withDisableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
disableExecuteApiEndpoint
- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default,
clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
To require that clients use a custom domain name to invoke your API, disable the default endpoint.public Boolean isDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
public List<String> getImportInfo()
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
public void setImportInfo(Collection<String> importInfo)
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
importInfo
- The validation information during API import. This may include particular properties of your OpenAPI
definition which are ignored during import. Supported only for HTTP APIs.public Api withImportInfo(String... importInfo)
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
NOTE: This method appends the values to the existing list (if any). Use
setImportInfo(java.util.Collection)
or withImportInfo(java.util.Collection)
if you want to
override the existing values.
importInfo
- The validation information during API import. This may include particular properties of your OpenAPI
definition which are ignored during import. Supported only for HTTP APIs.public Api withImportInfo(Collection<String> importInfo)
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
importInfo
- The validation information during API import. This may include particular properties of your OpenAPI
definition which are ignored during import. Supported only for HTTP APIs.public void setName(String name)
The name of the API.
name
- The name of the API.public String getName()
The name of the API.
public Api withName(String name)
The name of the API.
name
- The name of the API.public void setProtocolType(String protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public String getProtocolType()
The API protocol.
ProtocolType
public Api withProtocolType(String protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public Api withProtocolType(ProtocolType protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
public void setRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property
is required for WebSocket APIs.public String getRouteSelectionExpression()
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
public Api withRouteSelectionExpression(String routeSelectionExpression)
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be
${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property
is required for WebSocket APIs.public Map<String,String> getTags()
A collection of tags associated with the API.
public void setTags(Map<String,String> tags)
A collection of tags associated with the API.
tags
- A collection of tags associated with the API.public Api withTags(Map<String,String> tags)
A collection of tags associated with the API.
tags
- A collection of tags associated with the API.public Api clearTagsEntries()
public void setVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public String getVersion()
A version identifier for the API.
public Api withVersion(String version)
A version identifier for the API.
version
- A version identifier for the API.public List<String> getWarnings()
The warning messages reported when failonwarnings is turned on during API import.
public void setWarnings(Collection<String> warnings)
The warning messages reported when failonwarnings is turned on during API import.
warnings
- The warning messages reported when failonwarnings is turned on during API import.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.
warnings
- The warning messages reported when failonwarnings is turned on during API import.public Api withWarnings(Collection<String> warnings)
The warning messages reported when failonwarnings is turned on during API import.
warnings
- The warning messages reported when failonwarnings is turned on during API import.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.