GetDocumentationPartsRequest (AWS SDK for Java

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDocumentationPartsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

GetDocumentationPartsRequest()

Constructors
Constructor and Description
`GetDocumentationPartsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetDocumentationPartsRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Integer`	`getLimit()` The maximum number of returned results per page.
`String`	`getLocationStatus()` The status of the API documentation parts to retrieve.
`String`	`getNameQuery()` The name of API entities of the to-be-retrieved documentation parts.
`String`	`getPath()` The path of API entities of the to-be-retrieved documentation parts.
`String`	`getPosition()` The current pagination position in the paged result set.
`String`	`getRestApiId()` The string identifier of the associated RestApi.
`String`	`getType()` The type of API entities of the to-be-retrieved documentation parts.
`int`	`hashCode()`
`void`	`setLimit(Integer limit)` The maximum number of returned results per page.
`void`	`setLocationStatus(LocationStatusType locationStatus)` The status of the API documentation parts to retrieve.
`void`	`setLocationStatus(String locationStatus)` The status of the API documentation parts to retrieve.
`void`	`setNameQuery(String nameQuery)` The name of API entities of the to-be-retrieved documentation parts.
`void`	`setPath(String path)` The path of API entities of the to-be-retrieved documentation parts.
`void`	`setPosition(String position)` The current pagination position in the paged result set.
`void`	`setRestApiId(String restApiId)` The string identifier of the associated RestApi.
`void`	`setType(DocumentationPartType type)` The type of API entities of the to-be-retrieved documentation parts.
`void`	`setType(String type)` The type of API entities of the to-be-retrieved documentation parts.
`String`	`toString()` Returns a string representation of this object.
`GetDocumentationPartsRequest`	`withLimit(Integer limit)` The maximum number of returned results per page.
`GetDocumentationPartsRequest`	`withLocationStatus(LocationStatusType locationStatus)` The status of the API documentation parts to retrieve.
`GetDocumentationPartsRequest`	`withLocationStatus(String locationStatus)` The status of the API documentation parts to retrieve.
`GetDocumentationPartsRequest`	`withNameQuery(String nameQuery)` The name of API entities of the to-be-retrieved documentation parts.
`GetDocumentationPartsRequest`	`withPath(String path)` The path of API entities of the to-be-retrieved documentation parts.
`GetDocumentationPartsRequest`	`withPosition(String position)` The current pagination position in the paged result set.
`GetDocumentationPartsRequest`	`withRestApiId(String restApiId)` The string identifier of the associated RestApi.
`GetDocumentationPartsRequest`	`withType(DocumentationPartType type)` The type of API entities of the to-be-retrieved documentation parts.
`GetDocumentationPartsRequest`	`withType(String type)` The type of API entities of the to-be-retrieved documentation parts.

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

- Constructor Detail
  - GetDocumentationPartsRequest
```
public GetDocumentationPartsRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - withRestApiId
```
public GetDocumentationPartsRequest withRestApiId(String restApiId)
```
    The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - The string identifier of the associated RestApi.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    type - The type of API entities of the to-be-retrieved documentation parts.
    
    See Also:
    
    DocumentationPartType
  - getType
```
public String getType()
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    The type of API entities of the to-be-retrieved documentation parts.
    
    See Also:
    
    DocumentationPartType
  - withType
```
public GetDocumentationPartsRequest withType(String type)
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    type - The type of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentationPartType
  - setType
```
public void setType(DocumentationPartType type)
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    type - The type of API entities of the to-be-retrieved documentation parts.
    
    See Also:
    
    DocumentationPartType
  - withType
```
public GetDocumentationPartsRequest withType(DocumentationPartType type)
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    type - The type of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentationPartType
  - setNameQuery
```
public void setNameQuery(String nameQuery)
```
    The name of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    nameQuery - The name of API entities of the to-be-retrieved documentation parts.
  - getNameQuery
```
public String getNameQuery()
```
    The name of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    The name of API entities of the to-be-retrieved documentation parts.
  - withNameQuery
```
public GetDocumentationPartsRequest withNameQuery(String nameQuery)
```
    The name of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    nameQuery - The name of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(String path)
```
    The path of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    path - The path of API entities of the to-be-retrieved documentation parts.
  - getPath
```
public String getPath()
```
    The path of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    The path of API entities of the to-be-retrieved documentation parts.
  - withPath
```
public GetDocumentationPartsRequest withPath(String path)
```
    The path of API entities of the to-be-retrieved documentation parts.
    
    Parameters:
    
    path - The path of API entities of the to-be-retrieved documentation parts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosition
```
public void setPosition(String position)
```
    The current pagination position in the paged result set.
    
    Parameters:
    
    position - The current pagination position in the paged result set.
  - getPosition
```
public String getPosition()
```
    The current pagination position in the paged result set.
    
    Returns:
    
    The current pagination position in the paged result set.
  - withPosition
```
public GetDocumentationPartsRequest withPosition(String position)
```
    The current pagination position in the paged result set.
    
    Parameters:
    
    position - The current pagination position in the paged result set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLimit
```
public void setLimit(Integer limit)
```
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Parameters:
    
    limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
  - getLimit
```
public Integer getLimit()
```
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Returns:
    
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
  - withLimit
```
public GetDocumentationPartsRequest withLimit(Integer limit)
```
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Parameters:
    
    limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocationStatus
```
public void setLocationStatus(String locationStatus)
```
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Parameters:
    
    locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    See Also:
    
    LocationStatusType
  - getLocationStatus
```
public String getLocationStatus()
```
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Returns:
    
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    See Also:
    
    LocationStatusType
  - withLocationStatus
```
public GetDocumentationPartsRequest withLocationStatus(String locationStatus)
```
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Parameters:
    
    locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationStatusType
  - setLocationStatus
```
public void setLocationStatus(LocationStatusType locationStatus)
```
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Parameters:
    
    locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    See Also:
    
    LocationStatusType
  - withLocationStatus
```
public GetDocumentationPartsRequest withLocationStatus(LocationStatusType locationStatus)
```
    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Parameters:
    
    locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LocationStatusType
  - toString
```
public 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
    
    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 GetDocumentationPartsRequest 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 GetDocumentationPartsRequest

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

GetDocumentationPartsRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setType

getType

withType

setType

withType

setNameQuery

getNameQuery

withNameQuery

setPath

getPath

withPath

setPosition

getPosition

withPosition

setLimit

getLimit

withLimit

setLocationStatus

getLocationStatus

withLocationStatus

setLocationStatus

withLocationStatus

toString

equals

hashCode

clone