@Generated(value="software.amazon.awssdk:codegen") public class ImportDocumentationPartsRequest extends APIGatewayRequest implements ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>
Import documentation parts from an external (e.g., Swagger) definition file.
Modifier and Type | Class and Description |
---|---|
static interface |
ImportDocumentationPartsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ByteBuffer |
body()
[Required] Raw byte array representing the to-be-imported documentation parts.
|
static ImportDocumentationPartsRequest.Builder |
builder() |
boolean |
equals(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)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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 |
modeString()
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()
[Required] The string identifier of the associated RestApi.
|
static Class<? extends ImportDocumentationPartsRequest.Builder> |
serializableBuilderClass() |
ImportDocumentationPartsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String restApiId()
[Required] The string identifier of the associated RestApi.
public 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
modeString()
.
OVERWRITE
) any existing
DocumentationParts definition or to merge (MERGE
) the new definition into the
existing one. The default value is MERGE
.PutMode
public String modeString()
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
modeString()
.
OVERWRITE
) any existing
DocumentationParts definition or to merge (MERGE
) the new definition into the
existing one. The default value is MERGE
.PutMode
public 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
.
true
) or not
(false
) when a warning is encountered. The default value is false
.public ByteBuffer body()
[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
This method will return a new read-only ByteBuffer
each time it is invoked.
public ImportDocumentationPartsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>
toBuilder
in class APIGatewayRequest
public static ImportDocumentationPartsRequest.Builder builder()
public static Class<? extends ImportDocumentationPartsRequest.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.