Interface CreateProductApiPageRequest.Builder
- All Superinterfaces:
ApiPortalRequest.Builder,AwsRequest.Builder,Buildable,CopyableBuilder<CreateProductApiPageRequest.Builder,,CreateProductApiPageRequest> SdkBuilder<CreateProductApiPageRequest.Builder,,CreateProductApiPageRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateProductApiPageRequest
@Mutable
@NotThreadSafe
public static interface CreateProductApiPageRequest.Builder
extends ApiPortalRequest.Builder, SdkPojo, CopyableBuilder<CreateProductApiPageRequest.Builder,CreateProductApiPageRequest>
-
Method Summary
Modifier and TypeMethodDescriptiondisplayContent(Consumer<ApiPageDisplayContent.Builder> displayContent) Sets the value of the DisplayContent property for this object.displayContent(ApiPageDisplayContent displayContent) Sets the value of the DisplayContent property for this object.managedApiId(String managedApiId) The Managed API this page documents.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The identifier of the product.Sets the value of the Tags property for this object.tryItState(String tryItState) Whether readers can call the API from the page with Try-It.tryItState(TryItState tryItState) Whether readers can call the API from the page with Try-It.Methods inherited from interface software.amazon.awssdk.services.apiportal.model.ApiPortalRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
productId
The identifier of the product.
- Parameters:
productId- The identifier of the product.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
managedApiId
The Managed API this page documents. It must already be associated with the product, and the page's API identifier is taken from the Managed API rather than supplied by the caller.
- Parameters:
managedApiId- The Managed API this page documents. It must already be associated with the product, and the page's API identifier is taken from the Managed API rather than supplied by the caller.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayContent
Sets the value of the DisplayContent property for this object.- Parameters:
displayContent- The new value for the DisplayContent property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayContent
default CreateProductApiPageRequest.Builder displayContent(Consumer<ApiPageDisplayContent.Builder> displayContent) Sets the value of the DisplayContent property for this object. This is a convenience method that creates an instance of theApiPageDisplayContent.Builderavoiding the need to create one manually viaApiPageDisplayContent.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todisplayContent(ApiPageDisplayContent).- Parameters:
displayContent- a consumer that will call methods onApiPageDisplayContent.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tryItState
Whether readers can call the API from the page with Try-It. Defaults to
DISABLED. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.- Parameters:
tryItState- Whether readers can call the API from the page with Try-It. Defaults toDISABLED. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tryItState
Whether readers can call the API from the page with Try-It. Defaults to
DISABLED. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.- Parameters:
tryItState- Whether readers can call the API from the page with Try-It. Defaults toDISABLED. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateProductApiPageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateProductApiPageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-