Interface CreateProductApiPageResponse.Builder
- All Superinterfaces:
ApiPortalResponse.Builder,AwsResponse.Builder,Buildable,CopyableBuilder<CreateProductApiPageResponse.Builder,,CreateProductApiPageResponse> SdkBuilder<CreateProductApiPageResponse.Builder,,CreateProductApiPageResponse> SdkPojo,SdkResponse.Builder
- Enclosing class:
CreateProductApiPageResponse
-
Method Summary
Modifier and TypeMethodDescriptionapiId(Consumer<ApiId.Builder> apiId) The API the page documents.The API the page documents.displayContent(Consumer<ApiPageDisplayContentResponse.Builder> displayContent) The content shown on the page.displayContent(ApiPageDisplayContentResponse displayContent) The content shown on the page.productApiPageArn(String productApiPageArn) The ARN of the API page.productApiPageId(String productApiPageId) The identifier of the API page.The status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.The status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.statusException(Consumer<ProductApiPageStatusException.Builder> statusException) Sets the value of the StatusException property for this object.statusException(ProductApiPageStatusException statusException) Sets the value of the StatusException property for this object.Sets the value of the Tags property for this object.tryItState(String tryItState) Whether Try-It is enabled on the page.tryItState(TryItState tryItState) Whether Try-It is enabled on the page.When the resource was last updated.Methods inherited from interface software.amazon.awssdk.services.apiportal.model.ApiPortalResponse.Builder
build, responseMetadata, responseMetadataMethods 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, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
productApiPageId
The identifier of the API page.
- Parameters:
productApiPageId- The identifier of the API page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productApiPageArn
The ARN of the API page.
- Parameters:
productApiPageArn- The ARN of the API page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiId
The API the page documents.
- Parameters:
apiId- The API the page documents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiId
The API the page documents.
This is a convenience method that creates an instance of theApiId.Builderavoiding the need to create one manually viaApiId.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toapiId(ApiId).- Parameters:
apiId- a consumer that will call methods onApiId.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
displayContent
The content shown on the page.
- Parameters:
displayContent- The content shown on the page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayContent
default CreateProductApiPageResponse.Builder displayContent(Consumer<ApiPageDisplayContentResponse.Builder> displayContent) The content shown on the page.
This is a convenience method that creates an instance of theApiPageDisplayContentResponse.Builderavoiding the need to create one manually viaApiPageDisplayContentResponse.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todisplayContent(ApiPageDisplayContentResponse).- Parameters:
displayContent- a consumer that will call methods onApiPageDisplayContentResponse.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tryItState
Whether Try-It is enabled on the page.
- Parameters:
tryItState- Whether Try-It is enabled on the page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tryItState
Whether Try-It is enabled on the page.
- Parameters:
tryItState- Whether Try-It is enabled on the page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
updatedAt
When the resource was last updated.
- Parameters:
updatedAt- When the resource was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.- Parameters:
status- The status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.- Parameters:
status- The status of the page content:IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusException
Sets the value of the StatusException property for this object.- Parameters:
statusException- The new value for the StatusException property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statusException
default CreateProductApiPageResponse.Builder statusException(Consumer<ProductApiPageStatusException.Builder> statusException) Sets the value of the StatusException property for this object. This is a convenience method that creates an instance of theProductApiPageStatusException.Builderavoiding the need to create one manually viaProductApiPageStatusException.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tostatusException(ProductApiPageStatusException).- Parameters:
statusException- a consumer that will call methods onProductApiPageStatusException.Builder- 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.
-