Package software.amazon.awssdk.services.apigateway.model

Class GetExportRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.GetExportRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetExportRequest.Builder,GetExportRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetExportRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetExportRequest.Builder,GetExportRequest>

Request a new export of a RestApi for a particular Stage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetExportRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	accepts()	The content-type of the export, for example application/json.
static GetExportRequest.Builder	builder()
boolean	equals(Object obj)
String	exportType()	The type of export.
int	hashCode()
Map<String,String>	parameters()	A key-value map of query string parameters that specify properties of the export, depending on the requested exportType.
String	restApiId()	The identifier of the RestApi to be exported.
static Class<? extends GetExportRequest.Builder>	serializableBuilderClass()
String	stageName()	The name of the Stage that will be exported.
GetExportRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

The identifier of the RestApi to be exported.

Returns:

The identifier of the RestApi to be exported.

stageName

public String stageName()

The name of the Stage that will be exported.

Returns:

The name of the Stage that will be exported.

exportType

public String exportType()

The type of export. Currently only 'swagger' is supported.

Returns:

The type of export. Currently only 'swagger' is supported.

parameters

public Map<String,String> parameters()

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Returns:

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

accepts

public String accepts()

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.

Returns:

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.

toBuilder

public GetExportRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetExportRequest.Builder,GetExportRequest>

Returns:

a builder for type T

builder

public static GetExportRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetExportRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object