GetDocumentationPartsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.GetDocumentationPartsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class GetDocumentationPartsRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
```
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetDocumentationPartsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetDocumentationPartsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetDocumentationPartsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`limit()` The maximum number of returned results per page.
`LocationStatusType`	`locationStatus()` The status of the API documentation parts to retrieve.
`String`	`locationStatusAsString()` The status of the API documentation parts to retrieve.
`String`	`nameQuery()` The name of API entities of the to-be-retrieved documentation parts.
`String`	`path()` The path of API entities of the to-be-retrieved documentation parts.
`String`	`position()` The current pagination position in the paged result set.
`String`	`restApiId()` The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDocumentationPartsRequest.Builder>`	`serializableBuilderClass()`
`GetDocumentationPartsRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DocumentationPartType`	`type()` The type of API entities of the to-be-retrieved documentation parts.
`String`	`typeAsString()` The type of API entities of the to-be-retrieved documentation parts.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - restApiId
```
public final String restApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - type
```
public final DocumentationPartType type()
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DocumentationPartType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of API entities of the to-be-retrieved documentation parts.
    
    See Also:
    
    DocumentationPartType
  - typeAsString
```
public final String typeAsString()
```
    The type of API entities of the to-be-retrieved documentation parts.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DocumentationPartType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of API entities of the to-be-retrieved documentation parts.
    
    See Also:
    
    DocumentationPartType
  - nameQuery
```
public final String nameQuery()
```
    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.
  - path
```
public final String path()
```
    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.
  - position
```
public final String position()
```
    The current pagination position in the paged result set.
    
    Returns:
    
    The current pagination position in the paged result set.
  - limit
```
public final Integer limit()
```
    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.
  - locationStatus
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, locationStatus will return LocationStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationStatusAsString().
    
    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
  - locationStatusAsString
```
public final String locationStatusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, locationStatus will return LocationStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationStatusAsString().
    
    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
  - toBuilder
```
public GetDocumentationPartsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static GetDocumentationPartsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDocumentationPartsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetDocumentationPartsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

restApiId

type

typeAsString

nameQuery

path

position

limit

locationStatus

locationStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields