Package com.oracle.bmc.tenantmanagercontrolplane

Interface SubscriptionAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    SubscriptionAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface SubscriptionAsync
extends AutoCloseable
    Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources.

    For more information, see Organization Management Overview.

    • 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

      • createSubscriptionMapping

        Future<CreateSubscriptionMappingResponse> createSubscriptionMapping​(CreateSubscriptionMappingRequest request,
                                                                    AsyncHandler<CreateSubscriptionMappingRequest,​CreateSubscriptionMappingResponse> handler)
        Assign the tenancy record identified by the compartment ID to the given subscription ID.
        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.

      • getAssignedSubscription

        Future<GetAssignedSubscriptionResponse> getAssignedSubscription​(GetAssignedSubscriptionRequest request,
                                                                AsyncHandler<GetAssignedSubscriptionRequest,​GetAssignedSubscriptionResponse> handler)
        Get the assigned subscription details by assigned subscription ID.
        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.

      • getSubscription

        Future<GetSubscriptionResponse> getSubscription​(GetSubscriptionRequest request,
                                                AsyncHandler<GetSubscriptionRequest,​GetSubscriptionResponse> handler)
        Gets the subscription details by subscription ID.
        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.

      • getSubscriptionMapping

        Future<GetSubscriptionMappingResponse> getSubscriptionMapping​(GetSubscriptionMappingRequest request,
                                                              AsyncHandler<GetSubscriptionMappingRequest,​GetSubscriptionMappingResponse> handler)
        Get the subscription mapping details by subscription mapping ID.
        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.

      • listAssignedSubscriptions

        Future<ListAssignedSubscriptionsResponse> listAssignedSubscriptions​(ListAssignedSubscriptionsRequest request,
                                                                    AsyncHandler<ListAssignedSubscriptionsRequest,​ListAssignedSubscriptionsResponse> handler)
        Lists subscriptions that are consumed by the compartment.

        Only the root compartment is allowed.

        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.

      • listAvailableRegions

        Future<ListAvailableRegionsResponse> listAvailableRegions​(ListAvailableRegionsRequest request,
                                                          AsyncHandler<ListAvailableRegionsRequest,​ListAvailableRegionsResponse> handler)
        List the available regions based on subscription ID.
        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.

      • listSubscriptionMappings

        Future<ListSubscriptionMappingsResponse> listSubscriptionMappings​(ListSubscriptionMappingsRequest request,
                                                                  AsyncHandler<ListSubscriptionMappingsRequest,​ListSubscriptionMappingsResponse> handler)
        Lists the subscription mappings for all the subscriptions owned by a given compartmentId.

        Only the root compartment is allowed.

        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.

      • listSubscriptions

        Future<ListSubscriptionsResponse> listSubscriptions​(ListSubscriptionsRequest request,
                                                    AsyncHandler<ListSubscriptionsRequest,​ListSubscriptionsResponse> handler)
        List the subscriptions that a compartment owns.

        Only the root compartment is allowed.

        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.