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

Class CreateResourceInstanceOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The createResourceInstance options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateResourceInstanceOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
Boolean	allowCleanup() Gets the allowCleanup.
Boolean	entityLock() Gets the entityLock.
String	name() Gets the name.
CreateResourceInstanceOptions.Builder	newBuilder() New builder.
Map<String,Object>	parameters() Gets the parameters.
String	resourceGroup() Gets the resourceGroup.
String	resourcePlanId() Gets the resourcePlanId.
List<String>	tags() Gets the tags.
String	target() Gets the target.

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

Method Detail

newBuilder

public CreateResourceInstanceOptions.Builder newBuilder()

New builder.

Returns:

a CreateResourceInstanceOptions builder

name

public String name()

Gets the name. The name of the instance. Must be 180 characters or less and cannot include any special characters other than `(space) - . _ :`.

Returns:

the name

target

public String target()

Gets the target. The deployment location where the instance should be hosted.

Returns:

the target

resourceGroup

public String resourceGroup()

Gets the resourceGroup. Short or long ID of resource group.

Returns:

the resourceGroup

resourcePlanId

public String resourcePlanId()

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

tags

public List<String> tags()

Gets the tags. Tags that are attached to the instance after provisioning. These tags can be searched and managed through the Tagging API in IBM Cloud.

Returns:

the tags

allowCleanup

public Boolean allowCleanup()

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

parameters

public Map<String,Object> parameters()

Gets the parameters. Configuration options represented as key-value pairs that are passed through to the target resource brokers.

Returns:

the parameters

entityLock

public Boolean entityLock()

Gets the entityLock. Indicates if the resource instance is locked for further update or delete operations. It does not affect actions performed on child resources like aliases, bindings or keys. False by default.

Returns:

the entityLock