com.openshift.restclient.model

Interface IService

All Superinterfaces:

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

All Known Implementing Classes:

Service

public interface IService
extends IResource

Kubernetes Service to access a Pod

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 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

Method Detail

setTargetPort

void setTargetPort(int port)

Sets the container port exposed by the image

setPort

void setPort(int port)

Sets the exposed port that is mapped to a running image

getPort

int getPort()

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

addPort

IServicePort addPort(int port,
                     int targetPort)

addPort

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

setSelector

void setSelector(Map<String,String> selector)

Sets the container name that the service routes traffic to.

setSelector

void setSelector(String key,
                 String value)

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

getSelector

Map<String,String> getSelector()

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

getTargetPort

String getTargetPort()

The port this service targets on the pod

getPortalIP

@Deprecated
String getPortalIP()

Deprecated.

Returns the IP of the service.

getClusterIP

String getClusterIP()

Returns the IP of the service.

getPods

List<IPod> getPods()

Retrieves the pods for this service

getPorts

List<IServicePort> getPorts()

Get the collection of ports for the service

setPorts

void setPorts(List<IServicePort> ports)

Set the collection of ports for the service

getType

String getType()

Returns the type of the service.

setType

void setType(String type)

Sets the type of the service.