com.openshift.restclient

Interface IApiTypeMapper

All Known Implementing Classes:

ApiTypeMapper

public interface IApiTypeMapper

Determine the supported api endpoints by the cluster

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IApiTypeMapper.IApiGroup The api group for a given set of resources and the versions it supports.
static interface	IApiTypeMapper.IVersionedApiResource A description of an endpoint for a given resource and the capabilities it supports
static interface	IApiTypeMapper.IVersionedType

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_GROUPS_API
static char	DOT
static String	FWD_SLASH
static String	KUBE_API
static String	OS_API

Method Summary

Modifier and Type	Method and Description
IApiTypeMapper.IVersionedApiResource	getEndpointFor(String apiVersion, String kind) return the versioned endpoint for the given kind
String	getPreferedVersionFor(String endpoint)
IApiTypeMapper.IVersionedType	getType(String apiVersion, String kind) Get the type information best matching the version and kind arguments
boolean	isSupported(IResource resource) Using the kind and apiVersion, determine if the cluster is able to consume the given resource
boolean	isSupported(String kind) Using the kind determine if the cluster is able to consume the given resource
boolean	isSupported(String version, String kind) Using the kind and apiVersion, determine if the cluster is able to consume the given resource

Field Detail

KUBE_API

static final String KUBE_API

See Also:

Constant Field Values

OS_API

static final String OS_API

See Also:

Constant Field Values

API_GROUPS_API

static final String API_GROUPS_API

See Also:

Constant Field Values

FWD_SLASH

static final String FWD_SLASH

See Also:

Constant Field Values

DOT

static final char DOT

See Also:

Constant Field Values

Method Detail

getPreferedVersionFor

String getPreferedVersionFor(String endpoint)

getEndpointFor

IApiTypeMapper.IVersionedApiResource getEndpointFor(String apiVersion,
                                                    String kind)

return the versioned endpoint for the given kind

Parameters:

version - the apiVersion, null or empty is best guess

Throws:

UnsupportedEndpointException - if unable to determine the endpoint for the given kind

isSupported

boolean isSupported(IResource resource)

Using the kind and apiVersion, determine if the cluster is able to consume the given resource

Returns:

true if supported; false otherwise

isSupported

boolean isSupported(String kind)

Using the kind determine if the cluster is able to consume the given resource

Parameters:

kind - the resource kind

Returns:

true if supported; false otherwise

isSupported

boolean isSupported(String version,
                    String kind)

Using the kind and apiVersion, determine if the cluster is able to consume the given resource

Parameters:

version - the apiVersion, null or empty is best guess

kind - the resource kind

Returns:

true if supported; false otherwise

getType

IApiTypeMapper.IVersionedType getType(String apiVersion,
                                      String kind)

Get the type information best matching the version and kind arguments

Parameters:

apiVersion - the optional version (with or without group)

kind - the type kind

Returns:

the registered type or null