com.amazonaws.services.apigatewayv2.model

Class ExportApiRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.ExportApiRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ExportApiRequest()

Method Summary

Modifier and Type	Method and Description
ExportApiRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API identifier.
String	getExportVersion() The version of the API Gateway export algorithm.
Boolean	getIncludeExtensions() Specifies whether to include API Gateway extensions in the exported API definition.
String	getOutputType() The output type of the exported definition file.
String	getSpecification() The version of the API specification to use.
String	getStageName() The name of the API stage to export.
int	hashCode()
Boolean	isIncludeExtensions() Specifies whether to include API Gateway extensions in the exported API definition.
void	setApiId(String apiId) The API identifier.
void	setExportVersion(String exportVersion) The version of the API Gateway export algorithm.
void	setIncludeExtensions(Boolean includeExtensions) Specifies whether to include API Gateway extensions in the exported API definition.
void	setOutputType(String outputType) The output type of the exported definition file.
void	setSpecification(String specification) The version of the API specification to use.
void	setStageName(String stageName) The name of the API stage to export.
String	toString() Returns a string representation of this object.
ExportApiRequest	withApiId(String apiId) The API identifier.
ExportApiRequest	withExportVersion(String exportVersion) The version of the API Gateway export algorithm.
ExportApiRequest	withIncludeExtensions(Boolean includeExtensions) Specifies whether to include API Gateway extensions in the exported API definition.
ExportApiRequest	withOutputType(String outputType) The output type of the exported definition file.
ExportApiRequest	withSpecification(String specification) The version of the API specification to use.
ExportApiRequest	withStageName(String stageName) The name of the API stage to export.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportApiRequest

public ExportApiRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public ExportApiRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExportVersion

public void setExportVersion(String exportVersion)

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Parameters:

exportVersion - The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

getExportVersion

public String getExportVersion()

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Returns:

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

withExportVersion

public ExportApiRequest withExportVersion(String exportVersion)

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Parameters:

exportVersion - The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIncludeExtensions

public void setIncludeExtensions(Boolean includeExtensions)

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Parameters:

includeExtensions - Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

getIncludeExtensions

public Boolean getIncludeExtensions()

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Returns:

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

withIncludeExtensions

public ExportApiRequest withIncludeExtensions(Boolean includeExtensions)

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Parameters:

includeExtensions - Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeExtensions

public Boolean isIncludeExtensions()

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Returns:

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

setOutputType

public void setOutputType(String outputType)

The output type of the exported definition file. Valid values are JSON and YAML.

Parameters:

outputType - The output type of the exported definition file. Valid values are JSON and YAML.

getOutputType

public String getOutputType()

The output type of the exported definition file. Valid values are JSON and YAML.

Returns:

The output type of the exported definition file. Valid values are JSON and YAML.

withOutputType

public ExportApiRequest withOutputType(String outputType)

The output type of the exported definition file. Valid values are JSON and YAML.

Parameters:

outputType - The output type of the exported definition file. Valid values are JSON and YAML.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSpecification

public void setSpecification(String specification)

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Parameters:

specification - The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

getSpecification

public String getSpecification()

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Returns:

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

withSpecification

public ExportApiRequest withSpecification(String specification)

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Parameters:

specification - The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStageName

public void setStageName(String stageName)

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Parameters:

stageName - The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

getStageName

public String getStageName()

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Returns:

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

withStageName

public ExportApiRequest withStageName(String stageName)

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Parameters:

stageName - The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

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 ExportApiRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()