com.ibm.cloud.platform_services.resource_controller.v2.model

Class ResourceInstance

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.platform_services.resource_controller.v2.model.ResourceInstance

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ResourceInstance
extends com.ibm.cloud.sdk.core.service.model.GenericModel

A resource instance.

Constructor Summary

Constructors

Constructor and Description
ResourceInstance()

Method Summary

Modifier and Type	Method and Description
String	getAccountId() Gets the accountId.
Date	getCreatedAt() Gets the createdAt.
String	getCreatedBy() Gets the createdBy.
String	getCrn() Gets the crn.
String	getDashboardUrl() Gets the dashboardUrl.
Date	getDeletedAt() Gets the deletedAt.
String	getDeletedBy() Gets the deletedBy.
String	getGuid() Gets the guid.
String	getId() Gets the id.
Map<String,Object>	getLastOperation() Gets the lastOperation.
String	getName() Gets the name.
Map<String,Object>	getParameters() Gets the parameters.
List<PlanHistoryItem>	getPlanHistory() Gets the planHistory.
String	getResourceAliasesUrl() Gets the resourceAliasesUrl.
String	getResourceBindingsUrl() Gets the resourceBindingsUrl.
String	getResourceGroupCrn() Gets the resourceGroupCrn.
String	getResourceGroupId() Gets the resourceGroupId.
String	getResourceId() Gets the resourceId.
String	getResourceKeysUrl() Gets the resourceKeysUrl.
String	getResourcePlanId() Gets the resourcePlanId.
Date	getRestoredAt() Gets the restoredAt.
String	getRestoredBy() Gets the restoredBy.
Date	getScheduledReclaimAt() Gets the scheduledReclaimAt.
String	getScheduledReclaimBy() Gets the scheduledReclaimBy.
String	getState() Gets the state.
String	getSubType() Gets the subType.
String	getTargetCrn() Gets the targetCrn.
String	getType() Gets the type.
Date	getUpdatedAt() Gets the updatedAt.
String	getUpdatedBy() Gets the updatedBy.
String	getUrl() Gets the url.
Boolean	isAllowCleanup() Gets the allowCleanup.
Boolean	isLocked() Gets the locked.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceInstance

public ResourceInstance()

Method Detail

getId

public String getId()

Gets the id. The ID associated with the instance.

Returns:

the id

getGuid

public String getGuid()

Gets the guid. When you create a new resource, a globally unique identifier (GUID) is assigned. This GUID is a unique internal identifier managed by the resource controller that corresponds to the instance.

Returns:

the guid

getCrn

public String getCrn()

Gets the crn. The full Cloud Resource Name (CRN) associated with the instance. For more information about this format, see [Cloud Resource Names](https://cloud.ibm.com/docs/overview?topic=overview-crn).

Returns:

the crn

getUrl

public String getUrl()

Gets the url. When you provision a new resource, a relative URL path is created identifying the location of the instance.

Returns:

the url

getName

public String getName()

Gets the name. The human-readable name of the instance.

Returns:

the name

getAccountId

public String getAccountId()

Gets the accountId. An alpha-numeric value identifying the account ID.

Returns:

the accountId

getResourceGroupId

public String getResourceGroupId()

Gets the resourceGroupId. The short ID of the resource group.

Returns:

the resourceGroupId

getResourceGroupCrn

public String getResourceGroupCrn()

Gets the resourceGroupCrn. The long ID (full CRN) of the resource group.

Returns:

the resourceGroupCrn

getResourceId

public String getResourceId()

Gets the resourceId. The unique ID of the offering. This value is provided by and stored in the global catalog.

Returns:

the resourceId

getResourcePlanId

public String getResourcePlanId()

Gets the resourcePlanId. The unique ID of the plan associated with the offering. This value is provided by and stored in the global catalog.

Returns:

the resourcePlanId

getTargetCrn

public String getTargetCrn()

Gets the targetCrn. The full deployment CRN as defined in the global catalog. The Cloud Resource Name (CRN) of the deployment location where the instance is provisioned.

Returns:

the targetCrn

getParameters

public Map<String,Object> getParameters()

Gets the parameters. The current configuration parameters of the instance.

Returns:

the parameters

getState

public String getState()

Gets the state. The current state of the instance. For example, if the instance is deleted, it will return removed.

Returns:

the state

getType

public String getType()

Gets the type. The type of the instance, e.g. `service_instance`.

Returns:

the type

getSubType

public String getSubType()

Gets the subType. The sub-type of instance, e.g. `cfaas`.

Returns:

the subType

isAllowCleanup

public Boolean isAllowCleanup()

Gets the allowCleanup. A boolean that dictates if the resource instance should be deleted (cleaned up) during the processing of a region instance delete call.

Returns:

the allowCleanup

isLocked

public Boolean isLocked()

Gets the locked. A boolean that dictates if the resource instance is locked or not.

Returns:

the locked

getLastOperation

public Map<String,Object> getLastOperation()

Gets the lastOperation. The status of the last operation requested on the instance.

Returns:

the lastOperation

getDashboardUrl

public String getDashboardUrl()

Gets the dashboardUrl. The resource-broker-provided URL to access administrative features of the instance.

Returns:

the dashboardUrl

getPlanHistory

public List<PlanHistoryItem> getPlanHistory()

Gets the planHistory. The plan history of the instance.

Returns:

the planHistory

getResourceAliasesUrl

public String getResourceAliasesUrl()

Gets the resourceAliasesUrl. The relative path to the resource aliases for the instance.

Returns:

the resourceAliasesUrl

getResourceBindingsUrl

public String getResourceBindingsUrl()

Gets the resourceBindingsUrl. The relative path to the resource bindings for the instance.

Returns:

the resourceBindingsUrl

getResourceKeysUrl

public String getResourceKeysUrl()

Gets the resourceKeysUrl. The relative path to the resource keys for the instance.

Returns:

the resourceKeysUrl

getCreatedAt

public Date getCreatedAt()

Gets the createdAt. The date when the instance was created.

Returns:

the createdAt

getCreatedBy

public String getCreatedBy()

Gets the createdBy. The subject who created the instance.

Returns:

the createdBy

getUpdatedAt

public Date getUpdatedAt()

Gets the updatedAt. The date when the instance was last updated.

Returns:

the updatedAt

getUpdatedBy

public String getUpdatedBy()

Gets the updatedBy. The subject who updated the instance.

Returns:

the updatedBy

getDeletedAt

public Date getDeletedAt()

Gets the deletedAt. The date when the instance was deleted.

Returns:

the deletedAt

getDeletedBy

public String getDeletedBy()

Gets the deletedBy. The subject who deleted the instance.

Returns:

the deletedBy

getScheduledReclaimAt

public Date getScheduledReclaimAt()

Gets the scheduledReclaimAt. The date when the instance was scheduled for reclamation.

Returns:

the scheduledReclaimAt

getScheduledReclaimBy

public String getScheduledReclaimBy()

Gets the scheduledReclaimBy. The subject who initiated the instance reclamation.

Returns:

the scheduledReclaimBy

getRestoredAt

public Date getRestoredAt()

Gets the restoredAt. The date when the instance under reclamation was restored.

Returns:

the restoredAt

getRestoredBy

public String getRestoredBy()

Gets the restoredBy. The subject who restored the instance back from reclamation.

Returns:

the restoredBy