Package com.ibm.cloud.platform_services.resource_controller.v2

Class ResourceController

  • public class ResourceController
extends com.ibm.cloud.sdk.core.service.BaseService
    Manage lifecycle of your Cloud resources using Resource Controller APIs. Resources are provisioned globally in an account scope. Supports asynchronous provisioning of resources. Enables consumption of a global resource through a Cloud Foundry space in any region. API Version: 2.0

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `ResourceController` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ResourceController

        public ResourceController​(java.lang.String serviceName,
                          com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `ResourceController` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static ResourceController newInstance()
        Class method which constructs an instance of the `ResourceController` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `ResourceController` client using external configuration

      • newInstance

        public static ResourceController newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `ResourceController` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `ResourceController` client using external configuration

      • listResourceInstances

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstancesList> listResourceInstances​(ListResourceInstancesOptions listResourceInstancesOptions)
        Get a list of all resource instances. View a list of all available resource instances. Resources is a broad term that could mean anything from a service instance to a virtual machine associated with the customer account.
        Parameters:
        listResourceInstancesOptions - the ListResourceInstancesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstancesList

      • listResourceInstances

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstancesList> listResourceInstances()
        Get a list of all resource instances. View a list of all available resource instances. Resources is a broad term that could mean anything from a service instance to a virtual machine associated with the customer account.
        Returns:
        a ServiceCall with a result of type ResourceInstancesList

      • createResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> createResourceInstance​(CreateResourceInstanceOptions createResourceInstanceOptions)
        Create (provision) a new resource instance. When you provision a service you get an instance of that service. An instance represents the resource with which you create, and additionally, represents a chargeable record of which billing can occur.
        Parameters:
        createResourceInstanceOptions - the CreateResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • getResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> getResourceInstance​(GetResourceInstanceOptions getResourceInstanceOptions)
        Get a resource instance. Retrieve a resource instance by URL-encoded CRN or GUID. Find more details on a particular instance, like when it was provisioned and who provisioned it.
        Parameters:
        getResourceInstanceOptions - the GetResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • deleteResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteResourceInstance​(DeleteResourceInstanceOptions deleteResourceInstanceOptions)
        Delete a resource instance. Delete a resource instance by URL-encoded CRN or GUID. If the resource instance has any resource keys or aliases associated with it, use the `recursive=true` parameter to delete it.
        Parameters:
        deleteResourceInstanceOptions - the DeleteResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> updateResourceInstance​(UpdateResourceInstanceOptions updateResourceInstanceOptions)
        Update a resource instance. Use the resource instance URL-encoded CRN or GUID to make updates to the resource instance, like changing the name or plan.
        Parameters:
        updateResourceInstanceOptions - the UpdateResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • listResourceAliasesForInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAliasesList> listResourceAliasesForInstance​(ListResourceAliasesForInstanceOptions listResourceAliasesForInstanceOptions)
        Get a list of all resource aliases for the instance. Retrieving a list of all resource aliases can help you find out who's using the resource instance.
        Parameters:
        listResourceAliasesForInstanceOptions - the ListResourceAliasesForInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceAliasesList

      • listResourceKeysForInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKeysList> listResourceKeysForInstance​(ListResourceKeysForInstanceOptions listResourceKeysForInstanceOptions)
        Get a list of all the resource keys for the instance. You may have many resource keys for one resource instance. For example, you may have a different resource key for each user or each role.
        Parameters:
        listResourceKeysForInstanceOptions - the ListResourceKeysForInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceKeysList

      • lockResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> lockResourceInstance​(LockResourceInstanceOptions lockResourceInstanceOptions)
        Lock a resource instance. Locks a resource instance. A locked instance can not be updated or deleted. It does not affect actions performed on child resources like aliases, bindings, or keys.
        Parameters:
        lockResourceInstanceOptions - the LockResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • unlockResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> unlockResourceInstance​(UnlockResourceInstanceOptions unlockResourceInstanceOptions)
        Unlock a resource instance. Unlock a resource instance to update or delete it. Unlocking a resource instance does not affect child resources like aliases, bindings or keys.
        Parameters:
        unlockResourceInstanceOptions - the UnlockResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • cancelLastopResourceInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> cancelLastopResourceInstance​(CancelLastopResourceInstanceOptions cancelLastopResourceInstanceOptions)
        Cancel the in progress last operation of the resource instance. Cancel the in progress last operation of the resource instance. After successful cancellation, the resource instance is removed.
        Parameters:
        cancelLastopResourceInstanceOptions - the CancelLastopResourceInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceInstance

      • listResourceKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKeysList> listResourceKeys​(ListResourceKeysOptions listResourceKeysOptions)
        Get a list of all of the resource keys. View all of the resource keys that exist for all of your resource instances.
        Parameters:
        listResourceKeysOptions - the ListResourceKeysOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceKeysList

      • listResourceKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKeysList> listResourceKeys()
        Get a list of all of the resource keys. View all of the resource keys that exist for all of your resource instances.
        Returns:
        a ServiceCall with a result of type ResourceKeysList

      • createResourceKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey> createResourceKey​(CreateResourceKeyOptions createResourceKeyOptions)
        Create a new resource key. A resource key is a saved credential you can use to authenticate with a resource instance.
        Parameters:
        createResourceKeyOptions - the CreateResourceKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceKey

      • getResourceKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey> getResourceKey​(GetResourceKeyOptions getResourceKeyOptions)
        Get resource key. View the details of a resource key by URL-encoded CRN or GUID, like the credentials for the key and who created it.
        Parameters:
        getResourceKeyOptions - the GetResourceKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceKey

      • deleteResourceKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteResourceKey​(DeleteResourceKeyOptions deleteResourceKeyOptions)
        Delete a resource key. Deleting a resource key does not affect any resource instance or resource alias associated with the key.
        Parameters:
        deleteResourceKeyOptions - the DeleteResourceKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateResourceKey

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey> updateResourceKey​(UpdateResourceKeyOptions updateResourceKeyOptions)
        Update a resource key. Use the resource key URL-encoded CRN or GUID to update the resource key.
        Parameters:
        updateResourceKeyOptions - the UpdateResourceKeyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceKey

      • listResourceBindings

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBindingsList> listResourceBindings()
        Get a list of all resource bindings. View all of the resource bindings that exist for all of your resource aliases.
        Returns:
        a ServiceCall with a result of type ResourceBindingsList

      • createResourceBinding

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding> createResourceBinding​(CreateResourceBindingOptions createResourceBindingOptions)
        Create a new resource binding. A resource binding connects credentials to a resource alias. The credentials are in the form of a resource key.
        Parameters:
        createResourceBindingOptions - the CreateResourceBindingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceBinding

      • getResourceBinding

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding> getResourceBinding​(GetResourceBindingOptions getResourceBindingOptions)
        Get a resource binding. View a resource binding and all of its details, like who created it, the credential, and the resource alias that the binding is associated with.
        Parameters:
        getResourceBindingOptions - the GetResourceBindingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceBinding

      • deleteResourceBinding

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteResourceBinding​(DeleteResourceBindingOptions deleteResourceBindingOptions)
        Delete a resource binding. Deleting a resource binding does not affect the resource alias that the binding is associated with.
        Parameters:
        deleteResourceBindingOptions - the DeleteResourceBindingOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateResourceBinding

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding> updateResourceBinding​(UpdateResourceBindingOptions updateResourceBindingOptions)
        Update a resource binding. Use the resource binding URL-encoded CRN or GUID to update the resource binding.
        Parameters:
        updateResourceBindingOptions - the UpdateResourceBindingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceBinding

      • listResourceAliases

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAliasesList> listResourceAliases​(ListResourceAliasesOptions listResourceAliasesOptions)
        Get a list of all resource aliases. View all of the resource aliases that exist for every resource instance.
        Parameters:
        listResourceAliasesOptions - the ListResourceAliasesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceAliasesList

      • listResourceAliases

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAliasesList> listResourceAliases()
        Get a list of all resource aliases. View all of the resource aliases that exist for every resource instance.
        Returns:
        a ServiceCall with a result of type ResourceAliasesList

      • createResourceAlias

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias> createResourceAlias​(CreateResourceAliasOptions createResourceAliasOptions)
        Create a new resource alias. Alias a resource instance into a targeted environment's (name)space.
        Parameters:
        createResourceAliasOptions - the CreateResourceAliasOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceAlias

      • getResourceAlias

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias> getResourceAlias​(GetResourceAliasOptions getResourceAliasOptions)
        Get a resource alias. View a resource alias and all of its details, like who created it and the resource instance that it's associated with.
        Parameters:
        getResourceAliasOptions - the GetResourceAliasOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceAlias

      • deleteResourceAlias

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteResourceAlias​(DeleteResourceAliasOptions deleteResourceAliasOptions)
        Delete a resource alias. Delete a resource alias by URL-encoded CRN or GUID. If the resource alias has any resource keys or bindings associated with it, use the `recursive=true` parameter to delete it.
        Parameters:
        deleteResourceAliasOptions - the DeleteResourceAliasOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateResourceAlias

        public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias> updateResourceAlias​(UpdateResourceAliasOptions updateResourceAliasOptions)
        Update a resource alias. Use the resource alias URL-encoded CRN or GUID to update the resource alias.
        Parameters:
        updateResourceAliasOptions - the UpdateResourceAliasOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ResourceAlias

      • listReclamations

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReclamationsList> listReclamations​(ListReclamationsOptions listReclamationsOptions)
        Get a list of all reclamations. View all of the resource reclamations that exist for every resource instance.
        Parameters:
        listReclamationsOptions - the ListReclamationsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ReclamationsList

      • listReclamations

        public com.ibm.cloud.sdk.core.http.ServiceCall<ReclamationsList> listReclamations()
        Get a list of all reclamations. View all of the resource reclamations that exist for every resource instance.
        Returns:
        a ServiceCall with a result of type ReclamationsList

      • runReclamationAction

        public com.ibm.cloud.sdk.core.http.ServiceCall<Reclamation> runReclamationAction​(RunReclamationActionOptions runReclamationActionOptions)
        Perform a reclamation action. Reclaim a resource instance so that it can no longer be used, or restore the resource instance so that it's usable again.
        Parameters:
        runReclamationActionOptions - the RunReclamationActionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Reclamation