@Generated(value="software.amazon.awssdk:codegen") public 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).
Modifier and Type | Class and Description |
---|---|
static interface |
GetDocumentationPartsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetDocumentationPartsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<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() |
Integer |
limit()
The maximum number of returned results per page.
|
LocationStatusType |
locationStatus()
The status of the API documentation parts to retrieve.
|
String |
locationStatusString()
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()
[Required] The string identifier of the associated RestApi.
|
static Class<? extends GetDocumentationPartsRequest.Builder> |
serializableBuilderClass() |
GetDocumentationPartsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
DocumentationPartType |
type()
The type of API entities of the to-be-retrieved documentation parts.
|
String |
typeString()
The type of API entities of the to-be-retrieved documentation parts.
|
requestOverrideConfig
copy
public String restApiId()
[Required] The string identifier of the associated RestApi.
public 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
typeString()
.
DocumentationPartType
public String typeString()
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
typeString()
.
DocumentationPartType
public String nameQuery()
The name of API entities of the to-be-retrieved documentation parts.
public String path()
The path of API entities of the to-be-retrieved documentation parts.
public String position()
The current pagination position in the paged result set.
public Integer limit()
The maximum number of returned results per page.
public 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 locationStatusString()
.
DOCUMENTED
for
retrieving DocumentationPart resources with content and UNDOCUMENTED
for
DocumentationPart resources without content.LocationStatusType
public String locationStatusString()
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 locationStatusString()
.
DOCUMENTED
for
retrieving DocumentationPart resources with content and UNDOCUMENTED
for
DocumentationPart resources without content.LocationStatusType
public GetDocumentationPartsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
toBuilder
in class APIGatewayRequest
public static GetDocumentationPartsRequest.Builder builder()
public static Class<? extends GetDocumentationPartsRequest.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.