@Generated(value="software.amazon.awssdk:codegen") public final class ExportApiRequest extends ApiGatewayV2Request implements ToCopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ExportApiRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
apiId()
The API identifier.
|
static ExportApiRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
exportVersion()
The version of the API Gateway export algorithm.
|
<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() |
Boolean |
includeExtensions()
Specifies whether to include API
Gateway extensions in the exported API definition.
|
String |
outputType()
The output type of the exported definition file.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ExportApiRequest.Builder> |
serializableBuilderClass() |
String |
specification()
The version of the API specification to use.
|
String |
stageName()
The name of the API stage to export.
|
ExportApiRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String apiId()
The API identifier.
public final 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.
public final Boolean includeExtensions()
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
public final String outputType()
The output type of the exported definition file. Valid values are JSON and YAML.
public final String specification()
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
public final 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.
public ExportApiRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>toBuilder in class ApiGatewayV2Requestpublic static ExportApiRequest.Builder builder()
public static Class<? extends ExportApiRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.