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

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

    • Method Detail

      • getId

        public java.lang.String getId()
        Gets the id. The ID associated with the instance.
        Returns:
        the id

      • getGuid

        public java.lang.String getGuid()
        Gets the guid. The GUID of the instance.
        Returns:
        the guid

      • getUrl

        public java.lang.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

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the createdAt. The date when the instance was created.
        Returns:
        the createdAt

      • getUpdatedAt

        public java.util.Date getUpdatedAt()
        Gets the updatedAt. The date when the instance was last updated.
        Returns:
        the updatedAt

      • getDeletedAt

        public java.util.Date getDeletedAt()
        Gets the deletedAt. The date when the instance was deleted.
        Returns:
        the deletedAt

      • getCreatedBy

        public java.lang.String getCreatedBy()
        Gets the createdBy. The subject who created the instance.
        Returns:
        the createdBy

      • getUpdatedBy

        public java.lang.String getUpdatedBy()
        Gets the updatedBy. The subject who updated the instance.
        Returns:
        the updatedBy

      • getDeletedBy

        public java.lang.String getDeletedBy()
        Gets the deletedBy. The subject who deleted the instance.
        Returns:
        the deletedBy

      • getScheduledReclaimAt

        public java.util.Date getScheduledReclaimAt()
        Gets the scheduledReclaimAt. The date when the instance was scheduled for reclamation.
        Returns:
        the scheduledReclaimAt

      • getRestoredAt

        public java.util.Date getRestoredAt()
        Gets the restoredAt. The date when the instance under reclamation was restored.
        Returns:
        the restoredAt

      • getRestoredBy

        public java.lang.String getRestoredBy()
        Gets the restoredBy. The subject who restored the instance back from reclamation.
        Returns:
        the restoredBy

      • getScheduledReclaimBy

        public java.lang.String getScheduledReclaimBy()
        Gets the scheduledReclaimBy. The subject who initiated the instance reclamation.
        Returns:
        the scheduledReclaimBy

      • getName

        public java.lang.String getName()
        Gets the name. The human-readable name of the instance.
        Returns:
        the name

      • getRegionId

        public java.lang.String getRegionId()
        Gets the regionId. The deployment location where the instance was provisioned.
        Returns:
        the regionId

      • getAccountId

        public java.lang.String getAccountId()
        Gets the accountId. An alpha-numeric value identifying the account ID.
        Returns:
        the accountId

      • getResellerChannelId

        public java.lang.String getResellerChannelId()
        Gets the resellerChannelId. The unique ID of the reseller channel where the instance was provisioned from.
        Returns:
        the resellerChannelId

      • getResourcePlanId

        public java.lang.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

      • getResourceGroupId

        public java.lang.String getResourceGroupId()
        Gets the resourceGroupId. The ID of the resource group.
        Returns:
        the resourceGroupId

      • getResourceGroupCrn

        public java.lang.String getResourceGroupCrn()
        Gets the resourceGroupCrn. The CRN of the resource group.
        Returns:
        the resourceGroupCrn

      • getTargetCrn

        public java.lang.String getTargetCrn()
        Gets the targetCrn. The 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 java.util.Map<java.lang.String,​java.lang.Object> getParameters()
        Gets the parameters. The current configuration parameters of the instance.
        Returns:
        the parameters

      • isAllowCleanup

        public java.lang.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

      • getCrn

        public java.lang.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

      • getState

        public java.lang.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 java.lang.String getType()
        Gets the type. The type of the instance, for example, `service_instance`.
        Returns:
        the type

      • getSubType

        public java.lang.String getSubType()
        Gets the subType. The sub-type of instance, for example, `cfaas`.
        Returns:
        the subType

      • getResourceId

        public java.lang.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

      • getDashboardUrl

        public java.lang.String getDashboardUrl()
        Gets the dashboardUrl. The resource-broker-provided URL to access administrative features of the instance.
        Returns:
        the dashboardUrl

      • getLastOperation

        public ResourceInstanceLastOperation getLastOperation()
        Gets the lastOperation. The status of the last operation requested on the instance.
        Returns:
        the lastOperation

      • getResourceAliasesUrl

        public java.lang.String getResourceAliasesUrl()
        Gets the resourceAliasesUrl. The relative path to the resource aliases for the instance.
        Returns:
        the resourceAliasesUrl

      • getResourceBindingsUrl

        public java.lang.String getResourceBindingsUrl()
        Gets the resourceBindingsUrl. The relative path to the resource bindings for the instance.
        Returns:
        the resourceBindingsUrl

      • getResourceKeysUrl

        public java.lang.String getResourceKeysUrl()
        Gets the resourceKeysUrl. The relative path to the resource keys for the instance.
        Returns:
        the resourceKeysUrl

      • getPlanHistory

        public java.util.List<PlanHistoryItem> getPlanHistory()
        Gets the planHistory. The plan history of the instance.
        Returns:
        the planHistory

      • isMigrated

        public java.lang.Boolean isMigrated()
        Gets the migrated. A boolean that dictates if the resource instance was migrated from a previous CF instance.
        Returns:
        the migrated

      • getExtensions

        public java.util.Map<java.lang.String,​java.lang.Object> getExtensions()
        Gets the extensions. Additional instance properties, contributed by the service and/or platform, are represented as key-value pairs.
        Returns:
        the extensions

      • getControlledBy

        public java.lang.String getControlledBy()
        Gets the controlledBy. The CRN of the resource that has control of the instance.
        Returns:
        the controlledBy

      • isLocked

        public java.lang.Boolean isLocked()
        Gets the locked. A boolean that dictates if the resource instance is locked or not.
        Returns:
        the locked