software.amazon.awssdk.services.apigateway.model

Class ImportDocumentationPartsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.ImportDocumentationPartsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImportDocumentationPartsRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

Import documentation parts from an external (e.g., OpenAPI) definition file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportDocumentationPartsRequest.Builder

Method Summary

Modifier and Type	Method and Description
SdkBytes	body() Raw byte array representing the to-be-imported documentation parts.
static ImportDocumentationPartsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	failOnWarnings() A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PutMode	mode() A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one.
String	modeAsString() A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one.
String	restApiId() The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportDocumentationPartsRequest.Builder>	serializableBuilderClass()
ImportDocumentationPartsRequest.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

restApiId

public final String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

mode

public final PutMode mode()

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

See Also:

PutMode

modeAsString

public final String modeAsString()

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

If the service returns an enum value that is not available in the current SDK version, mode will return PutMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

A query parameter to indicate whether to overwrite (overwrite) any existing DocumentationParts definition or to merge (merge) the new definition into the existing one. The default value is merge.

See Also:

PutMode

failOnWarnings

public final Boolean failOnWarnings()

A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered. The default value is false.

Returns:

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

body

public final SdkBytes body()

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Returns:

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

toBuilder

public ImportDocumentationPartsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static ImportDocumentationPartsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportDocumentationPartsRequest.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