import ProvisionedServiceClient from 'openshift-resource-parser/src/clients/provisioned-service-client.js'

public class | source

ProvisionedServiceClient

Client for retrieving and parsing Provisioned Services.

Static Method Summary

Static Private Methods
private static	_buildClusterServiceClassListRoute(openshiftURL: string): string Build a valid route for retrieving cluster service classes from OpenShift.
private static	_buildServiceInstanceListRoute(openshiftURL: string, namespace: string): string Return a valid route for retrieving service instances from OpenShift.

Constructor Summary

Public Constructor
public	constructor(openshiftURL: string) Construct a ProvisionedServiceClient

Member Summary

Public Members
public	openshiftURL: *

Method Summary

Public Methods
public	getProvisionedService(authToken: string, namespace: string, name: string): * Retrieve a ProvisionedService from a namespace, by name.
public	listProvisionedServices(authToken: string, namespace: string): * Retrieve a list of ProvisionedService from a namespace.

Private Methods
private	_listClusterServiceClasses(openshiftURL: string, authToken: string): Promise<ClusterServiceClass[]> Retrieve a list of ClusterServiceClass in OpenShift.
private	_listServiceInstances(openshiftURL: string, authToken: string, namespace: string): Promise<ServiceInstance[]> Retrieve a list of ServiceInstance from a namespace in OpenShift.

Static Private Methods

private static _buildClusterServiceClassListRoute(openshiftURL: string): string source

Build a valid route for retrieving cluster service classes from OpenShift.

Params:

Name	Type	Attribute	Description
openshiftURL	string		The URL of OpenShift

Return:

string

private static _buildServiceInstanceListRoute(openshiftURL: string, namespace: string): string source

Return a valid route for retrieving service instances from OpenShift.

Params:

Name	Type	Attribute	Description
openshiftURL	string		The URL of OpenShift
namespace	string		The namespace to retrieve the service instances from

Return:

string

Public Constructors

public constructor(openshiftURL: string) source

Construct a ProvisionedServiceClient

Params:

Name	Type	Attribute	Description
openshiftURL	string

Public Members

public openshiftURL: * source

Public Methods

public getProvisionedService(authToken: string, namespace: string, name: string): * source

Retrieve a ProvisionedService from a namespace, by name.

Params:

Name	Type	Attribute	Description
authToken	string		The auth token for a user.
namespace	string		The namespace to find the service in.
name	string		The name of the service to retrieve.

Return:

public listProvisionedServices(authToken: string, namespace: string): * source

Retrieve a list of ProvisionedService from a namespace.

Params:

Name	Type	Attribute	Description
authToken	string
namespace	string

Return:

Private Methods

private _listClusterServiceClasses(openshiftURL: string, authToken: string): Promise<ClusterServiceClass[]> source

Retrieve a list of ClusterServiceClass in OpenShift.

Params:

Name	Type	Attribute	Description
openshiftURL	string		An OpenShift URL.
authToken	string		An auth token for a user.

Return:

Promise<ClusterServiceClass[]>

private _listServiceInstances(openshiftURL: string, authToken: string, namespace: string): Promise<ServiceInstance[]> source

Retrieve a list of ServiceInstance from a namespace in OpenShift.

Params:

Name	Type	Attribute	Description
openshiftURL	string		An OpenShift URL.
authToken	string		An auth token for a user.
namespace	string		The namespace to list the service instances from.

Return:

Promise<ServiceInstance[]>