public static interface GetDocumentationPartsRequest.Builder extends APIGatewayRequest.Builder, CopyableBuilder<GetDocumentationPartsRequest.Builder,GetDocumentationPartsRequest>
Modifier and Type | Method and Description |
---|---|
GetDocumentationPartsRequest.Builder |
limit(Integer limit)
The maximum number of returned results per page.
|
GetDocumentationPartsRequest.Builder |
locationStatus(LocationStatusType locationStatus)
The status of the API documentation parts to retrieve.
|
GetDocumentationPartsRequest.Builder |
locationStatus(String locationStatus)
The status of the API documentation parts to retrieve.
|
GetDocumentationPartsRequest.Builder |
nameQuery(String nameQuery)
The name of API entities of the to-be-retrieved documentation parts.
|
GetDocumentationPartsRequest.Builder |
path(String path)
The path of API entities of the to-be-retrieved documentation parts.
|
GetDocumentationPartsRequest.Builder |
position(String position)
The current pagination position in the paged result set.
|
GetDocumentationPartsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
GetDocumentationPartsRequest.Builder |
restApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
|
GetDocumentationPartsRequest.Builder |
type(DocumentationPartType type)
The type of API entities of the to-be-retrieved documentation parts.
|
GetDocumentationPartsRequest.Builder |
type(String type)
The type of API entities of the to-be-retrieved documentation parts.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
GetDocumentationPartsRequest.Builder restApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
restApiId
- [Required] The string identifier of the associated RestApi.GetDocumentationPartsRequest.Builder type(String type)
The type of API entities of the to-be-retrieved documentation parts.
type
- The type of API entities of the to-be-retrieved documentation parts.DocumentationPartType
,
DocumentationPartType
GetDocumentationPartsRequest.Builder type(DocumentationPartType type)
The type of API entities of the to-be-retrieved documentation parts.
type
- The type of API entities of the to-be-retrieved documentation parts.DocumentationPartType
,
DocumentationPartType
GetDocumentationPartsRequest.Builder nameQuery(String nameQuery)
The name of API entities of the to-be-retrieved documentation parts.
nameQuery
- The name of API entities of the to-be-retrieved documentation parts.GetDocumentationPartsRequest.Builder path(String path)
The path of API entities of the to-be-retrieved documentation parts.
path
- The path of API entities of the to-be-retrieved documentation parts.GetDocumentationPartsRequest.Builder position(String position)
The current pagination position in the paged result set.
position
- The current pagination position in the paged result set.GetDocumentationPartsRequest.Builder limit(Integer limit)
The maximum number of returned results per page.
limit
- The maximum number of returned results per page.GetDocumentationPartsRequest.Builder locationStatus(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.
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.LocationStatusType
,
LocationStatusType
GetDocumentationPartsRequest.Builder locationStatus(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.
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.LocationStatusType
,
LocationStatusType
GetDocumentationPartsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.