@Generated(value="software.amazon.awssdk:codegen") public class PutRestApiRequest extends APIGatewayRequest implements ToCopyableBuilder<PutRestApiRequest.Builder,PutRestApiRequest>
A PUT request to update an existing API, with external API definitions specified as the request body.
Modifier and Type | Class and Description |
---|---|
static interface |
PutRestApiRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ByteBuffer |
body()
The PUT request body containing external API definitions.
|
static PutRestApiRequest.Builder |
builder() |
boolean |
equals(Object obj) |
Boolean |
failOnWarnings()
A query parameter to indicate whether to rollback the API update (
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()
The
mode query parameter to specify the update mode. |
String |
modeString()
The
mode query parameter to specify the update mode. |
Map<String,String> |
parameters()
Custom header parameters as part of the request.
|
String |
restApiId()
The string identifier of the associated RestApi.
|
static Class<? extends PutRestApiRequest.Builder> |
serializableBuilderClass() |
PutRestApiRequest.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()
The string identifier of the associated RestApi.
public PutMode mode()
The mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By
default, the update mode 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()
.
mode
query parameter to specify the update mode. Valid values are "merge" and
"overwrite". By default, the update mode is "merge".PutMode
public String modeString()
The mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite". By
default, the update mode 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()
.
mode
query parameter to specify the update mode. Valid values are "merge" and
"overwrite". By default, the update mode is "merge".PutMode
public Boolean failOnWarnings()
A query parameter to indicate whether to rollback the API update (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 Map<String,String> parameters()
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an
imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI command
of
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ignore=documentation
as a parameters
value, as in the AWS
CLI command of
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
.public ByteBuffer body()
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
This method will return a new read-only ByteBuffer
each time it is invoked.
public PutRestApiRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutRestApiRequest.Builder,PutRestApiRequest>
toBuilder
in class APIGatewayRequest
public static PutRestApiRequest.Builder builder()
public static Class<? extends PutRestApiRequest.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.