com.openshift.restclient.api.models

Interface IAnnotatable

All Known Subinterfaces:

Annotatable, IBuild, IBuildConfig, IBuildRequest, IConfig, IConfigMap, IDeploymentConfig, IEndpoints, IEvent, IImageStream, IImageStreamImport, ILimitRange, IList, IOAuthAccessToken, IOAuthAuthorizeToken, IOAuthClient, IOAuthClientAuthorization, IObjectMeta, IPersistentVolume, IPersistentVolumeClaim, IPod, IPolicy, IPolicyBinding, IProject, IProjectRequest, IReplicationController, IResource, IResourceQuota, IRole, IRoleBinding, IRoute, IScale, ISecret, IService, IServiceAccount, IStatus, ITagReference, 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, Scale, Secret, Service, ServiceAccount, Status, TagReference, Template

public interface IAnnotatable

A resource that can be annotated

Author:

jeff.cantrill

Method Summary

Modifier and Type	Method and Description
String	getAnnotation(String key) Retrieves the annotated value for the given key
Map<String,String>	getAnnotations() Retrieves the annotations associated with the resource
boolean	isAnnotatedWith(String key) Returns true if the resource is annotated with the given key
void	setAnnotation(String key, String value) Set the resource annotation

Method Detail

isAnnotatedWith

boolean isAnnotatedWith(String key)

Returns true if the resource is annotated with the given key

Parameters:

key -

Returns:

true if the annotation key exists

getAnnotation

String getAnnotation(String key)

Retrieves the annotated value for the given key

Parameters:

key -

Returns:

setAnnotation

void setAnnotation(String key,
                   String value)

Set the resource annotation

Parameters:

key -

value -

getAnnotations

Map<String,String> getAnnotations()

Retrieves the annotations associated with the resource

Returns: