com.sap.cloud.sdk.services.scp.machinelearning

Class LeonardoMlService

java.lang.Object

com.sap.cloud.sdk.services.scp.machinelearning.LeonardoMlService

@Beta
public class LeonardoMlService
extends Object

A generic service accessor for Leonardo ML Services. Create with the methods of LeonardoMlFoundation.

Be aware that this class is in Beta (as indicated by the annotation) and therefore subject to breaking changes.

Constructor Summary

Constructors

Constructor and Description
LeonardoMlService(ScpCfService mlService) Create an instance with the ML service information provided.

Method Summary

Modifier and Type	Method and Description
protected URI	combineServiceUriWithRequestPath(URI originalRequestUriOrNull) Combines the service URI with the original request path, query, and fragment.
static LeonardoMlService	create(String cfServiceType, String serviceUrlKey) Generic creation of a service instance.
<R> R	invoke(org.apache.http.client.methods.HttpRequestBase request, Function<org.apache.http.HttpResponse,R> resultProcessor) Invokes the given request against the service and returns results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LeonardoMlService

public LeonardoMlService(@Nonnull
                         ScpCfService mlService)

Create an instance with the ML service information provided.

Parameters:

mlService - service information - ideally provided from LeonardoMlFoundation's methods.

Throws:

IllegalArgumentException - if there is no service location info available in given service or if it is not a URI.

See Also:

create(String, String)

Method Detail

create

@Nonnull
public static LeonardoMlService create(@Nonnull
                                                String cfServiceType,
                                                @Nonnull
                                                String serviceUrlKey)
                                         throws CloudPlatformException

Generic creation of a service instance.

Parameters:

cfServiceType - the Cloud Foundry service type to look for in the environment

serviceUrlKey - the name of the URL entry for the specific service in the credentials section of the Cloud Foundry service information.

Returns:

the new instance

Throws:

CloudPlatformException - if the service cannot be found or required information is missing

invoke

@Nullable
public <R> R invoke(@Nonnull
                              org.apache.http.client.methods.HttpRequestBase request,
                              @Nonnull
                              Function<org.apache.http.HttpResponse,R> resultProcessor)
                       throws MlServiceFailureException,
                              CloudPlatformException

Invokes the given request against the service and returns results.

Type Parameters:

R - result type

Parameters:

request - the request prepared with request entity. Only path, query and fragment of the target URI will be considered. Host and port will be set according to the URL of the machine learning service, and the target path of the given request will be appended to the path of the service URL.

resultProcessor - will be invoked with the request response for reading and returning the result. An exception thrown by the processor will be passed through.

Returns:

the result from the resultProcessor

Throws:

MlServiceFailureException - if the service invocation fails

CloudPlatformException - if there is a problem authorizing the access

combineServiceUriWithRequestPath

@Nonnull
protected URI combineServiceUriWithRequestPath(@Nullable
                                                        URI originalRequestUriOrNull)

Combines the service URI with the original request path, query, and fragment.

Parameters:

originalRequestUriOrNull - The request URI to combine with the service URI. Only path, query and fragment of the target URI will be considered. Host and port will be set according to the URL of the machine learning service, and the target path of the given request will be appended to the path of the service URL.

Returns:

The combined request URI with scheme, user info, host, and port taken from the service URI, combined path, and query and fragment from original URI.