Package org.springframework.cloud.servicebroker.model

Class KubernetesContext

java.lang.Object

org.springframework.cloud.servicebroker.model.Context

org.springframework.cloud.servicebroker.model.KubernetesContext

public final class KubernetesContext
extends Context

Kubernetes specific contextual information under which the service instance is to be provisioned or updated.

Author:

Scott Frederick, Roy Clarkson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KubernetesContext.KubernetesContextBuilder	Builder class for KubernetesContext.

Nested classes/interfaces inherited from class org.springframework.cloud.servicebroker.model.Context

Context.ContextBaseBuilder<R extends Context,B extends Context.ContextBaseBuilder<R,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLUSTERID_KEY	Kubernetes Cluster ID key.
static final String	INSTANCE_ANNOTATIONS_KEY	Kubernetes Instance Annotations key.
static final String	INSTANCE_NAME_KEY	Kubernetes Instance Name.
static final String	KUBERNETES_PLATFORM	Kubernetes platform name.
static final String	NAMESPACE_ANNOTATIONS_KEY	Kubernetes Namespace Annotations key.
static final String	NAMESPACE_KEY	Kubernetes Namespace key.

Fields inherited from class org.springframework.cloud.servicebroker.model.Context

platform, PLATFORM_KEY, properties

Constructor Summary

Constructors

Constructor	Description
KubernetesContext(String namespace, String clusterid, String instanceName, Map<String,Object> namespaceAnnotations, Map<String,Object> instanceAnnotations, Map<String,Object> properties)	Create a new KubernetesContext.
KubernetesContext(String namespace, String clusterid, Map<String,Object> properties)	Create a new KubernetesContext.

Method Summary

Modifier and Type	Method	Description
static KubernetesContext.KubernetesContextBuilder	builder()	Create a builder that provides a fluent API for constructing a KubernetesContext.
String	getClusterid()	Retrieve the kubernetes clusterid from the collection of platform properties.
Map<String,Object>	getInstanceAnnotations()	Retrieve the kubernetes instance annotations from the collection of platform properties.
String	getInstanceName()	Retrieve the kubernetes instance name from the collection of platform properties.
String	getNamespace()	Retrieve the kubernetes namespace from the collection of platform properties.
Map<String,Object>	getNamespaceAnnotations()	Retrieve the kubernetes namespace annotations from the collection of platform properties.
Map<String,Object>	getSerializableProperties()	Avoid polluting the serialized context with duplicated keys.

Methods inherited from class org.springframework.cloud.servicebroker.model.Context

canEqual, equals, getMapProperty, getPlatform, getProperties, getProperty, getStringProperty, hashCode, setMapProperty, setProperties, setStringProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

KUBERNETES_PLATFORM

public static final String KUBERNETES_PLATFORM

Kubernetes platform name.

See Also:

• Constant Field Values

NAMESPACE_KEY

public static final String NAMESPACE_KEY

Kubernetes Namespace key.

See Also:

• Constant Field Values

NAMESPACE_ANNOTATIONS_KEY

public static final String NAMESPACE_ANNOTATIONS_KEY

Kubernetes Namespace Annotations key.

See Also:

• Constant Field Values

INSTANCE_ANNOTATIONS_KEY

public static final String INSTANCE_ANNOTATIONS_KEY

Kubernetes Instance Annotations key.

See Also:

• Constant Field Values

INSTANCE_NAME_KEY

public static final String INSTANCE_NAME_KEY

Kubernetes Instance Name.

See Also:

• Constant Field Values

CLUSTERID_KEY

public static final String CLUSTERID_KEY

Kubernetes Cluster ID key.

See Also:

• Constant Field Values

Constructor Details

KubernetesContext

public KubernetesContext(String namespace,
 String clusterid,
 Map<String,Object> properties)

Create a new KubernetesContext.

Parameters:

namespace - the kubernetes namespace

clusterid - the kubernetes clusterid

properties - a collection of properties

KubernetesContext

public KubernetesContext(String namespace,
 String clusterid,
 String instanceName,
 Map<String,Object> namespaceAnnotations,
 Map<String,Object> instanceAnnotations,
 Map<String,Object> properties)

Create a new KubernetesContext.

Parameters:

namespace - the kubernetes namespace

instanceName - the service instance name

namespaceAnnotations - the annotations attached to the namespace in which the Service Instance will be visible

instanceAnnotations - the annotations attached to the service instance

clusterid - the kubernetes clusterid

properties - a collection of properties

Method Details

getSerializableProperties

public Map<String,Object> getSerializableProperties()

Avoid polluting the serialized context with duplicated keys.

Returns:

properties

getNamespace

public String getNamespace()

Retrieve the kubernetes namespace from the collection of platform properties.

Returns:

the namespace

getClusterid

public String getClusterid()

Retrieve the kubernetes clusterid from the collection of platform properties.

Returns:

the clusterid

getInstanceName

public String getInstanceName()

Retrieve the kubernetes instance name from the collection of platform properties.

Returns:

the instance name

getNamespaceAnnotations

public Map<String,Object> getNamespaceAnnotations()

Retrieve the kubernetes namespace annotations from the collection of platform properties.

Returns:

the namespace annotations

getInstanceAnnotations

public Map<String,Object> getInstanceAnnotations()

Retrieve the kubernetes instance annotations from the collection of platform properties.

Returns:

the instance annotations

builder

public static KubernetesContext.KubernetesContextBuilder builder()

Create a builder that provides a fluent API for constructing a KubernetesContext.

Returns:

the builder