GetApiResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigatewayv2.model.GetApiResult

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetApiResult()

Constructors
Constructor and Description
`GetApiResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetApiResult`	`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.
`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`	`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`	`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.
`GetApiResult`	`withApiEndpoint(String apiEndpoint)` The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
`GetApiResult`	`withApiId(String apiId)` The API ID.
`GetApiResult`	`withApiKeySelectionExpression(String apiKeySelectionExpression)` An API key selection expression.
`GetApiResult`	`withCreatedDate(Date createdDate)` The timestamp when the API was created.
`GetApiResult`	`withDescription(String description)` The description of the API.
`GetApiResult`	`withDisableSchemaValidation(Boolean disableSchemaValidation)` Avoid validating models when creating a deployment.
`GetApiResult`	`withName(String name)` The name of the API.
`GetApiResult`	`withProtocolType(ProtocolType protocolType)` The API protocol: Currently only WEBSOCKET is supported.
`GetApiResult`	`withProtocolType(String protocolType)` The API protocol: Currently only WEBSOCKET is supported.
`GetApiResult`	`withRouteSelectionExpression(String routeSelectionExpression)` The route selection expression for the API.
`GetApiResult`	`withVersion(String version)` A version identifier for the API.
`GetApiResult`	`withWarnings(Collection<String> warnings)` The warning messages reported when failonwarnings is turned on during API import.
`GetApiResult`	`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
  - GetApiResult
```
public GetApiResult()
```
- 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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 GetApiResult 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.
  - 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 GetApiResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetApiResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetApiResult

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

toString

equals

hashCode

clone