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(value="software.amazon.awssdk:codegen")
public final class ExportApiRequest
extends ApiGatewayV2Request
implements ToCopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportApiRequest.Builder

Method Summary

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.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

apiId

public String apiId()

The API identifier.

Returns:

The API identifier.

exportVersion

public 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 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 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 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 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()

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<ExportApiRequest.Builder,ExportApiRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

Returns:

a builder for type T

builder

public static ExportApiRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.