Package com.oracle.bmc.tenantmanagercontrolplane

Interface OrganizationAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OrganizationAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230401")
public interface OrganizationAsync
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

      • createChildTenancy

        Future<CreateChildTenancyResponse> createChildTenancy​(CreateChildTenancyRequest request,
                                                      AsyncHandler<CreateChildTenancyRequest,​CreateChildTenancyResponse> handler)
        Creates a child tenancy asynchronously.
        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.

      • getOrganization

        Future<GetOrganizationResponse> getOrganization​(GetOrganizationRequest request,
                                                AsyncHandler<GetOrganizationRequest,​GetOrganizationResponse> handler)
        Gets information about the organization.
        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.

      • getOrganizationTenancy

        Future<GetOrganizationTenancyResponse> getOrganizationTenancy​(GetOrganizationTenancyRequest request,
                                                              AsyncHandler<GetOrganizationTenancyRequest,​GetOrganizationTenancyResponse> handler)
        Gets information about the organization’s tenancy.
        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.

      • listOrganizations

        Future<ListOrganizationsResponse> listOrganizations​(ListOrganizationsRequest request,
                                                    AsyncHandler<ListOrganizationsRequest,​ListOrganizationsResponse> handler)
        Lists organizations associated with the caller.
        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.

      • updateOrganization

        Future<UpdateOrganizationResponse> updateOrganization​(UpdateOrganizationRequest request,
                                                      AsyncHandler<UpdateOrganizationRequest,​UpdateOrganizationResponse> handler)
        Map the default subscription to the organization.
        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.