com.ibm.cloud.platform_services.resource_controller.v2

Class ResourceController

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.platform_services.resource_controller.v2.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.

Version:

v2

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME
static String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
ResourceController(String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `ResourceController` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias>	createResourceAlias(CreateResourceAliasOptions createResourceAliasOptions) Create a new resource alias.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding>	createResourceBinding(CreateResourceBindingOptions createResourceBindingOptions) Create a new resource binding.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance>	createResourceInstance(CreateResourceInstanceOptions createResourceInstanceOptions) Create (provision) a new resource instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey>	createResourceKey(CreateResourceKeyOptions createResourceKeyOptions) Create a new resource key.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteResourceAlias(DeleteResourceAliasOptions deleteResourceAliasOptions) Delete a resource alias.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteResourceBinding(DeleteResourceBindingOptions deleteResourceBindingOptions) Delete a resource binding.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteResourceInstance(DeleteResourceInstanceOptions deleteResourceInstanceOptions) Delete a resource instance.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteResourceKey(DeleteResourceKeyOptions deleteResourceKeyOptions) Delete a resource key by ID.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias>	getResourceAlias(GetResourceAliasOptions getResourceAliasOptions) Get a resource alias.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding>	getResourceBinding(GetResourceBindingOptions getResourceBindingOptions) Get a resource binding.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance>	getResourceInstance(GetResourceInstanceOptions getResourceInstanceOptions) Get a resource instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey>	getResourceKey(GetResourceKeyOptions getResourceKeyOptions) Get resource key by ID.
com.ibm.cloud.sdk.core.http.ServiceCall<ReclamationsList>	listReclamations() Get a list of all reclamations.
com.ibm.cloud.sdk.core.http.ServiceCall<ReclamationsList>	listReclamations(ListReclamationsOptions listReclamationsOptions) Get a list of all reclamations.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAliasesList>	listResourceAliases() Get a list of all resource aliases.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAliasesList>	listResourceAliases(ListResourceAliasesOptions listResourceAliasesOptions) Get a list of all resource aliases.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBindingsList>	listResourceBindings() Get a list of all resource bindings.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBindingsList>	listResourceBindings(ListResourceBindingsOptions listResourceBindingsOptions) Get a list of all resource bindings.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstancesList>	listResourceInstances() Get a list of all resource instances.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstancesList>	listResourceInstances(ListResourceInstancesOptions listResourceInstancesOptions) Get a list of all resource instances.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKeysList>	listResourceKeys() Get a list of all of the resource keys.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKeysList>	listResourceKeys(ListResourceKeysOptions listResourceKeysOptions) Get a list of all of the resource keys.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance>	lockResourceInstance(LockResourceInstanceOptions lockResourceInstanceOptions) Lock a resource instance.
static ResourceController	newInstance() Class method which constructs an instance of the `ResourceController` client.
static ResourceController	newInstance(String serviceName) Class method which constructs an instance of the `ResourceController` client.
com.ibm.cloud.sdk.core.http.ServiceCall<Reclamation>	runReclamationAction(RunReclamationActionOptions runReclamationActionOptions) Perform a reclamation action.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance>	unlockResourceInstance(UnlockResourceInstanceOptions unlockResourceInstanceOptions) Unlock a resource instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceAlias>	updateResourceAlias(UpdateResourceAliasOptions updateResourceAliasOptions) Update a resource alias.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBinding>	updateResourceBinding(UpdateResourceBindingOptions updateResourceBindingOptions) Update a resource binding.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance>	updateResourceInstance(UpdateResourceInstanceOptions updateResourceInstanceOptions) Update a resource instance.
com.ibm.cloud.sdk.core.http.ServiceCall<ResourceKey>	updateResourceKey(UpdateResourceKeyOptions updateResourceKeyOptions) Update a resource key.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, enableGzipCompression, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

ResourceController

public ResourceController(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(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. Get a list of all resource instances.

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. Get a list of all resource instances.

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. Provision a new resource in the specified location for the selected plan.

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 ID.

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<Void> deleteResourceInstance(DeleteResourceInstanceOptions deleteResourceInstanceOptions)

Delete a resource instance. Delete a resource instance by ID.

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. Update a resource instance by ID.

Parameters:

updateResourceInstanceOptions - the UpdateResourceInstanceOptions containing the options for the call

Returns:

a ServiceCall with a result of type ResourceInstance

lockResourceInstance

public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceInstance> lockResourceInstance(LockResourceInstanceOptions lockResourceInstanceOptions)

Lock a resource instance. Locks a resource instance by ID. 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. Unlocks a resource instance by ID.

Parameters:

unlockResourceInstanceOptions - the UnlockResourceInstanceOptions 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. List all resource keys.

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. List all resource keys.

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. Create a new resource key.

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 by ID. Get resource key by ID.

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<Void> deleteResourceKey(DeleteResourceKeyOptions deleteResourceKeyOptions)

Delete a resource key by ID. Delete a resource key by ID.

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. Update a resource key by ID.

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(ListResourceBindingsOptions listResourceBindingsOptions)

Get a list of all resource bindings. Get a list of all resource bindings.

Parameters:

listResourceBindingsOptions - the ListResourceBindingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ResourceBindingsList

listResourceBindings

public com.ibm.cloud.sdk.core.http.ServiceCall<ResourceBindingsList> listResourceBindings()

Get a list of all resource bindings. Get a list of all resource bindings.

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. Create a new resource binding.

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. Retrieve a resource binding by ID.

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<Void> deleteResourceBinding(DeleteResourceBindingOptions deleteResourceBindingOptions)

Delete a resource binding. Delete a resource binding by ID.

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. Update a resource binding by ID.

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. Get a list of all resource aliases.

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. Get a list of all resource aliases.

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. Retrieve a resource alias by ID.

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<Void> deleteResourceAlias(DeleteResourceAliasOptions deleteResourceAliasOptions)

Delete a resource alias. Delete a resource alias by ID.

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. Update a resource alias by ID.

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. Get a list of all reclamations.

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. Get a list of all reclamations.

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 (provisionally delete) a resource so that it can no longer be used, or restore a resource 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