@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ImportDocumentationPartsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Import documentation parts from an external (e.g., OpenAPI) definition file.
NOOP
Constructor and Description |
---|
ImportDocumentationPartsRequest() |
Modifier and Type | Method and Description |
---|---|
ImportDocumentationPartsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
ByteBuffer |
getBody()
Raw byte array representing the to-be-imported documentation parts.
|
Boolean |
getFailOnWarnings()
A query parameter to specify whether to rollback the documentation importation (
true ) or not (
false ) when a warning is encountered. |
String |
getMode()
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 |
getRestApiId()
The string identifier of the associated RestApi.
|
int |
hashCode() |
Boolean |
isFailOnWarnings()
A query parameter to specify whether to rollback the documentation importation (
true ) or not (
false ) when a warning is encountered. |
void |
setBody(ByteBuffer body)
Raw byte array representing the to-be-imported documentation parts.
|
void |
setFailOnWarnings(Boolean failOnWarnings)
A query parameter to specify whether to rollback the documentation importation (
true ) or not (
false ) when a warning is encountered. |
void |
setMode(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. |
void |
setMode(String 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. |
void |
setRestApiId(String restApiId)
The string identifier of the associated RestApi.
|
String |
toString()
Returns a string representation of this object.
|
ImportDocumentationPartsRequest |
withBody(ByteBuffer body)
Raw byte array representing the to-be-imported documentation parts.
|
ImportDocumentationPartsRequest |
withFailOnWarnings(Boolean failOnWarnings)
A query parameter to specify whether to rollback the documentation importation (
true ) or not (
false ) when a warning is encountered. |
ImportDocumentationPartsRequest |
withMode(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. |
ImportDocumentationPartsRequest |
withMode(String 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. |
ImportDocumentationPartsRequest |
withRestApiId(String restApiId)
The string identifier of the associated RestApi.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setRestApiId(String restApiId)
The string identifier of the associated RestApi.
restApiId
- The string identifier of the associated RestApi.public String getRestApiId()
The string identifier of the associated RestApi.
public ImportDocumentationPartsRequest withRestApiId(String restApiId)
The string identifier of the associated RestApi.
restApiId
- The string identifier of the associated RestApi.public void setMode(String 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
.
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
.PutMode
public String getMode()
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
.
overwrite
) any existing
DocumentationParts definition or to merge (merge
) the new definition into the existing one.
The default value is merge
.PutMode
public ImportDocumentationPartsRequest withMode(String 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
.
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
.PutMode
public void setMode(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
.
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
.PutMode
public ImportDocumentationPartsRequest withMode(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
.
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
.PutMode
public void setFailOnWarnings(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
.
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
.public Boolean getFailOnWarnings()
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 ImportDocumentationPartsRequest withFailOnWarnings(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
.
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
.public Boolean isFailOnWarnings()
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 void setBody(ByteBuffer body)
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
body
- Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this
is a JSON object.public ByteBuffer getBody()
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
ByteBuffer
s are stateful. Calling their get
methods changes their position
. We recommend
using ByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independent
position
, and calling get
methods on this rather than directly on the returned ByteBuffer
.
Doing so will ensure that anyone else using the ByteBuffer
will not be affected by changes to the
position
.
public ImportDocumentationPartsRequest withBody(ByteBuffer body)
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
body
- Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this
is a JSON object.public String toString()
toString
in class Object
Object.toString()
public ImportDocumentationPartsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()