Interface GetDocumentationPartsRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<GetDocumentationPartsRequest.Builder,
,GetDocumentationPartsRequest> SdkBuilder<GetDocumentationPartsRequest.Builder,
,GetDocumentationPartsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetDocumentationPartsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe maximum number of returned results per page.locationStatus
(String locationStatus) The status of the API documentation parts to retrieve.locationStatus
(LocationStatusType locationStatus) The status of the API documentation parts to retrieve.The name of API entities of the to-be-retrieved documentation parts.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The path of API entities of the to-be-retrieved documentation parts.The current pagination position in the paged result set.The string identifier of the associated RestApi.The type of API entities of the to-be-retrieved documentation parts.type
(DocumentationPartType type) The type of API entities of the to-be-retrieved documentation parts.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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:
-
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:
-
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.
-
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.
-
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.
-
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.
-
locationStatus
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.- Parameters:
locationStatus
- The status of the API documentation parts to retrieve. Valid values areDOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
locationStatus
The status of the API documentation parts to retrieve. Valid values are
DOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.- Parameters:
locationStatus
- The status of the API documentation parts to retrieve. Valid values areDOCUMENTED
for retrieving DocumentationPart resources with content andUNDOCUMENTED
for DocumentationPart resources without content.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetDocumentationPartsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetDocumentationPartsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-