IYarpConfigurationBuilder
Interface
interface IYarpConfigurationBuilder { addCatchAllRoute(cluster: YarpCluster): YarpRoute; addCatchAllRouteFromEndpoint(endpoint: EndpointReference): YarpRoute; addCatchAllRouteFromExternalService(externalService: ExternalServiceResource): YarpRoute; addCatchAllRouteFromResource(resource: IResourceWithServiceDiscovery): YarpRoute; addClusterFromEndpoint(endpoint: EndpointReference): YarpCluster; addClusterFromExternalService(externalService: ExternalServiceResource): YarpCluster; addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpCluster; addClusterWithDestination( clusterName: string, destination: any): YarpCluster; addClusterWithDestinations( clusterName: string, destinations: any[]): YarpCluster; addRoute( path: string, cluster: YarpCluster): YarpRoute; addRouteFromEndpoint( path: string, endpoint: EndpointReference): YarpRoute; addRouteFromExternalService( path: string, externalService: ExternalServiceResource): YarpRoute; addRouteFromResource( path: string, resource: IResourceWithServiceDiscovery): YarpRoute;} 13 members
Methods
method
addCatchAllRoute Adds a YARP catch-all route for an existing cluster.
addCatchAllRoute(cluster: YarpCluster): YarpRouteParameters
cluster YarpCluster Returns
YarpRoute method
addCatchAllRouteFromEndpoint Adds a YARP catch-all route for an endpoint reference.
addCatchAllRouteFromEndpoint(endpoint: EndpointReference): YarpRouteParameters
endpoint EndpointReference Returns
YarpRoute Adds a YARP catch-all route for an external service resource.
addCatchAllRouteFromExternalService(externalService: ExternalServiceResource): YarpRouteParameters
externalService ExternalServiceResource Returns
YarpRoute method
addCatchAllRouteFromResource Adds a YARP catch-all route for a resource that supports service discovery.
addCatchAllRouteFromResource(resource: IResourceWithServiceDiscovery): YarpRouteParameters
resource IResourceWithServiceDiscovery Returns
YarpRoute method
addClusterFromEndpoint Adds a YARP cluster for an endpoint reference.
addClusterFromEndpoint(endpoint: EndpointReference): YarpClusterParameters
endpoint EndpointReference Returns
YarpCluster Adds a YARP cluster for an external service resource.
addClusterFromExternalService(externalService: ExternalServiceResource): YarpClusterParameters
externalService ExternalServiceResource Returns
YarpCluster method
addClusterFromResource Adds a YARP cluster for a resource that supports service discovery.
addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpClusterParameters
resource IResourceWithServiceDiscovery Returns
YarpCluster method
addClusterWithDestination Adds a YARP cluster with a single destination.
addClusterWithDestination( clusterName: string, destination: any): YarpClusterParameters
clusterName string destination any Returns
YarpCluster method
addClusterWithDestinations Adds a YARP cluster with multiple destinations.
addClusterWithDestinations( clusterName: string, destinations: any[]): YarpClusterParameters
clusterName string destinations any[] Returns
YarpCluster method
addRoute Invokes the AddRoute method
addRoute( path: string, cluster: YarpCluster): YarpRouteParameters
path string cluster YarpCluster Returns
YarpRoute method
addRouteFromEndpoint Adds a YARP route for an endpoint reference.
addRouteFromEndpoint( path: string, endpoint: EndpointReference): YarpRouteParameters
path string endpoint EndpointReference Returns
YarpRoute method
addRouteFromExternalService Adds a YARP route for an external service resource.
addRouteFromExternalService( path: string, externalService: ExternalServiceResource): YarpRouteParameters
path string externalService ExternalServiceResource Returns
YarpRoute method
addRouteFromResource Adds a YARP route for a resource that supports service discovery.
addRouteFromResource( path: string, resource: IResourceWithServiceDiscovery): YarpRouteParameters
path string resource IResourceWithServiceDiscovery Returns
YarpRoute