com.openshift.internal.restclient.model

Class Service

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.Service

All Implemented Interfaces:

ResourcePropertyKeys, IAnnotatable, IApiVersionable, IKindable, ITypeMeta, ICapable, Annotatable, IResource, IService, JSONSerializeable

public class Service
extends KubernetesResource
implements IService

Field Summary

Fields inherited from interface com.openshift.internal.restclient.model.properties.ResourcePropertyKeys

ANNOTATIONS, APIVERSION, CREATION_TIMESTAMP, FROM, KIND, LABELS, METADATA, METADATA_NAME, METADATA_NAMESPACE, METADATA_RESOURCE_VERSION, METADATA_UID, NAME, NAMESPACE, OBJECTS, PORTS, PROTOCOL, RESOURCE_VERSION, TYPE, VALUE

Constructor Summary

Constructors

Constructor and Description
Service(org.jboss.dmr.ModelNode node, IClient client, Map<String,String[]> propertyKeys)

Method Summary

Modifier and Type	Method and Description
IServicePort	addPort(int port, int targetPort)
IServicePort	addPort(int port, int targetPort, String name)
String	getClusterIP() Returns the IP of the service.
List<IPod>	getPods() Retrieves the pods for this service
int	getPort() Returns the first exposed port that is mapped to a running image
String	getPortalIP() Deprecated.
List<IServicePort>	getPorts() Get the collection of ports for the service
Map<String,String>	getSelector() Returns the selector used to find the Pod to which this service is routing
String	getTargetPort() The port this service targets on the pod
String	getType() Returns the type of the service.
void	setPort(int port) Sets the exposed port that is mapped to a running image
void	setPorts(List<IServicePort> ports) Set the collection of ports for the service
void	setSelector(Map<String,String> selector) Sets the container name that the service routes traffic to.
void	setSelector(String key, String value) Convenience method for setting a selector that has a singular key/value pair.
void	setTargetPort(int port) Sets the container port exposed by the image
void	setType(String type) Sets the type of the service.

Methods inherited from class com.openshift.internal.restclient.model.KubernetesResource

accept, addLabel, asBoolean, asBoolean, asInt, asInt, asMap, asSet, asString, asString, equals, get, get, getAnnotation, getAnnotations, getApiVersion, getCapabilities, getCapability, getClient, getCreationTimeStamp, getEnvMap, getKind, getLabels, getMetadata, getModifiableCapabilities, getName, getNamespace, getNamespaceName, getNode, getPath, getProject, getPropertyKeys, getResourceVersion, has, hashCode, isAnnotatedWith, refresh, removeAnnotation, set, set, set, set, set, set, set, set, set, setAnnotation, setEnvMap, setName, setNamespace, setNode, supports, toJson, toJson, toPrettyString, toString

Methods inherited from class java.lang.Object

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

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

addLabel, getAnnotation, getAnnotations, getCapabilities, getCreationTimeStamp, getLabels, getMetadata, getName, getNamespace, getNamespaceName, getProject, getResourceVersion, isAnnotatedWith, removeAnnotation, setAnnotation

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

Constructor Detail

Service

public Service(org.jboss.dmr.ModelNode node,
               IClient client,
               Map<String,String[]> propertyKeys)

Method Detail

setPort

public void setPort(int port)

Description copied from interface: IService

Sets the exposed port that is mapped to a running image

Specified by:

setPort in interface IService

addPort

public IServicePort addPort(int port,
                            int targetPort)

Specified by:

addPort in interface IService

addPort

public IServicePort addPort(int port,
                            int targetPort,
                            String name)

Specified by:

addPort in interface IService

getPort

public int getPort()

Description copied from interface: IService

Returns the first exposed port that is mapped to a running image

Specified by:

getPort in interface IService

getPorts

public List<IServicePort> getPorts()

Description copied from interface: IService

Get the collection of ports for the service

Specified by:

getPorts in interface IService

setPorts

public void setPorts(List<IServicePort> ports)

Description copied from interface: IService

Set the collection of ports for the service

Specified by:

setPorts in interface IService

getSelector

public Map<String,String> getSelector()

Description copied from interface: IService

Returns the selector used to find the Pod to which this service is routing

Specified by:

getSelector in interface IService

setSelector

public void setSelector(Map<String,String> selector)

Description copied from interface: IService

Sets the container name that the service routes traffic to.

Specified by:

setSelector in interface IService

setSelector

public void setSelector(String key,
                        String value)

Description copied from interface: IService

Convenience method for setting a selector that has a singular key/value pair.

Specified by:

setSelector in interface IService

setTargetPort

public void setTargetPort(int port)

Description copied from interface: IService

Sets the container port exposed by the image

Specified by:

setTargetPort in interface IService

getTargetPort

public String getTargetPort()

Description copied from interface: IService

The port this service targets on the pod

Specified by:

getTargetPort in interface IService

getPortalIP

@Deprecated
public String getPortalIP()

Deprecated.

Description copied from interface: IService

Returns the IP of the service.

Specified by:

getPortalIP in interface IService

getClusterIP

public String getClusterIP()

Description copied from interface: IService

Returns the IP of the service.

Specified by:

getClusterIP in interface IService

getPods

public List<IPod> getPods()

Description copied from interface: IService

Retrieves the pods for this service

Specified by:

getPods in interface IService

getType

public String getType()

Description copied from interface: IService

Returns the type of the service.

Specified by:

getType in interface IService

setType

public void setType(String type)

Description copied from interface: IService

Sets the type of the service.

Specified by:

setType in interface IService