Package software.amazon.awssdk.services.apigatewayv2.model

Class ExportApiRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request

software.amazon.awssdk.services.apigatewayv2.model.ExportApiRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExportApiRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	apiId()	The API identifier.
static ExportApiRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exportVersion()	The version of the API Gateway export algorithm.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

apiId

public final String apiId()

The API identifier.

Returns:

The API identifier.

exportVersion

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.

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.

includeExtensions

public final Boolean includeExtensions()

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.

outputType

public final String outputType()

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.

specification

public final String specification()

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.

stageName

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.

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.

toBuilder

public ExportApiRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

builder

public static ExportApiRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo