ImportDocumentationPartsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.ImportDocumentationPartsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@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., Swagger) definition file.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ImportDocumentationPartsRequest()

Constructors
Constructor and Description
`ImportDocumentationPartsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` [Required] 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()` [Required] 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)` [Required] 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)` [Required] The string identifier of the associated RestApi.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ImportDocumentationPartsRequest`	`withBody(ByteBuffer body)` [Required] 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)` [Required] The string identifier of the associated RestApi.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImportDocumentationPartsRequest
```
public ImportDocumentationPartsRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    [Required] The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - [Required] The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - withRestApiId
```
public ImportDocumentationPartsRequest withRestApiId(String restApiId)
```
    [Required] The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    PutMode
  - getMode
```
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.
    
    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
  - withMode
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PutMode
  - setMode
```
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.
    
    Parameters:
    
    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.
    
    See Also:
    
    PutMode
  - withMode
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PutMode
  - setFailOnWarnings
```
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.
    
    Parameters:
    
    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.
  - getFailOnWarnings
```
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.
    
    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.
  - withFailOnWarnings
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isFailOnWarnings
```
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.
    
    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.
  - setBody
```
public void setBody(ByteBuffer body)
```
    [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger 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.
    
    Parameters:
    
    body - [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
  - getBody
```
public ByteBuffer getBody()
```
    [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
    
    ByteBuffers 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.
    
    Returns:
    
    [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
  - withBody
```
public ImportDocumentationPartsRequest withBody(ByteBuffer body)
```
    [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger 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.
    
    Parameters:
    
    body - [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ImportDocumentationPartsRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class ImportDocumentationPartsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ImportDocumentationPartsRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setMode

getMode

withMode

setMode

withMode

setFailOnWarnings

getFailOnWarnings

withFailOnWarnings

isFailOnWarnings

setBody

getBody

withBody

toString

equals

hashCode

clone