com.openshift.internal.restclient.model

Class Route

java.lang.Object

com.openshift.internal.restclient.model.KubernetesResource

com.openshift.internal.restclient.model.Route

All Implemented Interfaces:

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

public class Route
extends KubernetesResource
implements IRoute

Field Summary

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

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

Constructor Summary

Constructors

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

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

Route

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

Method Detail

getHost

public String getHost()

Description copied from interface: IRoute

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

Specified by:

getHost in interface IRoute

Returns:

Route hostname.

setHost

public void setHost(String host)

Description copied from interface: IRoute

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

Specified by:

setHost in interface IRoute

Parameters:

host - hostname to use

getPath

public String getPath()

Description copied from interface: IRoute

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

Specified by:

getPath in interface IRoute

Returns:

Route path.

setPath

public void setPath(String path)

Description copied from interface: IRoute

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

Specified by:

setPath in interface IRoute

Parameters:

path - route path

getServiceName

public String getServiceName()

Description copied from interface: IRoute

Retrieves the name of the service this route leads to.

Specified by:

getServiceName in interface IRoute

Returns:

Name of the service for this route.

setServiceName

public void setServiceName(String serviceName)

Description copied from interface: IRoute

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

Specified by:

setServiceName in interface IRoute

Parameters:

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

getTLSConfig

public ITLSConfig getTLSConfig()

Description copied from interface: IRoute

Retrieves the TLS configuration of this route.

Specified by:

getTLSConfig in interface IRoute

Returns:

TLS configuration or null if there is not one

createTLSConfig

public ITLSConfig createTLSConfig()

Description copied from interface: IRoute

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

Specified by:

createTLSConfig in interface IRoute

getPort

public ITargetPort getPort()

Description copied from interface: IRoute

Retrieves the target port of this route.

Specified by:

getPort in interface IRoute

Returns:

target port or null if there is not one

createPort

public ITargetPort createPort()

Description copied from interface: IRoute

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

Specified by:

createPort in interface IRoute

getURL

public String getURL()

Description copied from interface: IRoute

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

Specified by:

getURL in interface IRoute

Returns:

java.lang.String The route url