java.lang.Object
- io.fabric8.openshift.api.model.hive.v1.ClusterPoolSpec

All Implemented Interfaces:: io.fabric8.kubernetes.api.builder.Editable<ClusterPoolSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ClusterPoolSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ClusterPoolSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

ClusterPoolSpec defines the desired state of the ClusterPool.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ClusterPoolSpec()`	No args constructor for use in serialization
ClusterPoolSpec(Map<String,String> annotations, String baseDomain, ClusterPoolClaimLifetime claimLifetime, String hibernateAfter, HibernationConfig hibernationConfig, ClusterImageSetReference imageSetRef, Integer installAttemptsLimit, io.fabric8.kubernetes.api.model.LocalObjectReference installConfigSecretTemplateRef, List<io.fabric8.kubernetes.api.model.EnvVar> installerEnv, List<InventoryEntry> inventory, Map<String,String> labels, Integer maxConcurrent, Integer maxSize, Platform platform, io.fabric8.kubernetes.api.model.LocalObjectReference pullSecretRef, Integer runningCount, Integer size, Boolean skipMachinePools)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ClusterPoolSpecBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`Map<String,String>`	`getAnnotations()`	Annotations to be applied to new ClusterDeployments created for the pool.
`String`	`getBaseDomain()`	BaseDomain is the base domain to use for all clusters created in this pool.
`ClusterPoolClaimLifetime`	`getClaimLifetime()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`String`	`getHibernateAfter()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`HibernationConfig`	`getHibernationConfig()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`ClusterImageSetReference`	`getImageSetRef()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`Integer`	`getInstallAttemptsLimit()`	InstallAttemptsLimit is the maximum number of times Hive will attempt to install the cluster.
`io.fabric8.kubernetes.api.model.LocalObjectReference`	`getInstallConfigSecretTemplateRef()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`List<io.fabric8.kubernetes.api.model.EnvVar>`	`getInstallerEnv()`	InstallerEnv are extra environment variables to pass through to the installer.
`List<InventoryEntry>`	`getInventory()`	Inventory maintains a list of entries consumed by the ClusterPool to customize the default ClusterDeployment.
`Map<String,String>`	`getLabels()`	Labels to be applied to new ClusterDeployments created for the pool.
`Integer`	`getMaxConcurrent()`	MaxConcurrent is the maximum number of clusters that will be provisioned or deprovisioned at an time.
`Integer`	`getMaxSize()`	MaxSize is the maximum number of clusters that will be provisioned including clusters that have been claimed and ones waiting to be used.
`Platform`	`getPlatform()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`io.fabric8.kubernetes.api.model.LocalObjectReference`	`getPullSecretRef()`	ClusterPoolSpec defines the desired state of the ClusterPool.
`Integer`	`getRunningCount()`	RunningCount is the number of clusters we should keep running.
`Integer`	`getSize()`	Size is the default number of clusters that we should keep provisioned and waiting for use.
`Boolean`	`getSkipMachinePools()`	SkipMachinePools allows creating clusterpools where the machinepools are not managed by hive after cluster creation
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setAnnotations(Map<String,String> annotations)`	Annotations to be applied to new ClusterDeployments created for the pool.
`void`	`setBaseDomain(String baseDomain)`	BaseDomain is the base domain to use for all clusters created in this pool.
`void`	`setClaimLifetime(ClusterPoolClaimLifetime claimLifetime)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setHibernateAfter(String hibernateAfter)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setHibernationConfig(HibernationConfig hibernationConfig)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setImageSetRef(ClusterImageSetReference imageSetRef)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setInstallAttemptsLimit(Integer installAttemptsLimit)`	InstallAttemptsLimit is the maximum number of times Hive will attempt to install the cluster.
`void`	`setInstallConfigSecretTemplateRef(io.fabric8.kubernetes.api.model.LocalObjectReference installConfigSecretTemplateRef)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setInstallerEnv(List<io.fabric8.kubernetes.api.model.EnvVar> installerEnv)`	InstallerEnv are extra environment variables to pass through to the installer.
`void`	`setInventory(List<InventoryEntry> inventory)`	Inventory maintains a list of entries consumed by the ClusterPool to customize the default ClusterDeployment.
`void`	`setLabels(Map<String,String> labels)`	Labels to be applied to new ClusterDeployments created for the pool.
`void`	`setMaxConcurrent(Integer maxConcurrent)`	MaxConcurrent is the maximum number of clusters that will be provisioned or deprovisioned at an time.
`void`	`setMaxSize(Integer maxSize)`	MaxSize is the maximum number of clusters that will be provisioned including clusters that have been claimed and ones waiting to be used.
`void`	`setPlatform(Platform platform)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setPullSecretRef(io.fabric8.kubernetes.api.model.LocalObjectReference pullSecretRef)`	ClusterPoolSpec defines the desired state of the ClusterPool.
`void`	`setRunningCount(Integer runningCount)`	RunningCount is the number of clusters we should keep running.
`void`	`setSize(Integer size)`	Size is the default number of clusters that we should keep provisioned and waiting for use.
`void`	`setSkipMachinePools(Boolean skipMachinePools)`	SkipMachinePools allows creating clusterpools where the machinepools are not managed by hive after cluster creation
`ClusterPoolSpecBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClusterPoolSpec
```
public ClusterPoolSpec()
```
    No args constructor for use in serialization
  - ClusterPoolSpec
```
public ClusterPoolSpec(Map<String,String> annotations,
                       String baseDomain,
                       ClusterPoolClaimLifetime claimLifetime,
                       String hibernateAfter,
                       HibernationConfig hibernationConfig,
                       ClusterImageSetReference imageSetRef,
                       Integer installAttemptsLimit,
                       io.fabric8.kubernetes.api.model.LocalObjectReference installConfigSecretTemplateRef,
                       List<io.fabric8.kubernetes.api.model.EnvVar> installerEnv,
                       List<InventoryEntry> inventory,
                       Map<String,String> labels,
                       Integer maxConcurrent,
                       Integer maxSize,
                       Platform platform,
                       io.fabric8.kubernetes.api.model.LocalObjectReference pullSecretRef,
                       Integer runningCount,
                       Integer size,
                       Boolean skipMachinePools)
```
- Method Detail
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    Annotations to be applied to new ClusterDeployments created for the pool. ClusterDeployments that have already been claimed will not be affected when this value is modified.
  - setAnnotations
```
public void setAnnotations(Map<String,String> annotations)
```
    Annotations to be applied to new ClusterDeployments created for the pool. ClusterDeployments that have already been claimed will not be affected when this value is modified.
  - getBaseDomain
```
public String getBaseDomain()
```
    BaseDomain is the base domain to use for all clusters created in this pool.
  - setBaseDomain
```
public void setBaseDomain(String baseDomain)
```
    BaseDomain is the base domain to use for all clusters created in this pool.
  - getClaimLifetime
```
public ClusterPoolClaimLifetime getClaimLifetime()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setClaimLifetime
```
public void setClaimLifetime(ClusterPoolClaimLifetime claimLifetime)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getHibernateAfter
```
public String getHibernateAfter()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setHibernateAfter
```
public void setHibernateAfter(String hibernateAfter)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getHibernationConfig
```
public HibernationConfig getHibernationConfig()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setHibernationConfig
```
public void setHibernationConfig(HibernationConfig hibernationConfig)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getImageSetRef
```
public ClusterImageSetReference getImageSetRef()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setImageSetRef
```
public void setImageSetRef(ClusterImageSetReference imageSetRef)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getInstallAttemptsLimit
```
public Integer getInstallAttemptsLimit()
```
    InstallAttemptsLimit is the maximum number of times Hive will attempt to install the cluster.
  - setInstallAttemptsLimit
```
public void setInstallAttemptsLimit(Integer installAttemptsLimit)
```
    InstallAttemptsLimit is the maximum number of times Hive will attempt to install the cluster.
  - getInstallConfigSecretTemplateRef
```
public io.fabric8.kubernetes.api.model.LocalObjectReference getInstallConfigSecretTemplateRef()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setInstallConfigSecretTemplateRef
```
public void setInstallConfigSecretTemplateRef(io.fabric8.kubernetes.api.model.LocalObjectReference installConfigSecretTemplateRef)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getInstallerEnv
```
public List<io.fabric8.kubernetes.api.model.EnvVar> getInstallerEnv()
```
    InstallerEnv are extra environment variables to pass through to the installer. This may be used to enable additional features of the installer.
  - setInstallerEnv
```
public void setInstallerEnv(List<io.fabric8.kubernetes.api.model.EnvVar> installerEnv)
```
    InstallerEnv are extra environment variables to pass through to the installer. This may be used to enable additional features of the installer.
  - getInventory
```
public List<InventoryEntry> getInventory()
```
    Inventory maintains a list of entries consumed by the ClusterPool to customize the default ClusterDeployment.
  - setInventory
```
public void setInventory(List<InventoryEntry> inventory)
```
    Inventory maintains a list of entries consumed by the ClusterPool to customize the default ClusterDeployment.
  - getLabels
```
public Map<String,String> getLabels()
```
    Labels to be applied to new ClusterDeployments created for the pool. ClusterDeployments that have already been claimed will not be affected when this value is modified.
  - setLabels
```
public void setLabels(Map<String,String> labels)
```
    Labels to be applied to new ClusterDeployments created for the pool. ClusterDeployments that have already been claimed will not be affected when this value is modified.
  - getMaxConcurrent
```
public Integer getMaxConcurrent()
```
    MaxConcurrent is the maximum number of clusters that will be provisioned or deprovisioned at an time. This includes the claimed clusters being deprovisioned. By default there is no limit.
  - setMaxConcurrent
```
public void setMaxConcurrent(Integer maxConcurrent)
```
    MaxConcurrent is the maximum number of clusters that will be provisioned or deprovisioned at an time. This includes the claimed clusters being deprovisioned. By default there is no limit.
  - getMaxSize
```
public Integer getMaxSize()
```
    MaxSize is the maximum number of clusters that will be provisioned including clusters that have been claimed and ones waiting to be used. By default there is no limit.
  - setMaxSize
```
public void setMaxSize(Integer maxSize)
```
    MaxSize is the maximum number of clusters that will be provisioned including clusters that have been claimed and ones waiting to be used. By default there is no limit.
  - getPlatform
```
public Platform getPlatform()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setPlatform
```
public void setPlatform(Platform platform)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getPullSecretRef
```
public io.fabric8.kubernetes.api.model.LocalObjectReference getPullSecretRef()
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - setPullSecretRef
```
public void setPullSecretRef(io.fabric8.kubernetes.api.model.LocalObjectReference pullSecretRef)
```
    ClusterPoolSpec defines the desired state of the ClusterPool.
  - getRunningCount
```
public Integer getRunningCount()
```
    RunningCount is the number of clusters we should keep running. The remainder will be kept hibernated until claimed. By default no clusters will be kept running (all will be hibernated).
  - setRunningCount
```
public void setRunningCount(Integer runningCount)
```
    RunningCount is the number of clusters we should keep running. The remainder will be kept hibernated until claimed. By default no clusters will be kept running (all will be hibernated).
  - getSize
```
public Integer getSize()
```
    Size is the default number of clusters that we should keep provisioned and waiting for use.
  - setSize
```
public void setSize(Integer size)
```
    Size is the default number of clusters that we should keep provisioned and waiting for use.
  - getSkipMachinePools
```
public Boolean getSkipMachinePools()
```
    SkipMachinePools allows creating clusterpools where the machinepools are not managed by hive after cluster creation
  - setSkipMachinePools
```
public void setSkipMachinePools(Boolean skipMachinePools)
```
    SkipMachinePools allows creating clusterpools where the machinepools are not managed by hive after cluster creation
  - edit
```
public ClusterPoolSpecBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<ClusterPoolSpecBuilder>
  - toBuilder
```
public ClusterPoolSpecBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class ClusterPoolSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClusterPoolSpec

ClusterPoolSpec

Method Detail

getAnnotations

setAnnotations

getBaseDomain

setBaseDomain

getClaimLifetime

setClaimLifetime

getHibernateAfter

setHibernateAfter

getHibernationConfig

setHibernationConfig

getImageSetRef

setImageSetRef

getInstallAttemptsLimit

setInstallAttemptsLimit

getInstallConfigSecretTemplateRef

setInstallConfigSecretTemplateRef

getInstallerEnv

setInstallerEnv

getInventory

setInventory

getLabels

setLabels

getMaxConcurrent

setMaxConcurrent

getMaxSize

setMaxSize

getPlatform

setPlatform

getPullSecretRef

setPullSecretRef

getRunningCount

setRunningCount

getSize

setSize

getSkipMachinePools

setSkipMachinePools

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties