com.openshift.restclient.model

Interface IResource

All Superinterfaces:

Annotatable, IAnnotatable, IApiVersionable, ICapable, IKindable, ITypeMeta, JSONSerializeable

All Known Subinterfaces:

IBuild, IBuildConfig, IBuildRequest, IConfig, IConfigMap, IDeploymentConfig, IEndpoints, IEvent, IImageStream, IImageStreamImport, ILimitRange, IList, IOAuthAccessToken, IOAuthAuthorizeToken, IOAuthClient, IOAuthClientAuthorization, IPersistentVolume, IPersistentVolumeClaim, IPod, IPolicy, IPolicyBinding, IProject, IProjectRequest, IReplicationController, IResourceQuota, IRole, IRoleBinding, IRoute, ISecret, IService, IServiceAccount, IStatus, ITemplate, IUser

All Known Implementing Classes:

Build, BuildConfig, BuildRequest, ConfigMap, DeploymentConfig, Endpoints, ImageStream, ImageStreamImport, KubernetesEvent, KubernetesResource, LimitRange, List, OAuthAccessToken, OAuthAuthorizeToken, OAuthClient, OAuthClientAuthorization, OpenshiftPolicy, OpenshiftProjectRequest, OpenshiftRole, OpenShiftUser, PersistentVolume, PersistentVolumeClaim, Pod, PolicyBinding, Project, ReplicationController, ResourceQuota, RoleBinding, Route, Secret, Service, ServiceAccount, Status, Template

public interface IResource
extends ICapable, Annotatable, IAnnotatable, JSONSerializeable, ITypeMeta

IResource is a representation of a Kubernetes resource (e.g. Service, Pod, ReplicationController)

Author:

Jeff Cantrill

Method Summary

Modifier and Type	Method and Description
void	addLabel(String key, String value) Add or update a label;
String	getAnnotation(String key) Retrieves the annotated value for the given key
Map<String,String>	getAnnotations() Retrieves the annotations associated with the resource
Set<Class<? extends ICapability>>	getCapabilities()
String	getCreationTimeStamp() Returns the timestamp of when this resource was created
Map<String,String>	getLabels() Retrieves the labels associated with the resource
Map<String,String>	getMetadata()
String	getName() Returns the identifier for this resource
String	getNamespace() Returns the scope of this resource
IProject	getProject() Return the project of the resource which corresponds to the namespace
String	getResourceVersion()
boolean	isAnnotatedWith(String key) Returns true if the resource is annotated with the given key
void	removeAnnotation(String key) Removes the resource annotation
void	setAnnotation(String key, String value) Set the resource annotation

Methods inherited from interface com.openshift.restclient.capability.ICapable

accept, getCapability, supports

Methods inherited from interface com.openshift.restclient.api.models.IApiVersionable

getApiVersion

Methods inherited from interface com.openshift.restclient.api.models.IKindable

getKind

Methods inherited from interface com.openshift.restclient.model.JSONSerializeable

toJson, toJson

Method Detail

getMetadata

Map<String,String> getMetadata()

getCapabilities

Set<Class<? extends ICapability>> getCapabilities()

Returns:

the list of capabilities supported by this resource

getCreationTimeStamp

String getCreationTimeStamp()

Returns the timestamp of when this resource was created

Returns:

getName

String getName()

Returns the identifier for this resource

Returns:

getNamespace

String getNamespace()

Returns the scope of this resource

Returns:

getProject

IProject getProject()

Return the project of the resource which corresponds to the namespace

Returns:

getLabels

Map<String,String> getLabels()

Retrieves the labels associated with the resource

Returns:

addLabel

void addLabel(String key,
              String value)

Add or update a label;

Parameters:

key -

value -

isAnnotatedWith

boolean isAnnotatedWith(String key)

Returns true if the resource is annotated with the given key

Specified by:

isAnnotatedWith in interface IAnnotatable

Parameters:

key -

Returns:

true if the annotation key exists

getAnnotation

String getAnnotation(String key)

Retrieves the annotated value for the given key

Specified by:

getAnnotation in interface IAnnotatable

Parameters:

key -

Returns:

setAnnotation

void setAnnotation(String key,
                   String value)

Set the resource annotation

Specified by:

setAnnotation in interface IAnnotatable

Parameters:

key -

value -

removeAnnotation

void removeAnnotation(String key)

Removes the resource annotation

Parameters:

key -

getAnnotations

Map<String,String> getAnnotations()

Retrieves the annotations associated with the resource

Specified by:

getAnnotations in interface IAnnotatable

Returns:

getResourceVersion

String getResourceVersion()