Interface ApiPortalAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
API Portal discovers the APIs running in your AWS accounts and organization, lets you manage them as Managed APIs, and publishes their documentation to developer portals.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateManagedApis(Consumer<AssociateManagedApisRequest.Builder> associateManagedApisRequest) Associate one or more Managed APIs with a product.associateManagedApis(AssociateManagedApisRequest associateManagedApisRequest) Associate one or more Managed APIs with a product.static ApiPortalAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aApiPortalAsyncClient.static ApiPortalAsyncClientcreate()Create aApiPortalAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createManagedApi(Consumer<CreateManagedApiRequest.Builder> createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.createManagedApi(CreateManagedApiRequest createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.default CompletableFuture<CreatePortalResponse> createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) Creates a portal that publishes documentation for the products it includes.default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest) Creates a portal that publishes documentation for the products it includes.createPortalPreview(Consumer<CreatePortalPreviewRequest.Builder> createPortalPreviewRequest) Starts building a preview of the portal's current content.createPortalPreview(CreatePortalPreviewRequest createPortalPreviewRequest) Starts building a preview of the portal's current content.default CompletableFuture<CreateProductResponse> createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) Creates a product.default CompletableFuture<CreateProductResponse> createProduct(CreateProductRequest createProductRequest) Creates a product.createProductApiPage(Consumer<CreateProductApiPageRequest.Builder> createProductApiPageRequest) Creates an API page that documents a Managed API in a product.createProductApiPage(CreateProductApiPageRequest createProductApiPageRequest) Creates an API page that documents a Managed API in a product.createProductPage(Consumer<CreateProductPageRequest.Builder> createProductPageRequest) Creates a product page with free-form documentation.createProductPage(CreateProductPageRequest createProductPageRequest) Creates a product page with free-form documentation.deleteDiscoveryConfiguration(Consumer<DeleteDiscoveryConfigurationRequest.Builder> deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.deleteDiscoveryConfiguration(DeleteDiscoveryConfigurationRequest deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.deleteManagedApi(Consumer<DeleteManagedApiRequest.Builder> deleteManagedApiRequest) Deletes a Managed API.deleteManagedApi(DeleteManagedApiRequest deleteManagedApiRequest) Deletes a Managed API.deleteOrganizationDiscoveryConfiguration(Consumer<DeleteOrganizationDiscoveryConfigurationRequest.Builder> deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization.deleteOrganizationDiscoveryConfiguration(DeleteOrganizationDiscoveryConfigurationRequest deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization.default CompletableFuture<DeletePortalResponse> deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) Deletes a portal.default CompletableFuture<DeletePortalResponse> deletePortal(DeletePortalRequest deletePortalRequest) Deletes a portal.default CompletableFuture<DeleteProductResponse> deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) Deletes a product.default CompletableFuture<DeleteProductResponse> deleteProduct(DeleteProductRequest deleteProductRequest) Deletes a product.deleteProductApiPage(Consumer<DeleteProductApiPageRequest.Builder> deleteProductApiPageRequest) Deletes an API page.deleteProductApiPage(DeleteProductApiPageRequest deleteProductApiPageRequest) Deletes an API page.deleteProductPage(Consumer<DeleteProductPageRequest.Builder> deleteProductPageRequest) Deletes a product page.deleteProductPage(DeleteProductPageRequest deleteProductPageRequest) Deletes a product page.deleteProductSharingPolicy(Consumer<DeleteProductSharingPolicyRequest.Builder> deleteProductSharingPolicyRequest) Deletes the sharing policy of a product.deleteProductSharingPolicy(DeleteProductSharingPolicyRequest deleteProductSharingPolicyRequest) Deletes the sharing policy of a product.disassociateManagedApis(Consumer<DisassociateManagedApisRequest.Builder> disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product.disassociateManagedApis(DisassociateManagedApisRequest disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product.getApiInventoryItem(Consumer<GetApiInventoryItemRequest.Builder> getApiInventoryItemRequest) Gets full details of a single API inventory item.getApiInventoryItem(GetApiInventoryItemRequest getApiInventoryItemRequest) Gets full details of a single API inventory item.getDiscoveryConfiguration(Consumer<GetDiscoveryConfigurationRequest.Builder> getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.getDiscoveryConfiguration(GetDiscoveryConfigurationRequest getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.default CompletableFuture<GetManagedApiResponse> getManagedApi(Consumer<GetManagedApiRequest.Builder> getManagedApiRequest) Returns a Managed API, including its security posture findings.default CompletableFuture<GetManagedApiResponse> getManagedApi(GetManagedApiRequest getManagedApiRequest) Returns a Managed API, including its security posture findings.getOrganizationDiscoveryConfiguration(Consumer<GetOrganizationDiscoveryConfigurationRequest.Builder> getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration.getOrganizationDiscoveryConfiguration(GetOrganizationDiscoveryConfigurationRequest getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration.default CompletableFuture<GetPortalResponse> getPortal(Consumer<GetPortalRequest.Builder> getPortalRequest) Returns the configuration, publish status, and preview status of a portal.default CompletableFuture<GetPortalResponse> getPortal(GetPortalRequest getPortalRequest) Returns the configuration, publish status, and preview status of a portal.default CompletableFuture<GetProductResponse> getProduct(Consumer<GetProductRequest.Builder> getProductRequest) Returns a product.default CompletableFuture<GetProductResponse> getProduct(GetProductRequest getProductRequest) Returns a product.getProductApiPage(Consumer<GetProductApiPageRequest.Builder> getProductApiPageRequest) Returns an API page, including its body.getProductApiPage(GetProductApiPageRequest getProductApiPageRequest) Returns an API page, including its body.default CompletableFuture<GetProductPageResponse> getProductPage(Consumer<GetProductPageRequest.Builder> getProductPageRequest) Returns a product page, including its body.default CompletableFuture<GetProductPageResponse> getProductPage(GetProductPageRequest getProductPageRequest) Returns a product page, including its body.getProductSharingPolicy(Consumer<GetProductSharingPolicyRequest.Builder> getProductSharingPolicyRequest) Returns the sharing policy of a product.getProductSharingPolicy(GetProductSharingPolicyRequest getProductSharingPolicyRequest) Returns the sharing policy of a product.listApiInventoryItems(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.listApiInventoryItems(ListApiInventoryItemsRequest listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.default ListApiInventoryItemsPublisherlistApiInventoryItemsPaginator(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) This is a variant oflistApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.default ListApiInventoryItemsPublisherlistApiInventoryItemsPaginator(ListApiInventoryItemsRequest listApiInventoryItemsRequest) This is a variant oflistApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.listDiscoveryStatuses(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) Lists discovery statuses for services.listDiscoveryStatuses(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) Lists discovery statuses for services.default ListDiscoveryStatusesPublisherlistDiscoveryStatusesPaginator(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) This is a variant oflistDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.default ListDiscoveryStatusesPublisherlistDiscoveryStatusesPaginator(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) This is a variant oflistDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.listManagedApiEvents(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first.listManagedApiEvents(ListManagedApiEventsRequest listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first.default ListManagedApiEventsPublisherlistManagedApiEventsPaginator(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) This is a variant oflistManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.default ListManagedApiEventsPublisherlistManagedApiEventsPaginator(ListManagedApiEventsRequest listManagedApiEventsRequest) This is a variant oflistManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.default CompletableFuture<ListManagedApisResponse> listManagedApis(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) Lists the Managed APIs in your account.default CompletableFuture<ListManagedApisResponse> listManagedApis(ListManagedApisRequest listManagedApisRequest) Lists the Managed APIs in your account.default ListManagedApisPublisherlistManagedApisPaginator(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) This is a variant oflistManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.default ListManagedApisPublisherlistManagedApisPaginator(ListManagedApisRequest listManagedApisRequest) This is a variant oflistManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.default CompletableFuture<ListPortalsResponse> listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) Lists the portals in your account.default CompletableFuture<ListPortalsResponse> listPortals(ListPortalsRequest listPortalsRequest) Lists the portals in your account.default ListPortalsPublisherlistPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.default ListPortalsPublisherlistPortalsPaginator(ListPortalsRequest listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.listProductApiPages(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) Lists the API pages in a product.listProductApiPages(ListProductApiPagesRequest listProductApiPagesRequest) Lists the API pages in a product.default ListProductApiPagesPublisherlistProductApiPagesPaginator(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) This is a variant oflistProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.default ListProductApiPagesPublisherlistProductApiPagesPaginator(ListProductApiPagesRequest listProductApiPagesRequest) This is a variant oflistProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.listProductPages(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) Lists the product pages in a product.listProductPages(ListProductPagesRequest listProductPagesRequest) Lists the product pages in a product.default ListProductPagesPublisherlistProductPagesPaginator(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) This is a variant oflistProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.default ListProductPagesPublisherlistProductPagesPaginator(ListProductPagesRequest listProductPagesRequest) This is a variant oflistProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.default CompletableFuture<ListProductsResponse> listProducts(Consumer<ListProductsRequest.Builder> listProductsRequest) Lists products you own, products shared with you, or both.default CompletableFuture<ListProductsResponse> listProducts(ListProductsRequest listProductsRequest) Lists products you own, products shared with you, or both.default ListProductsPublisherlistProductsPaginator(Consumer<ListProductsRequest.Builder> listProductsRequest) This is a variant oflistProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.default ListProductsPublisherlistProductsPaginator(ListProductsRequest listProductsRequest) This is a variant oflistProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for an API Portal resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an API Portal resource.putDiscoveryConfiguration(Consumer<PutDiscoveryConfigurationRequest.Builder> putDiscoveryConfigurationRequest) Creates or updates the discovery configurationputDiscoveryConfiguration(PutDiscoveryConfigurationRequest putDiscoveryConfigurationRequest) Creates or updates the discovery configurationputOrganizationDiscoveryConfiguration(Consumer<PutOrganizationDiscoveryConfigurationRequest.Builder> putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration.putOrganizationDiscoveryConfiguration(PutOrganizationDiscoveryConfigurationRequest putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration.putProductSharingPolicy(Consumer<PutProductSharingPolicyRequest.Builder> putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product.putProductSharingPolicy(PutProductSharingPolicyRequest putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<StartDiscoveryResponse> startDiscovery(Consumer<StartDiscoveryRequest.Builder> startDiscoveryRequest) Starts the API discovery process.default CompletableFuture<StartDiscoveryResponse> startDiscovery(StartDiscoveryRequest startDiscoveryRequest) Starts the API discovery process.default CompletableFuture<StopDiscoveryResponse> stopDiscovery(Consumer<StopDiscoveryRequest.Builder> stopDiscoveryRequest) Stops the running API discovery process.default CompletableFuture<StopDiscoveryResponse> stopDiscovery(StopDiscoveryRequest stopDiscoveryRequest) Stops the running API discovery process.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags on an API Portal resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds or updates tags on an API Portal resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an API Portal resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an API Portal resource.default CompletableFuture<UpdatePortalResponse> updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) Updates a portal.default CompletableFuture<UpdatePortalResponse> updatePortal(UpdatePortalRequest updatePortalRequest) Updates a portal.updatePortalPublishStatus(Consumer<UpdatePortalPublishStatusRequest.Builder> updatePortalPublishStatusRequest) Publishes or disables a portal.updatePortalPublishStatus(UpdatePortalPublishStatusRequest updatePortalPublishStatusRequest) Publishes or disables a portal.default CompletableFuture<UpdateProductResponse> updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) Updates a product.default CompletableFuture<UpdateProductResponse> updateProduct(UpdateProductRequest updateProductRequest) Updates a product.updateProductApiPage(Consumer<UpdateProductApiPageRequest.Builder> updateProductApiPageRequest) Updates an API page.updateProductApiPage(UpdateProductApiPageRequest updateProductApiPageRequest) Updates an API page.updateProductPage(Consumer<UpdateProductPageRequest.Builder> updateProductPageRequest) Updates a product page.updateProductPage(UpdateProductPageRequest updateProductPageRequest) Updates a product page.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
associateManagedApis
default CompletableFuture<AssociateManagedApisResponse> associateManagedApis(AssociateManagedApisRequest associateManagedApisRequest) Associate one or more Managed APIs with a product. Best-effort — IDs that fail are returned in
AssociateManagedApisResponse.failedItems; IDs that succeed are omitted. Associating an already-associated Managed API is a no-op (not reported as failure).- Parameters:
associateManagedApisRequest-- Returns:
- A Java Future containing the result of the AssociateManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateManagedApis
default CompletableFuture<AssociateManagedApisResponse> associateManagedApis(Consumer<AssociateManagedApisRequest.Builder> associateManagedApisRequest) Associate one or more Managed APIs with a product. Best-effort — IDs that fail are returned in
AssociateManagedApisResponse.failedItems; IDs that succeed are omitted. Associating an already-associated Managed API is a no-op (not reported as failure).
This is a convenience which creates an instance of the
AssociateManagedApisRequest.Builderavoiding the need to create one manually viaAssociateManagedApisRequest.builder()- Parameters:
associateManagedApisRequest- AConsumerthat will call methods onAssociateManagedApisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createManagedApi
default CompletableFuture<CreateManagedApiResponse> createManagedApi(CreateManagedApiRequest createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.
- Parameters:
createManagedApiRequest-- Returns:
- A Java Future containing the result of the CreateManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createManagedApi
default CompletableFuture<CreateManagedApiResponse> createManagedApi(Consumer<CreateManagedApiRequest.Builder> createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.
This is a convenience which creates an instance of the
CreateManagedApiRequest.Builderavoiding the need to create one manually viaCreateManagedApiRequest.builder()- Parameters:
createManagedApiRequest- AConsumerthat will call methods onCreateManagedApiRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPortal
default CompletableFuture<CreatePortalResponse> createPortal(CreatePortalRequest createPortalRequest) Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.
- Parameters:
createPortalRequest-- Returns:
- A Java Future containing the result of the CreatePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPortal
default CompletableFuture<CreatePortalResponse> createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.
This is a convenience which creates an instance of the
CreatePortalRequest.Builderavoiding the need to create one manually viaCreatePortalRequest.builder()- Parameters:
createPortalRequest- AConsumerthat will call methods onCreatePortalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreatePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPortalPreview
default CompletableFuture<CreatePortalPreviewResponse> createPortalPreview(CreatePortalPreviewRequest createPortalPreviewRequest) Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.
- Parameters:
createPortalPreviewRequest-- Returns:
- A Java Future containing the result of the CreatePortalPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPortalPreview
default CompletableFuture<CreatePortalPreviewResponse> createPortalPreview(Consumer<CreatePortalPreviewRequest.Builder> createPortalPreviewRequest) Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.
This is a convenience which creates an instance of the
CreatePortalPreviewRequest.Builderavoiding the need to create one manually viaCreatePortalPreviewRequest.builder()- Parameters:
createPortalPreviewRequest- AConsumerthat will call methods onCreatePortalPreviewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreatePortalPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProduct
default CompletableFuture<CreateProductResponse> createProduct(CreateProductRequest createProductRequest) Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.
- Parameters:
createProductRequest-- Returns:
- A Java Future containing the result of the CreateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProduct
default CompletableFuture<CreateProductResponse> createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.
This is a convenience which creates an instance of the
CreateProductRequest.Builderavoiding the need to create one manually viaCreateProductRequest.builder()- Parameters:
createProductRequest- AConsumerthat will call methods onCreateProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProductApiPage
default CompletableFuture<CreateProductApiPageResponse> createProductApiPage(CreateProductApiPageRequest createProductApiPageRequest) Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use
statusto track it.- Parameters:
createProductApiPageRequest-- Returns:
- A Java Future containing the result of the CreateProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProductApiPage
default CompletableFuture<CreateProductApiPageResponse> createProductApiPage(Consumer<CreateProductApiPageRequest.Builder> createProductApiPageRequest) Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use
statusto track it.
This is a convenience which creates an instance of the
CreateProductApiPageRequest.Builderavoiding the need to create one manually viaCreateProductApiPageRequest.builder()- Parameters:
createProductApiPageRequest- AConsumerthat will call methods onCreateProductApiPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProductPage
default CompletableFuture<CreateProductPageResponse> createProductPage(CreateProductPageRequest createProductPageRequest) Creates a product page with free-form documentation. A product can have up to 40 pages.
- Parameters:
createProductPageRequest-- Returns:
- A Java Future containing the result of the CreateProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProductPage
default CompletableFuture<CreateProductPageResponse> createProductPage(Consumer<CreateProductPageRequest.Builder> createProductPageRequest) Creates a product page with free-form documentation. A product can have up to 40 pages.
This is a convenience which creates an instance of the
CreateProductPageRequest.Builderavoiding the need to create one manually viaCreateProductPageRequest.builder()- Parameters:
createProductPageRequest- AConsumerthat will call methods onCreateProductPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDiscoveryConfiguration
default CompletableFuture<DeleteDiscoveryConfigurationResponse> deleteDiscoveryConfiguration(DeleteDiscoveryConfigurationRequest deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.
- Parameters:
deleteDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the DeleteDiscoveryConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDiscoveryConfiguration
default CompletableFuture<DeleteDiscoveryConfigurationResponse> deleteDiscoveryConfiguration(Consumer<DeleteDiscoveryConfigurationRequest.Builder> deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.
This is a convenience which creates an instance of the
DeleteDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaDeleteDiscoveryConfigurationRequest.builder()- Parameters:
deleteDiscoveryConfigurationRequest- AConsumerthat will call methods onDeleteDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDiscoveryConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteManagedApi
default CompletableFuture<DeleteManagedApiResponse> deleteManagedApi(DeleteManagedApiRequest deleteManagedApiRequest) Deletes a Managed API.
- Parameters:
deleteManagedApiRequest-- Returns:
- A Java Future containing the result of the DeleteManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteManagedApi
default CompletableFuture<DeleteManagedApiResponse> deleteManagedApi(Consumer<DeleteManagedApiRequest.Builder> deleteManagedApiRequest) Deletes a Managed API.
This is a convenience which creates an instance of the
DeleteManagedApiRequest.Builderavoiding the need to create one manually viaDeleteManagedApiRequest.builder()- Parameters:
deleteManagedApiRequest- AConsumerthat will call methods onDeleteManagedApiRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganizationDiscoveryConfiguration
default CompletableFuture<DeleteOrganizationDiscoveryConfigurationResponse> deleteOrganizationDiscoveryConfiguration(DeleteOrganizationDiscoveryConfigurationRequest deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.
- Parameters:
deleteOrganizationDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the DeleteOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganizationDiscoveryConfiguration
default CompletableFuture<DeleteOrganizationDiscoveryConfigurationResponse> deleteOrganizationDiscoveryConfiguration(Consumer<DeleteOrganizationDiscoveryConfigurationRequest.Builder> deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.
This is a convenience which creates an instance of the
DeleteOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaDeleteOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
deleteOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onDeleteOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePortal
default CompletableFuture<DeletePortalResponse> deletePortal(DeletePortalRequest deletePortalRequest) Deletes a portal.
- Parameters:
deletePortalRequest-- Returns:
- A Java Future containing the result of the DeletePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePortal
default CompletableFuture<DeletePortalResponse> deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) Deletes a portal.
This is a convenience which creates an instance of the
DeletePortalRequest.Builderavoiding the need to create one manually viaDeletePortalRequest.builder()- Parameters:
deletePortalRequest- AConsumerthat will call methods onDeletePortalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeletePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProduct
default CompletableFuture<DeleteProductResponse> deleteProduct(DeleteProductRequest deleteProductRequest) Deletes a product.
- Parameters:
deleteProductRequest-- Returns:
- A Java Future containing the result of the DeleteProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProduct
default CompletableFuture<DeleteProductResponse> deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) Deletes a product.
This is a convenience which creates an instance of the
DeleteProductRequest.Builderavoiding the need to create one manually viaDeleteProductRequest.builder()- Parameters:
deleteProductRequest- AConsumerthat will call methods onDeleteProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductApiPage
default CompletableFuture<DeleteProductApiPageResponse> deleteProductApiPage(DeleteProductApiPageRequest deleteProductApiPageRequest) Deletes an API page.
- Parameters:
deleteProductApiPageRequest-- Returns:
- A Java Future containing the result of the DeleteProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductApiPage
default CompletableFuture<DeleteProductApiPageResponse> deleteProductApiPage(Consumer<DeleteProductApiPageRequest.Builder> deleteProductApiPageRequest) Deletes an API page.
This is a convenience which creates an instance of the
DeleteProductApiPageRequest.Builderavoiding the need to create one manually viaDeleteProductApiPageRequest.builder()- Parameters:
deleteProductApiPageRequest- AConsumerthat will call methods onDeleteProductApiPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductPage
default CompletableFuture<DeleteProductPageResponse> deleteProductPage(DeleteProductPageRequest deleteProductPageRequest) Deletes a product page.
- Parameters:
deleteProductPageRequest-- Returns:
- A Java Future containing the result of the DeleteProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductPage
default CompletableFuture<DeleteProductPageResponse> deleteProductPage(Consumer<DeleteProductPageRequest.Builder> deleteProductPageRequest) Deletes a product page.
This is a convenience which creates an instance of the
DeleteProductPageRequest.Builderavoiding the need to create one manually viaDeleteProductPageRequest.builder()- Parameters:
deleteProductPageRequest- AConsumerthat will call methods onDeleteProductPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductSharingPolicy
default CompletableFuture<DeleteProductSharingPolicyResponse> deleteProductSharingPolicy(DeleteProductSharingPolicyRequest deleteProductSharingPolicyRequest) Deletes the sharing policy of a product. The product is no longer shared.
- Parameters:
deleteProductSharingPolicyRequest-- Returns:
- A Java Future containing the result of the DeleteProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProductSharingPolicy
default CompletableFuture<DeleteProductSharingPolicyResponse> deleteProductSharingPolicy(Consumer<DeleteProductSharingPolicyRequest.Builder> deleteProductSharingPolicyRequest) Deletes the sharing policy of a product. The product is no longer shared.
This is a convenience which creates an instance of the
DeleteProductSharingPolicyRequest.Builderavoiding the need to create one manually viaDeleteProductSharingPolicyRequest.builder()- Parameters:
deleteProductSharingPolicyRequest- AConsumerthat will call methods onDeleteProductSharingPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateManagedApis
default CompletableFuture<DisassociateManagedApisResponse> disassociateManagedApis(DisassociateManagedApisRequest disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product. Best-effort — IDs that fail are returned in
DisassociateManagedApisResponse.failedItems; IDs that succeed are omitted. Disassociating an unmapped Managed API is a no-op (not reported as failure).- Parameters:
disassociateManagedApisRequest-- Returns:
- A Java Future containing the result of the DisassociateManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateManagedApis
default CompletableFuture<DisassociateManagedApisResponse> disassociateManagedApis(Consumer<DisassociateManagedApisRequest.Builder> disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product. Best-effort — IDs that fail are returned in
DisassociateManagedApisResponse.failedItems; IDs that succeed are omitted. Disassociating an unmapped Managed API is a no-op (not reported as failure).
This is a convenience which creates an instance of the
DisassociateManagedApisRequest.Builderavoiding the need to create one manually viaDisassociateManagedApisRequest.builder()- Parameters:
disassociateManagedApisRequest- AConsumerthat will call methods onDisassociateManagedApisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApiInventoryItem
default CompletableFuture<GetApiInventoryItemResponse> getApiInventoryItem(GetApiInventoryItemRequest getApiInventoryItemRequest) Gets full details of a single API inventory item.
- Parameters:
getApiInventoryItemRequest-- Returns:
- A Java Future containing the result of the GetApiInventoryItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApiInventoryItem
default CompletableFuture<GetApiInventoryItemResponse> getApiInventoryItem(Consumer<GetApiInventoryItemRequest.Builder> getApiInventoryItemRequest) Gets full details of a single API inventory item.
This is a convenience which creates an instance of the
GetApiInventoryItemRequest.Builderavoiding the need to create one manually viaGetApiInventoryItemRequest.builder()- Parameters:
getApiInventoryItemRequest- AConsumerthat will call methods onGetApiInventoryItemRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetApiInventoryItem operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDiscoveryConfiguration
default CompletableFuture<GetDiscoveryConfigurationResponse> getDiscoveryConfiguration(GetDiscoveryConfigurationRequest getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.
- Parameters:
getDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the GetDiscoveryConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDiscoveryConfiguration
default CompletableFuture<GetDiscoveryConfigurationResponse> getDiscoveryConfiguration(Consumer<GetDiscoveryConfigurationRequest.Builder> getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.
This is a convenience which creates an instance of the
GetDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaGetDiscoveryConfigurationRequest.builder()- Parameters:
getDiscoveryConfigurationRequest- AConsumerthat will call methods onGetDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDiscoveryConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedApi
default CompletableFuture<GetManagedApiResponse> getManagedApi(GetManagedApiRequest getManagedApiRequest) Returns a Managed API, including its security posture findings.
- Parameters:
getManagedApiRequest-- Returns:
- A Java Future containing the result of the GetManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedApi
default CompletableFuture<GetManagedApiResponse> getManagedApi(Consumer<GetManagedApiRequest.Builder> getManagedApiRequest) Returns a Managed API, including its security posture findings.
This is a convenience which creates an instance of the
GetManagedApiRequest.Builderavoiding the need to create one manually viaGetManagedApiRequest.builder()- Parameters:
getManagedApiRequest- AConsumerthat will call methods onGetManagedApiRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetManagedApi operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationDiscoveryConfiguration
default CompletableFuture<GetOrganizationDiscoveryConfigurationResponse> getOrganizationDiscoveryConfiguration(GetOrganizationDiscoveryConfigurationRequest getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.
- Parameters:
getOrganizationDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the GetOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationDiscoveryConfiguration
default CompletableFuture<GetOrganizationDiscoveryConfigurationResponse> getOrganizationDiscoveryConfiguration(Consumer<GetOrganizationDiscoveryConfigurationRequest.Builder> getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.
This is a convenience which creates an instance of the
GetOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaGetOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
getOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onGetOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPortal
Returns the configuration, publish status, and preview status of a portal.
- Parameters:
getPortalRequest-- Returns:
- A Java Future containing the result of the GetPortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPortal
default CompletableFuture<GetPortalResponse> getPortal(Consumer<GetPortalRequest.Builder> getPortalRequest) Returns the configuration, publish status, and preview status of a portal.
This is a convenience which creates an instance of the
GetPortalRequest.Builderavoiding the need to create one manually viaGetPortalRequest.builder()- Parameters:
getPortalRequest- AConsumerthat will call methods onGetPortalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetPortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProduct
Returns a product. To read a product shared with you by another account, supply
resourceOwnerAccountId.- Parameters:
getProductRequest-- Returns:
- A Java Future containing the result of the GetProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProduct
default CompletableFuture<GetProductResponse> getProduct(Consumer<GetProductRequest.Builder> getProductRequest) Returns a product. To read a product shared with you by another account, supply
resourceOwnerAccountId.
This is a convenience which creates an instance of the
GetProductRequest.Builderavoiding the need to create one manually viaGetProductRequest.builder()- Parameters:
getProductRequest- AConsumerthat will call methods onGetProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductApiPage
default CompletableFuture<GetProductApiPageResponse> getProductApiPage(GetProductApiPageRequest getProductApiPageRequest) Returns an API page, including its body.
- Parameters:
getProductApiPageRequest-- Returns:
- A Java Future containing the result of the GetProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductApiPage
default CompletableFuture<GetProductApiPageResponse> getProductApiPage(Consumer<GetProductApiPageRequest.Builder> getProductApiPageRequest) Returns an API page, including its body.
This is a convenience which creates an instance of the
GetProductApiPageRequest.Builderavoiding the need to create one manually viaGetProductApiPageRequest.builder()- Parameters:
getProductApiPageRequest- AConsumerthat will call methods onGetProductApiPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductPage
default CompletableFuture<GetProductPageResponse> getProductPage(GetProductPageRequest getProductPageRequest) Returns a product page, including its body.
- Parameters:
getProductPageRequest-- Returns:
- A Java Future containing the result of the GetProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductPage
default CompletableFuture<GetProductPageResponse> getProductPage(Consumer<GetProductPageRequest.Builder> getProductPageRequest) Returns a product page, including its body.
This is a convenience which creates an instance of the
GetProductPageRequest.Builderavoiding the need to create one manually viaGetProductPageRequest.builder()- Parameters:
getProductPageRequest- AConsumerthat will call methods onGetProductPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductSharingPolicy
default CompletableFuture<GetProductSharingPolicyResponse> getProductSharingPolicy(GetProductSharingPolicyRequest getProductSharingPolicyRequest) Returns the sharing policy of a product.
- Parameters:
getProductSharingPolicyRequest-- Returns:
- A Java Future containing the result of the GetProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProductSharingPolicy
default CompletableFuture<GetProductSharingPolicyResponse> getProductSharingPolicy(Consumer<GetProductSharingPolicyRequest.Builder> getProductSharingPolicyRequest) Returns the sharing policy of a product.
This is a convenience which creates an instance of the
GetProductSharingPolicyRequest.Builderavoiding the need to create one manually viaGetProductSharingPolicyRequest.builder()- Parameters:
getProductSharingPolicyRequest- AConsumerthat will call methods onGetProductSharingPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApiInventoryItems
default CompletableFuture<ListApiInventoryItemsResponse> listApiInventoryItems(ListApiInventoryItemsRequest listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.
- Parameters:
listApiInventoryItemsRequest-- Returns:
- A Java Future containing the result of the ListApiInventoryItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApiInventoryItems
default CompletableFuture<ListApiInventoryItemsResponse> listApiInventoryItems(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.
This is a convenience which creates an instance of the
ListApiInventoryItemsRequest.Builderavoiding the need to create one manually viaListApiInventoryItemsRequest.builder()- Parameters:
listApiInventoryItemsRequest- AConsumerthat will call methods onListApiInventoryItemsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListApiInventoryItems operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApiInventoryItemsPaginator
default ListApiInventoryItemsPublisher listApiInventoryItemsPaginator(ListApiInventoryItemsRequest listApiInventoryItemsRequest) This is a variant of
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsPublisher publisher = client.listApiInventoryItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsPublisher publisher = client.listApiInventoryItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.- Parameters:
listApiInventoryItemsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApiInventoryItemsPaginator
default ListApiInventoryItemsPublisher listApiInventoryItemsPaginator(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) This is a variant of
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsPublisher publisher = client.listApiInventoryItemsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsPublisher publisher = client.listApiInventoryItemsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.
This is a convenience which creates an instance of the
ListApiInventoryItemsRequest.Builderavoiding the need to create one manually viaListApiInventoryItemsRequest.builder()- Parameters:
listApiInventoryItemsRequest- AConsumerthat will call methods onListApiInventoryItemsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDiscoveryStatuses
default CompletableFuture<ListDiscoveryStatusesResponse> listDiscoveryStatuses(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) Lists discovery statuses for services.
- Parameters:
listDiscoveryStatusesRequest-- Returns:
- A Java Future containing the result of the ListDiscoveryStatuses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDiscoveryStatuses
default CompletableFuture<ListDiscoveryStatusesResponse> listDiscoveryStatuses(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) Lists discovery statuses for services.
This is a convenience which creates an instance of the
ListDiscoveryStatusesRequest.Builderavoiding the need to create one manually viaListDiscoveryStatusesRequest.builder()- Parameters:
listDiscoveryStatusesRequest- AConsumerthat will call methods onListDiscoveryStatusesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDiscoveryStatuses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDiscoveryStatusesPaginator
default ListDiscoveryStatusesPublisher listDiscoveryStatusesPaginator(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) This is a variant of
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesPublisher publisher = client.listDiscoveryStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesPublisher publisher = client.listDiscoveryStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.- Parameters:
listDiscoveryStatusesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDiscoveryStatusesPaginator
default ListDiscoveryStatusesPublisher listDiscoveryStatusesPaginator(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) This is a variant of
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesPublisher publisher = client.listDiscoveryStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesPublisher publisher = client.listDiscoveryStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.
This is a convenience which creates an instance of the
ListDiscoveryStatusesRequest.Builderavoiding the need to create one manually viaListDiscoveryStatusesRequest.builder()- Parameters:
listDiscoveryStatusesRequest- AConsumerthat will call methods onListDiscoveryStatusesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApiEvents
default CompletableFuture<ListManagedApiEventsResponse> listManagedApiEvents(ListManagedApiEventsRequest listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).
- Parameters:
listManagedApiEventsRequest-- Returns:
- A Java Future containing the result of the ListManagedApiEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApiEvents
default CompletableFuture<ListManagedApiEventsResponse> listManagedApiEvents(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).
This is a convenience which creates an instance of the
ListManagedApiEventsRequest.Builderavoiding the need to create one manually viaListManagedApiEventsRequest.builder()- Parameters:
listManagedApiEventsRequest- AConsumerthat will call methods onListManagedApiEventsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListManagedApiEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApiEventsPaginator
default ListManagedApiEventsPublisher listManagedApiEventsPaginator(ListManagedApiEventsRequest listManagedApiEventsRequest) This is a variant of
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsPublisher publisher = client.listManagedApiEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsPublisher publisher = client.listManagedApiEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.- Parameters:
listManagedApiEventsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApiEventsPaginator
default ListManagedApiEventsPublisher listManagedApiEventsPaginator(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) This is a variant of
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsPublisher publisher = client.listManagedApiEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsPublisher publisher = client.listManagedApiEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.
This is a convenience which creates an instance of the
ListManagedApiEventsRequest.Builderavoiding the need to create one manually viaListManagedApiEventsRequest.builder()- Parameters:
listManagedApiEventsRequest- AConsumerthat will call methods onListManagedApiEventsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApis
default CompletableFuture<ListManagedApisResponse> listManagedApis(ListManagedApisRequest listManagedApisRequest) Lists the Managed APIs in your account.
- Parameters:
listManagedApisRequest-- Returns:
- A Java Future containing the result of the ListManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApis
default CompletableFuture<ListManagedApisResponse> listManagedApis(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) Lists the Managed APIs in your account.
This is a convenience which creates an instance of the
ListManagedApisRequest.Builderavoiding the need to create one manually viaListManagedApisRequest.builder()- Parameters:
listManagedApisRequest- AConsumerthat will call methods onListManagedApisRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListManagedApis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApisPaginator
default ListManagedApisPublisher listManagedApisPaginator(ListManagedApisRequest listManagedApisRequest) This is a variant of
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisPublisher publisher = client.listManagedApisPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListManagedApisPublisher publisher = client.listManagedApisPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.- Parameters:
listManagedApisRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedApisPaginator
default ListManagedApisPublisher listManagedApisPaginator(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) This is a variant of
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisPublisher publisher = client.listManagedApisPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListManagedApisPublisher publisher = client.listManagedApisPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.
This is a convenience which creates an instance of the
ListManagedApisRequest.Builderavoiding the need to create one manually viaListManagedApisRequest.builder()- Parameters:
listManagedApisRequest- AConsumerthat will call methods onListManagedApisRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPortals
Lists the portals in your account.
- Parameters:
listPortalsRequest-- Returns:
- A Java Future containing the result of the ListPortals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPortals
default CompletableFuture<ListPortalsResponse> listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) Lists the portals in your account.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListPortals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPortalsPaginator
This is a variant of
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListPortalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListPortalsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.- Parameters:
listPortalsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPortalsPaginator
default ListPortalsPublisher listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) This is a variant of
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListPortalsPublisher publisher = client.listPortalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListPortalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListPortalsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductApiPages
default CompletableFuture<ListProductApiPagesResponse> listProductApiPages(ListProductApiPagesRequest listProductApiPagesRequest) Lists the API pages in a product. The results do not include page bodies.
- Parameters:
listProductApiPagesRequest-- Returns:
- A Java Future containing the result of the ListProductApiPages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductApiPages
default CompletableFuture<ListProductApiPagesResponse> listProductApiPages(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) Lists the API pages in a product. The results do not include page bodies.
This is a convenience which creates an instance of the
ListProductApiPagesRequest.Builderavoiding the need to create one manually viaListProductApiPagesRequest.builder()- Parameters:
listProductApiPagesRequest- AConsumerthat will call methods onListProductApiPagesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProductApiPages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductApiPagesPaginator
default ListProductApiPagesPublisher listProductApiPagesPaginator(ListProductApiPagesRequest listProductApiPagesRequest) This is a variant of
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesPublisher publisher = client.listProductApiPagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesPublisher publisher = client.listProductApiPagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.- Parameters:
listProductApiPagesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductApiPagesPaginator
default ListProductApiPagesPublisher listProductApiPagesPaginator(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) This is a variant of
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesPublisher publisher = client.listProductApiPagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesPublisher publisher = client.listProductApiPagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.
This is a convenience which creates an instance of the
ListProductApiPagesRequest.Builderavoiding the need to create one manually viaListProductApiPagesRequest.builder()- Parameters:
listProductApiPagesRequest- AConsumerthat will call methods onListProductApiPagesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductPages
default CompletableFuture<ListProductPagesResponse> listProductPages(ListProductPagesRequest listProductPagesRequest) Lists the product pages in a product. The results do not include page bodies.
- Parameters:
listProductPagesRequest-- Returns:
- A Java Future containing the result of the ListProductPages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductPages
default CompletableFuture<ListProductPagesResponse> listProductPages(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) Lists the product pages in a product. The results do not include page bodies.
This is a convenience which creates an instance of the
ListProductPagesRequest.Builderavoiding the need to create one manually viaListProductPagesRequest.builder()- Parameters:
listProductPagesRequest- AConsumerthat will call methods onListProductPagesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProductPages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductPagesPaginator
default ListProductPagesPublisher listProductPagesPaginator(ListProductPagesRequest listProductPagesRequest) This is a variant of
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesPublisher publisher = client.listProductPagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductPagesPublisher publisher = client.listProductPagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.- Parameters:
listProductPagesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductPagesPaginator
default ListProductPagesPublisher listProductPagesPaginator(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) This is a variant of
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesPublisher publisher = client.listProductPagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductPagesPublisher publisher = client.listProductPagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.
This is a convenience which creates an instance of the
ListProductPagesRequest.Builderavoiding the need to create one manually viaListProductPagesRequest.builder()- Parameters:
listProductPagesRequest- AConsumerthat will call methods onListProductPagesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProducts
default CompletableFuture<ListProductsResponse> listProducts(ListProductsRequest listProductsRequest) Lists products you own, products shared with you, or both.
- Parameters:
listProductsRequest-- Returns:
- A Java Future containing the result of the ListProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProducts
default CompletableFuture<ListProductsResponse> listProducts(Consumer<ListProductsRequest.Builder> listProductsRequest) Lists products you own, products shared with you, or both.
This is a convenience which creates an instance of the
ListProductsRequest.Builderavoiding the need to create one manually viaListProductsRequest.builder()- Parameters:
listProductsRequest- AConsumerthat will call methods onListProductsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListProducts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductsPaginator
This is a variant of
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductsPublisher publisher = client.listProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductsPublisher publisher = client.listProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.- Parameters:
listProductsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProductsPaginator
default ListProductsPublisher listProductsPaginator(Consumer<ListProductsRequest.Builder> listProductsRequest) This is a variant of
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.apiportal.paginators.ListProductsPublisher publisher = client.listProductsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.apiportal.paginators.ListProductsPublisher publisher = client.listProductsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.apiportal.model.ListProductsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.apiportal.model.ListProductsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.
This is a convenience which creates an instance of the
ListProductsRequest.Builderavoiding the need to create one manually viaListProductsRequest.builder()- Parameters:
listProductsRequest- AConsumerthat will call methods onListProductsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDiscoveryConfiguration
default CompletableFuture<PutDiscoveryConfigurationResponse> putDiscoveryConfiguration(PutDiscoveryConfigurationRequest putDiscoveryConfigurationRequest) Creates or updates the discovery configuration
- Parameters:
putDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the PutDiscoveryConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDiscoveryConfiguration
default CompletableFuture<PutDiscoveryConfigurationResponse> putDiscoveryConfiguration(Consumer<PutDiscoveryConfigurationRequest.Builder> putDiscoveryConfigurationRequest) Creates or updates the discovery configuration
This is a convenience which creates an instance of the
PutDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaPutDiscoveryConfigurationRequest.builder()- Parameters:
putDiscoveryConfigurationRequest- AConsumerthat will call methods onPutDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutDiscoveryConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationDiscoveryConfiguration
default CompletableFuture<PutOrganizationDiscoveryConfigurationResponse> putOrganizationDiscoveryConfiguration(PutOrganizationDiscoveryConfigurationRequest putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration. This is a singleton per organization. Only the organization management account and registered delegated administrators may call this operation.
- Parameters:
putOrganizationDiscoveryConfigurationRequest-- Returns:
- A Java Future containing the result of the PutOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationDiscoveryConfiguration
default CompletableFuture<PutOrganizationDiscoveryConfigurationResponse> putOrganizationDiscoveryConfiguration(Consumer<PutOrganizationDiscoveryConfigurationRequest.Builder> putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration. This is a singleton per organization. Only the organization management account and registered delegated administrators may call this operation.
This is a convenience which creates an instance of the
PutOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaPutOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
putOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onPutOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutOrganizationDiscoveryConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putProductSharingPolicy
default CompletableFuture<PutProductSharingPolicyResponse> putProductSharingPolicy(PutProductSharingPolicyRequest putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.
- Parameters:
putProductSharingPolicyRequest-- Returns:
- A Java Future containing the result of the PutProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putProductSharingPolicy
default CompletableFuture<PutProductSharingPolicyResponse> putProductSharingPolicy(Consumer<PutProductSharingPolicyRequest.Builder> putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.
This is a convenience which creates an instance of the
PutProductSharingPolicyRequest.Builderavoiding the need to create one manually viaPutProductSharingPolicyRequest.builder()- Parameters:
putProductSharingPolicyRequest- AConsumerthat will call methods onPutProductSharingPolicyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutProductSharingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDiscovery
default CompletableFuture<StartDiscoveryResponse> startDiscovery(StartDiscoveryRequest startDiscoveryRequest) Starts the API discovery process.
- Parameters:
startDiscoveryRequest-- Returns:
- A Java Future containing the result of the StartDiscovery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDiscovery
default CompletableFuture<StartDiscoveryResponse> startDiscovery(Consumer<StartDiscoveryRequest.Builder> startDiscoveryRequest) Starts the API discovery process.
This is a convenience which creates an instance of the
StartDiscoveryRequest.Builderavoiding the need to create one manually viaStartDiscoveryRequest.builder()- Parameters:
startDiscoveryRequest- AConsumerthat will call methods onStartDiscoveryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartDiscovery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDiscovery
default CompletableFuture<StopDiscoveryResponse> stopDiscovery(StopDiscoveryRequest stopDiscoveryRequest) Stops the running API discovery process.
- Parameters:
stopDiscoveryRequest-- Returns:
- A Java Future containing the result of the StopDiscovery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDiscovery
default CompletableFuture<StopDiscoveryResponse> stopDiscovery(Consumer<StopDiscoveryRequest.Builder> stopDiscoveryRequest) Stops the running API discovery process.
This is a convenience which creates an instance of the
StopDiscoveryRequest.Builderavoiding the need to create one manually viaStopDiscoveryRequest.builder()- Parameters:
stopDiscoveryRequest- AConsumerthat will call methods onStopDiscoveryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StopDiscovery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- InternalServerException The service encountered an internal error. Try the request again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
tagKeys is a query string parameter: for tag-based access control (TBAC/ABAC) to work correctly, API Gateway requires the keys to be removed to be passed as a query string parameter.
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
tagKeys is a query string parameter: for tag-based access control (TBAC/ABAC) to work correctly, API Gateway requires the keys to be removed to be passed as a query string parameter.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePortal
default CompletableFuture<UpdatePortalResponse> updatePortal(UpdatePortalRequest updatePortalRequest) Updates a portal. Only the fields supplied in the request are changed.
- Parameters:
updatePortalRequest-- Returns:
- A Java Future containing the result of the UpdatePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePortal
default CompletableFuture<UpdatePortalResponse> updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) Updates a portal. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdatePortalRequest.Builderavoiding the need to create one manually viaUpdatePortalRequest.builder()- Parameters:
updatePortalRequest- AConsumerthat will call methods onUpdatePortalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePortal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePortalPublishStatus
default CompletableFuture<UpdatePortalPublishStatusResponse> updatePortalPublishStatus(UpdatePortalPublishStatusRequest updatePortalPublishStatusRequest) Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track
publishStatus.- Parameters:
updatePortalPublishStatusRequest-- Returns:
- A Java Future containing the result of the UpdatePortalPublishStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePortalPublishStatus
default CompletableFuture<UpdatePortalPublishStatusResponse> updatePortalPublishStatus(Consumer<UpdatePortalPublishStatusRequest.Builder> updatePortalPublishStatusRequest) Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track
publishStatus.
This is a convenience which creates an instance of the
UpdatePortalPublishStatusRequest.Builderavoiding the need to create one manually viaUpdatePortalPublishStatusRequest.builder()- Parameters:
updatePortalPublishStatusRequest- AConsumerthat will call methods onUpdatePortalPublishStatusRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePortalPublishStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- ConflictException The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProduct
default CompletableFuture<UpdateProductResponse> updateProduct(UpdateProductRequest updateProductRequest) Updates a product. Only the fields supplied in the request are changed.
- Parameters:
updateProductRequest-- Returns:
- A Java Future containing the result of the UpdateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProduct
default CompletableFuture<UpdateProductResponse> updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) Updates a product. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdateProductRequest.Builderavoiding the need to create one manually viaUpdateProductRequest.builder()- Parameters:
updateProductRequest- AConsumerthat will call methods onUpdateProductRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateProduct operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProductApiPage
default CompletableFuture<UpdateProductApiPageResponse> updateProductApiPage(UpdateProductApiPageRequest updateProductApiPageRequest) Updates an API page. Only the fields supplied in the request are changed.
- Parameters:
updateProductApiPageRequest-- Returns:
- A Java Future containing the result of the UpdateProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProductApiPage
default CompletableFuture<UpdateProductApiPageResponse> updateProductApiPage(Consumer<UpdateProductApiPageRequest.Builder> updateProductApiPageRequest) Updates an API page. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdateProductApiPageRequest.Builderavoiding the need to create one manually viaUpdateProductApiPageRequest.builder()- Parameters:
updateProductApiPageRequest- AConsumerthat will call methods onUpdateProductApiPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateProductApiPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProductPage
default CompletableFuture<UpdateProductPageResponse> updateProductPage(UpdateProductPageRequest updateProductPageRequest) Updates a product page.
- Parameters:
updateProductPageRequest-- Returns:
- A Java Future containing the result of the UpdateProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProductPage
default CompletableFuture<UpdateProductPageResponse> updateProductPage(Consumer<UpdateProductPageRequest.Builder> updateProductPageRequest) Updates a product page.
This is a convenience which creates an instance of the
UpdateProductPageRequest.Builderavoiding the need to create one manually viaUpdateProductPageRequest.builder()- Parameters:
updateProductPageRequest- AConsumerthat will call methods onUpdateProductPageRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateProductPage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource does not exist, or you do not have access to it.
- LimitExceededException The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException You do not have permission to perform this operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ApiPortalException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aApiPortalAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aApiPortalAsyncClient.
-