com.openshift.restclient.model.route

Interface IRoute

All Superinterfaces:

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

All Known Implementing Classes:

Route

public interface IRoute
extends IResource

OpenShift route to Service

Method Summary

Modifier and Type	Method and Description
ITargetPort	createPort() Create a target port if one is not defined or return the existing one
ITLSConfig	createTLSConfig() Create a tls config if one is not defined or return the existing one
String	getHost() Retrieves the externally available hostname that can be used to access service.
String	getPath() Retrieves the path that the router watches for, to route traffic for to the service.
ITargetPort	getPort() Retrieves the target port of this route.
String	getServiceName() Retrieves the name of the service this route leads to.
ITLSConfig	getTLSConfig() Retrieves the TLS configuration of this route.
String	getURL() Return a URL representation of this route.
void	setHost(String host) Sets the externally available hostname that can be used to access service.
void	setPath(String path) Sets the path that the router watches for, to route traffic for to the service.
void	setServiceName(String serviceName) Sets the name of the service this route should lead to.

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

getHost

String getHost()

Retrieves the externally available hostname that can be used to access service.

Returns:

Route hostname.

setHost

void setHost(String host)

Sets the externally available hostname that can be used to access service.

Parameters:

host - hostname to use

getPath

String getPath()

Retrieves the path that the router watches for, to route traffic for to the service.

Returns:

Route path.

setPath

void setPath(String path)

Sets the path that the router watches for, to route traffic for to the service.

Parameters:

path - route path

getServiceName

String getServiceName()

Retrieves the name of the service this route leads to.

Returns:

Name of the service for this route.

setServiceName

void setServiceName(String serviceName)

Sets the name of the service this route should lead to.

Parameters:

serviceName - Name of the service this route should lead to.

getTLSConfig

ITLSConfig getTLSConfig()

Retrieves the TLS configuration of this route.

Returns:

TLS configuration or null if there is not one

createTLSConfig

ITLSConfig createTLSConfig()

Create a tls config if one is not defined or return the existing one

getURL

String getURL()

Return a URL representation of this route. Assumes the protocol is https if the route includes TLS Config

Returns:

java.lang.String The route url

getPort

ITargetPort getPort()

Retrieves the target port of this route.

Returns:

target port or null if there is not one

createPort

ITargetPort createPort()

Create a target port if one is not defined or return the existing one