@Generated(value="software.amazon.awssdk:codegen") public final class GetExportRequest extends ApiGatewayRequest implements ToCopyableBuilder<GetExportRequest.Builder,GetExportRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetExportRequest.Builder |
Modifier and Type | Method and 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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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 string identifier of the associated RestApi.
|
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() |
overrideConfiguration
copy
public String restApiId()
The string identifier of the associated RestApi.
public String stageName()
The name of the Stage that will be exported.
public String exportType()
The type of export. Currently only 'swagger' is supported.
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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 toolpublic 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.
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.public GetExportRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetExportRequest.Builder,GetExportRequest>
toBuilder
in class ApiGatewayRequest
public static GetExportRequest.Builder builder()
public static Class<? extends GetExportRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.