Package com.oracle.bmc.cloudbridge

Interface InventoryAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    InventoryAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public interface InventoryAsync
extends AutoCloseable
    API for Oracle Cloud Bridge service.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • analyzeAssets

        Future<AnalyzeAssetsResponse> analyzeAssets​(AnalyzeAssetsRequest request,
                                            AsyncHandler<AnalyzeAssetsRequest,​AnalyzeAssetsResponse> handler)
        Returns an aggregation of assets.

        Aggregation groups are sorted by groupBy property. Default sort order is ascending, but can be overridden by the sortOrder parameter.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • changeAssetCompartment

        Future<ChangeAssetCompartmentResponse> changeAssetCompartment​(ChangeAssetCompartmentRequest request,
                                                              AsyncHandler<ChangeAssetCompartmentRequest,​ChangeAssetCompartmentResponse> handler)
        Moves an asset resource from one compartment to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • changeAssetTags

        Future<ChangeAssetTagsResponse> changeAssetTags​(ChangeAssetTagsRequest request,
                                                AsyncHandler<ChangeAssetTagsRequest,​ChangeAssetTagsResponse> handler)
        Change an asset’s tag.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createAsset

        Future<CreateAssetResponse> createAsset​(CreateAssetRequest request,
                                        AsyncHandler<CreateAssetRequest,​CreateAssetResponse> handler)
        Creates an asset.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createInventory

        Future<CreateInventoryResponse> createInventory​(CreateInventoryRequest request,
                                                AsyncHandler<CreateInventoryRequest,​CreateInventoryResponse> handler)
        Creates an inventory.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteAsset

        Future<DeleteAssetResponse> deleteAsset​(DeleteAssetRequest request,
                                        AsyncHandler<DeleteAssetRequest,​DeleteAssetResponse> handler)
        Deletes an asset resource by identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteInventory

        Future<DeleteInventoryResponse> deleteInventory​(DeleteInventoryRequest request,
                                                AsyncHandler<DeleteInventoryRequest,​DeleteInventoryResponse> handler)
        Deletes an inventory resource by identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getAsset

        Future<GetAssetResponse> getAsset​(GetAssetRequest request,
                                  AsyncHandler<GetAssetRequest,​GetAssetResponse> handler)
        Gets an asset by identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getInventory

        Future<GetInventoryResponse> getInventory​(GetInventoryRequest request,
                                          AsyncHandler<GetInventoryRequest,​GetInventoryResponse> handler)
        Gets an inventory by identifier.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • importInventory

        Future<ImportInventoryResponse> importInventory​(ImportInventoryRequest request,
                                                AsyncHandler<ImportInventoryRequest,​ImportInventoryResponse> handler)
        Import resources in inventory.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listAssets

        Future<ListAssetsResponse> listAssets​(ListAssetsRequest request,
                                      AsyncHandler<ListAssetsRequest,​ListAssetsResponse> handler)
        Returns a list of assets.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listHistoricalMetrics

        Future<ListHistoricalMetricsResponse> listHistoricalMetrics​(ListHistoricalMetricsRequest request,
                                                            AsyncHandler<ListHistoricalMetricsRequest,​ListHistoricalMetricsResponse> handler)
        List asset historical metrics.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listInventories

        Future<ListInventoriesResponse> listInventories​(ListInventoriesRequest request,
                                                AsyncHandler<ListInventoriesRequest,​ListInventoriesResponse> handler)
        Returns a list of inventories.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • submitHistoricalMetrics

        Future<SubmitHistoricalMetricsResponse> submitHistoricalMetrics​(SubmitHistoricalMetricsRequest request,
                                                                AsyncHandler<SubmitHistoricalMetricsRequest,​SubmitHistoricalMetricsResponse> handler)
        Creates or updates all metrics related to the asset.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateAsset

        Future<UpdateAssetResponse> updateAsset​(UpdateAssetRequest request,
                                        AsyncHandler<UpdateAssetRequest,​UpdateAssetResponse> handler)
        Updates the asset.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateInventory

        Future<UpdateInventoryResponse> updateInventory​(UpdateInventoryRequest request,
                                                AsyncHandler<UpdateInventoryRequest,​UpdateInventoryResponse> handler)
        Updates an inventory.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.