dev.galasa.kubernetes.internal.properties.KubernetesClusters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.kubernetes.manager Show documentation

There is a newer version: 0.34.0

Show newest version

/*
 * Licensed Materials - Property of IBM
 * 
 * (c) Copyright IBM Corp. 2020.
 */
package dev.galasa.kubernetes.internal.properties;

import java.util.List;

import dev.galasa.framework.spi.cps.CpsProperties;
import dev.galasa.kubernetes.KubernetesManagerException;


/**
 * Kubernetes Cluster IDs CPS Property
 * 
 * @galasa.cps.property
 * 
 * @galasa.name kubernetes.cluster.ids
 * 
 * @galasa.description Provides a comma separated list of the active Kubernetes Clusters that are defined in the CPS
 * 
 * @galasa.required No
 * 
 * @galasa.default Defaults to a single cluster ID of K8S if the property is missing
 * 
 * @galasa.valid_values A comma separated list of alphanumeric IDs.  Normally uppercased. 
 * 
 * @galasa.examples 
 * kubernetes.cluster.ids=K8S,ALTERNATE
 * 
 */
public class KubernetesClusters extends CpsProperties {

    public static List get() throws KubernetesManagerException {
        return getStringListWithDefault(KubernetesPropertiesSingleton.cps(), "K8S", "cluster", "ids");
    }
}